インターフェース RedisHashCommands

メソッドの詳細

• hSet

  @Nullable BooleanSE hSet(byte[] key, byte[] field, byte[] value)

  ハッシュ field の value を設定します。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  value - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HSET

• hSetNX

  @Nullable BooleanSE hSetNX(byte[] key, byte[] field, byte[] value)

  ハッシュ field の value は、field が存在しない場合にのみ設定してください。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  value - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HSETNX

• hGet

  @Nullable byte[] hGet(byte[] key, byte[] field)

  key のハッシュから指定された field の値を取得します。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  戻り値:

  キーまたはフィールドが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HGET

• hMGet

  @Nullable ListSE<byte[]> hMGet(byte[] key, byte[]... fields)

  key のハッシュから指定された fields の値を取得します。値はリクエストされたキーの順序になります。存在しないフィールド値は、結果の ListSE では null を使用して表されます。

  パラメーター:

  key - null であってはなりません。

  fields - 空であってはなりません。

  戻り値:

  キーが存在しない場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HMGET

• hMSet

  void hMSet(byte[] key, MapSE<byte[],byte[]> hashes)

  hashes で提供されるデータを使用して、複数のハッシュフィールドを複数の値に設定します

  パラメーター:

  key - null であってはなりません。

  hashes - null であってはなりません。

  関連事項:

  • Redis ドキュメント: HMSET

• hIncrBy

  @Nullable LongSE hIncrBy(byte[] key, byte[] field, long delta)

  指定された delta によってハッシュ field の value をインクリメントします。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  delta -

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HINCRBY

• hIncrBy

  @Nullable DoubleSE hIncrBy(byte[] key, byte[] field, double delta)

  指定された delta によってハッシュ field の value をインクリメントします。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  delta -

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HINCRBYFLOAT

• hExists

  @Nullable BooleanSE hExists(byte[] key, byte[] field)

  指定されたハッシュ field が存在するかどうかを判別します。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HEXISTS

• hDel

  @Nullable LongSE hDel(byte[] key, byte[]... fields)

  指定されたハッシュ fields を削除します。

  パラメーター:

  key - null であってはなりません。

  fields - 空であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HDEL

• hLen

  @Nullable LongSE hLen(byte[] key)

  key でハッシュのサイズを取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HLEN

• hKeys

  @Nullable SetSE<byte[]> hKeys(byte[] key)

  key でハッシュのキーセット（フィールド）を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HKEYS ?

• hVals

  @Nullable ListSE<byte[]> hVals(byte[] key)

  field でハッシュのエントリセット（値）を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HVALS

• hGetAll

  @Nullable MapSE<byte[],byte[]> hGetAll(byte[] key)

  key に保存されているハッシュ全体を取得します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合は空の MapSE、パイプライン / トランザクションで使用される場合は null。

  関連事項:

  • Redis ドキュメント: HGETALL

• hRandField

  @Nullable byte[] hRandField(byte[] key)

  key に格納されているハッシュからランダムフィールドを返します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  導入:

  2.6

  関連事項:

  • Redis ドキュメント: HRANDFIELD

• hRandFieldWithValues

  @Nullable Map.EntrySE<byte[],byte[]> hRandFieldWithValues(byte[] key)

  key に格納されている値とともに、ハッシュからランダムフィールドを返します。

  パラメーター:

  key - null であってはなりません。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  導入:

  2.6

  関連事項:

  • Redis ドキュメント: HRANDFIELD

• hRandField

  @Nullable ListSE<byte[]> hRandField(byte[] key, long count)

  key に格納されているハッシュからランダムフィールドを返します。指定された count 引数が正の場合、count またはハッシュサイズのいずれかで制限された個別のフィールドのリストを返します。count が負の場合、動作が変更され、コマンドは同じフィールドを複数回返すことができます。この場合、返されるフィールドの数は、指定されたカウントの絶対値です。

  パラメーター:

  key - null であってはなりません。

  count - 返すフィールドの数。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  導入:

  2.6

  関連事項:

  • Redis ドキュメント: HRANDFIELD

• hRandFieldWithValues

  @Nullable ListSE<Map.EntrySE<byte[],byte[]>> hRandFieldWithValues(byte[] key, long count)

  key に格納されている値とともに、ハッシュからランダムフィールドを返します。指定された count 引数が正の場合、count またはハッシュサイズのいずれかで制限された個別のフィールドのリストを返します。count が負の場合、動作が変更され、コマンドは同じフィールドを複数回返すことができます。この場合、返されるフィールドの数は、指定されたカウントの絶対値です。

  パラメーター:

  key - null であってはなりません。

  count - 返すフィールドの数。

  戻り値:

  キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。

  導入:

  2.6

  関連事項:

  • Redis ドキュメント: HRANDFIELD

• hScan

  Cursor<Map.EntrySE<byte[],byte[]>> hScan(byte[] key, ScanOptions options)

  Cursor を使用して、key でハッシュ内のエントリを反復処理します。

  パラメーター:

  key - null であってはなりません。

  options - null であってはなりません。

  戻り値:

  導入:

  1.4

  関連事項:

  • Redis ドキュメント: HSCAN

• hStrLen

  @Nullable LongSE hStrLen(byte[] key, byte[] field)

  key に格納されているハッシュ内の field に関連付けられた値の長さを返します。key または field が存在しない場合は、0 が返されます。

  パラメーター:

  key - null であってはなりません。

  field - null であってはなりません。

  戻り値:

  パイプライン / トランザクションで使用される場合は null。

  導入:

  2.1

  関連事項:

  • Redis ドキュメント: HSTRLEN

• applyHashFieldExpiration

  @Nullable default ListSE<LongSE> applyHashFieldExpiration(byte[] key, Expiration expiration, byte[]... fields)

  指定された Expiration を指定されたフィールドに適用します。

  パラメーター:

  key - null であってはなりません。

  expiration - 適用する Expiration

  fields - 有効期限を適用するフィールドの名前。

  戻り値:

  各フィールドのコマンド結果を順に保持する ListSE - 2 は、特定のフィールドが有効期限によりすでに削除されているか、有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 は、そのようなフィールドが存在しないことを示します。

  導入:

  3.5

• applyHashFieldExpiration

  @Nullable default ListSE<LongSE> applyHashFieldExpiration(byte[] key, Expiration expiration, ExpirationOptions options, byte[]... fields)

  パラメーター:

  key - null であってはなりません。

  expiration - 適用する Expiration

  options - コマンドとともに送信される追加オプション。

  fields - 有効期限を適用するフィールドの名前。

  戻り値:

  各フィールドのコマンド結果を順に保持する ListSE - 2 は、特定のフィールドが有効期限によりすでに削除されているか、有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します (提供された NX | XX | GT | LT 条件が満たされていない)。-2 はそのようなフィールドが存在しないことを示します。

  導入:

  3.5

• hExpire

  @Nullable default ListSE<LongSE> hExpire(byte[] key, long seconds, byte[]... fields)

  指定された fields の存続時間を秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  seconds - フィールドが期限切れになるまでの時間（秒数）は null にできません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、指定された有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HEXPIRE

• hExpire

  @Nullable default ListSE<LongSE> hExpire(byte[] key, DurationSE ttl, byte[]... fields)

  指定された fields の存続時間を設定します。

  パラメーター:

  key - null であってはなりません。

  ttl - フィールドが seconds 精度で期限切れになるまでの時間。null にはできません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、指定された有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HEXPIRE

• hExpire

  @Nullable ListSE<LongSE> hExpire(byte[] key, long seconds, ExpirationOptions.Condition condition, byte[]... fields)

  指定された fields の存続時間を秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  seconds - フィールドが期限切れになるまでの時間（秒数）は null にできません。

  fields - null であってはなりません。

  condition - 有効期限の条件は null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が 0 であることを示します。1 は、有効期限が設定 / 更新されていることを示します。0 は、有効期限が設定されていない (提供された NX | XX | GT | LT 条件が満たされていない) ことを示します。-2 は、そのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HEXPIRE

• hpExpire

  @Nullable default ListSE<LongSE> hpExpire(byte[] key, long millis, byte[]... fields)

  特定の fields の存続時間をミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  millis - フィールドが期限切れになるまでの時間（ミリ秒単位）は null にできません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、指定された有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPEXPIRE

• hpExpire

  @Nullable default ListSE<LongSE> hpExpire(byte[] key, DurationSE ttl, byte[]... fields)

  特定の fields の存続時間をミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  ttl - フィールドが milliseconds 精度で期限切れになるまでの時間。null にはできません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、指定された有効期限間隔が 0 であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPEXPIRE

• hpExpire

  @Nullable ListSE<LongSE> hpExpire(byte[] key, long millis, ExpirationOptions.Condition condition, byte[]... fields)

  特定の fields の存続時間をミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  millis - フィールドが期限切れになるまでの時間（ミリ秒単位）は null にできません。

  condition - 有効期限の条件は null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が 0 であることを示します。1 は、有効期限が設定 / 更新されていることを示します。0 は、有効期限が設定されていない (提供された NX | XX | GT | LT 条件が満たされていない) ことを示します。-2 は、そのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPEXPIRE

• hExpireAt

  @Nullable default ListSE<LongSE> hExpireAt(byte[] key, long unixTime, byte[]... fields)

  指定された field の有効期限を UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime - フィールドの有効期限が切れる時点は null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が過去であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HEXPIREAT

• hExpireAt

  @Nullable ListSE<LongSE> hExpireAt(byte[] key, long unixTime, ExpirationOptions.Condition condition, byte[]... fields)

  指定された field の有効期限を UNIX タイムスタンプとして設定します。

  パラメーター:

  key - null であってはなりません。

  unixTime - フィールドの有効期限が切れる時点は null であってはなりません。

  condition - 有効期限の条件は null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が過去であることを示します。1 は、有効期限が設定 / 更新されていることを示します。0 は、有効期限が設定されていない (提供された NX | XX | GT | LT 条件が満たされていない) ことを示します。-2 は、そのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HEXPIREAT

• hpExpireAt

  @Nullable default ListSE<LongSE> hpExpireAt(byte[] key, long unixTimeInMillis, byte[]... fields)

  指定された field の有効期限を UNIX タイムスタンプとしてミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  unixTimeInMillis - フィールドの有効期限がミリ秒単位で切れる時刻。null にすることはできません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が過去であることを示します。1 は有効期限が設定 / 更新されていることを示します。0 は有効期限が設定されていないことを示します。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPEXPIREAT

• hpExpireAt

  @Nullable ListSE<LongSE> hpExpireAt(byte[] key, long unixTimeInMillis, ExpirationOptions.Condition condition, byte[]... fields)

  指定された field の有効期限を UNIX タイムスタンプとしてミリ秒単位で設定します。

  パラメーター:

  key - null であってはなりません。

  unixTimeInMillis - フィールドの有効期限がミリ秒単位で切れる時刻。null にすることはできません。

  condition - 有効期限の条件は null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  提供された各フィールドの LongSE 値のリスト: 2 は、特定のフィールドが有効期限によりすでに削除されているか、提供された有効期限間隔が過去であることを示します。1 は、有効期限が設定 / 更新されていることを示します。0 は、有効期限が設定されていない (提供された NX | XX | GT | LT 条件が満たされていない) ことを示します。-2 は、そのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPEXPIREAT

• hPersist

  @Nullable ListSE<LongSE> hPersist(byte[] key, byte[]... fields)

  指定された field から有効期限を削除します。

  パラメーター:

  key - null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  提供される各フィールドの LongSE 値のリスト: 1 は有効期限が削除されたことを示します。-1 フィールドには削除する有効期限がありません。-2 はそのようなフィールドが存在しないことを示します。パイプライン / トランザクションで使用される場合は null。パイプライン / トランザクションで使用される場合は null。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HPERSIST

• hTtl

  @Nullable ListSE<LongSE> hTtl(byte[] key, byte[]... fields)

  fields の存続時間を数秒で取得します。

  パラメーター:

  key - null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  指定された各フィールドの LongSE 値のリスト（秒単位の有効時間、またはエラーを示す負の値）。フィールドが存在するものの有効期限が関連付けられていない場合、コマンドは -1 を返します。フィールドが存在しない場合は -2 を返します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HTTL

• hTtl

  @Nullable ListSE<LongSE> hTtl(byte[] key, TimeUnitSE timeUnit, byte[]... fields)

  fields の存続時間を取得し、指定された TimeUnitSE に変換します。

  パラメーター:

  key - null であってはなりません。

  timeUnit - null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  指定された各フィールドについて、指定された TimeUnitSE における有効期間、またはエラーを通知する負の値を返します。キーは存在するが有効期限が関連付けられていない場合、コマンドは -1 を返します。キーが存在しない場合は -2 を返します。パイプライン / トランザクションで使用される場合は null です。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HTTL

• hpTtl

  @Nullable ListSE<LongSE> hpTtl(byte[] key, byte[]... fields)

  fields の存続時間をミリ秒単位で取得します。

  パラメーター:

  key - null であってはなりません。

  fields - null であってはなりません。

  戻り値:

  各フィールドに LongSE 値のリスト（秒単位の有効時間、またはエラーを示す負の値）を指定します。キーは存在するが有効期限が関連付けられていない場合、このコマンドは -1 を返します。キーが存在しない場合は -2 を返します。パイプライン / トランザクションで使用されている場合は null を返します。

  導入:

  3.5

  関連事項:

  • Redis ドキュメント: HTTL