パッケージ org.springframework.data.redis.connection

インターフェース RedisHashCommands

すべての既知のサブインターフェース:
DefaultedRedisClusterConnection、DefaultedRedisConnection、RedisClusterConnection、RedisCommands、RedisConnection、RedisConnectionUtils.RedisConnectionProxy、StringRedisConnection
すべての既知の実装クラス:
AbstractRedisConnection、DefaultStringRedisConnection、JedisClusterConnection、JedisConnection、LettuceClusterConnection、LettuceConnection
public interface RedisHashCommands
Redis でサポートされているハッシュ固有のコマンド。
作成者:
Costin Leau, Christoph Strobl, Mark Paluch

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    LongSE
    hDel(byte[] key, byte[]... fields)
    指定されたハッシュ fields を削除します。
    BooleanSE
    hExists(byte[] key, byte[] field)
    指定されたハッシュ field が存在するかどうかを判別します。
    byte[]
    hGet(byte[] key, byte[] field)
    key のハッシュから指定された field の値を取得します。
    MapSE<byte[],byte[]>
    hGetAll(byte[] key)
    key に保存されているハッシュ全体を取得します。
    DoubleSE
    hIncrBy(byte[] key, byte[] field, double delta)
    指定された delta によってハッシュ field の value をインクリメントします。
    LongSE
    hIncrBy(byte[] key, byte[] field, long delta)
    指定された delta によってハッシュ field の value をインクリメントします。
    SetSE<byte[]>
    hKeys(byte[] key)
    key でハッシュのキーセット（フィールド）を取得します。
    LongSE
    hLen(byte[] key)
    key でハッシュのサイズを取得します。
    ListSE<byte[]>
    hMGet(byte[] key, byte[]... fields)
    key のハッシュから指定された fields の値を取得します。
    void
    hMSet(byte[] key, MapSE<byte[],byte[]> hashes)
    hashes で提供されるデータを使用して、複数のハッシュフィールドを複数の値に設定します
    byte[]
    hRandField(byte[] key)
    key に格納されているハッシュからランダムフィールドを返します。
    ListSE<byte[]>
    hRandField(byte[] key, long count)
    key に格納されているハッシュからランダムフィールドを返します。
    Map.EntrySE<byte[],byte[]>
    hRandFieldWithValues(byte[] key)
    key に格納されている値とともに、ハッシュからランダムフィールドを返します。
    ListSE<Map.EntrySE<byte[],byte[]>>
    hRandFieldWithValues(byte[] key, long count)
    key に格納されている値とともに、ハッシュからランダムフィールドを返します。
    Cursor<Map.EntrySE<byte[],byte[]>>
    hScan(byte[] key, ScanOptions options)
    Cursor を使用して、key でハッシュ内のエントリを反復処理します。
    BooleanSE
    hSet(byte[] key, byte[] field, byte[] value)
    ハッシュ field の value を設定します。
    BooleanSE
    hSetNX(byte[] key, byte[] field, byte[] value)
    ハッシュ field の value は、field が存在しない場合にのみ設定してください。
    LongSE
    hStrLen(byte[] key, byte[] field)
    key に格納されているハッシュ内の field に関連付けられた値の長さを返します。
    ListSE<byte[]>
    hVals(byte[] key)
    field でハッシュのエントリセット（値）を取得します。

  • メソッドの詳細

    • hSet

      @Nullable BooleanSE hSet(byte[] key, byte[] field, byte[] value)
      ハッシュ field の value を設定します。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      value - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hSetNX

      @Nullable BooleanSE hSetNX(byte[] key, byte[] field, byte[] value)
      ハッシュ field の value は、field が存在しない場合にのみ設定してください。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      value - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hGet

      @Nullable byte[] hGet(byte[] key, byte[] field)
      key のハッシュから指定された field の値を取得します。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      戻り値:
      キーまたはフィールドが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hMGet

      @Nullable ListSE<byte[]> hMGet(byte[] key, byte[]... fields)
      key のハッシュから指定された fields の値を取得します。値はリクエストされたキーの順序になっています。不在フィールド値は、結果の ListSE で null を使用して表されます。
      パラメーター:
      key - null であってはなりません。
      fields - 空であってはなりません。
      戻り値:
      キーが存在しない場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hMSet

      void hMSet(byte[] key, MapSE<byte[],byte[]> hashes)
      hashes で提供されるデータを使用して、複数のハッシュフィールドを複数の値に設定します
      パラメーター:
      key - null であってはなりません。
      hashes - null であってはなりません。
      関連事項:

    • hIncrBy

      @Nullable LongSE hIncrBy(byte[] key, byte[] field, long delta)
      指定された delta によってハッシュ field の value をインクリメントします。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      delta -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hIncrBy

      @Nullable DoubleSE hIncrBy(byte[] key, byte[] field, double delta)
      指定された delta によってハッシュ field の value をインクリメントします。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      delta -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hExists

      @Nullable BooleanSE hExists(byte[] key, byte[] field)
      指定されたハッシュ field が存在するかどうかを判別します。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hDel

      @Nullable LongSE hDel(byte[] key, byte[]... fields)
      指定されたハッシュ fields を削除します。
      パラメーター:
      key - null であってはなりません。
      fields - 空であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hLen

      @Nullable LongSE hLen(byte[] key)
      key でハッシュのサイズを取得します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hKeys

      @Nullable SetSE<byte[]> hKeys(byte[] key)
      key でハッシュのキーセット（フィールド）を取得します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hVals

      @Nullable ListSE<byte[]> hVals(byte[] key)
      field でハッシュのエントリセット（値）を取得します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しない場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hGetAll

      @Nullable MapSE<byte[],byte[]> hGetAll(byte[] key)
      key に保存されているハッシュ全体を取得します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しない場合は空の MapSE、パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • hRandField

      @Nullable byte[] hRandField(byte[] key)
      key に格納されているハッシュからランダムフィールドを返します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:

    • hRandFieldWithValues

      @Nullable Map.EntrySE<byte[],byte[]> hRandFieldWithValues(byte[] key)
      key に格納されている値とともに、ハッシュからランダムフィールドを返します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:

    • hRandField

      @Nullable ListSE<byte[]> hRandField(byte[] key, long count)
      key に格納されているハッシュからランダムフィールドを返します。指定された count 引数が正の場合、count またはハッシュサイズのいずれかで制限された個別のフィールドのリストを返します。count が負の場合、動作が変更され、コマンドは同じフィールドを複数回返すことができます。この場合、返されるフィールドの数は、指定されたカウントの絶対値です。
      パラメーター:
      key - null であってはなりません。
      count - 返すフィールドの数。
      戻り値:
      キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:

    • hRandFieldWithValues

      @Nullable ListSE<Map.EntrySE<byte[],byte[]>> hRandFieldWithValues(byte[] key, long count)
      key に格納されている値とともに、ハッシュからランダムフィールドを返します。指定された count 引数が正の場合、count またはハッシュサイズのいずれかで制限された個別のフィールドのリストを返します。count が負の場合、動作が変更され、コマンドは同じフィールドを複数回返すことができます。この場合、返されるフィールドの数は、指定されたカウントの絶対値です。
      パラメーター:
      key - null であってはなりません。
      count - 返すフィールドの数。
      戻り値:
      キーが存在しない場合、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:

    • hScan

      Cursor<Map.EntrySE<byte[],byte[]>> hScan(byte[] key, ScanOptions options)
      Cursor を使用して、key でハッシュ内のエントリを反復処理します。
      パラメーター:
      key - null であってはなりません。
      options - null であってはなりません。
      戻り値:
      導入:
      1.4
      関連事項:

    • hStrLen

      @Nullable LongSE hStrLen(byte[] key, byte[] field)
      key に格納されているハッシュ内の field に関連付けられた値の長さを返します。key または field が存在しない場合は、0 が返されます。
      パラメーター:
      key - null であってはなりません。
      field - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.1
      関連事項: