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

インターフェース RedisStringCommands

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

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static enum
    RedisStringCommands.BitOperation
    static enum
    RedisStringCommands.SetOption
     NX、XX の SET コマンド引数。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    LongSE
    append(byte[] key, byte[] value)
    value を key に追加します。
    LongSE
    bitCount(byte[] key)
    key に格納されている値のセットビット数（ポピュレーションカウント）をカウントします。
    LongSE
    bitCount(byte[] key, long start, long end)
    start と end の間の key に格納されている値のセットビット数（母集団カウント）をカウントします。
    ListSE<LongSE>
    bitField(byte[] key, BitFieldSubCommands subCommands)
    さまざまなビット幅の特定の整数フィールドと、特定の key に格納されている任意の非（必要な）整列オフセットを取得 / 操作します。
    LongSE
    bitOp(RedisStringCommands.BitOperation op, byte[] destination, byte[]... keys)
    文字列間でビット演算を実行します。
    default LongSE
    bitPos(byte[] key, boolean bit)
    文字列内の指定された bit に設定された最初のビットの位置を返します。
    LongSE
    bitPos(byte[] key, boolean bit, Range<LongSE> range)
    文字列内の指定された bit に設定された最初のビットの位置を返します。
    LongSE
    decr(byte[] key)
    key の文字列値として格納されている整数値を 1 デクリメントします。
    LongSE
    decrBy(byte[] key, long value)
    key の文字列値として格納されている整数値を value でデクリメントします。
    byte[]
    get(byte[] key)
    key の値を取得します。
    BooleanSE
    getBit(byte[] key, long offset)
    key の値の offset のビット値を取得します。
    byte[]
    getDel(byte[] key)
    key の値を返し、キーを削除します。
    byte[]
    getEx(byte[] key, Expiration expiration)
    key で値を返し、Expiration を適用してキーを期限切れにします。
    byte[]
    getRange(byte[] key, long start, long end)
    start と end の間の key の値の部分文字列を取得します。
    byte[]
    getSet(byte[] key, byte[] value)
    key の value を設定し、古い値を返します。
    LongSE
    incr(byte[] key)
    key の文字列値として格納されている整数値を 1 つインクリメントします。
    DoubleSE
    incrBy(byte[] key, double value)
    key の浮動小数点数の値を delta だけインクリメントします。
    LongSE
    incrBy(byte[] key, long value)
    key に格納されている整数値を delta でインクリメントします。
    ListSE<byte[]>
    mGet(byte[]... keys)
    複数の keys を取得します。
    BooleanSE
    mSet(MapSE<byte[],byte[]> tuple)
    tuple で提供されるキーと値のペアを使用して、複数のキーを複数の値に設定します。
    BooleanSE
    mSetNX(MapSE<byte[],byte[]> tuple)
    提供されたキーが存在しない場合にのみ、tuple で提供されるキーと値のペアを使用して、複数のキーを複数の値に設定します。
    BooleanSE
    pSetEx(byte[] key, long milliseconds, byte[] value)
    key の value と有効期限を milliseconds に設定します。
    BooleanSE
    set(byte[] key, byte[] value)
    key に value を設定します。
    BooleanSE
    set(byte[] key, byte[] value, Expiration expiration, RedisStringCommands.SetOption option)
    key の value を設定し、設定されている場合は expiration からのタイムアウトを適用し、option に応じて値を挿入 / 更新します。
    BooleanSE
    setBit(byte[] key, long offset, boolean value)
    key に格納されている値の offset のビットを設定します。
    BooleanSE
    setEx(byte[] key, long seconds, byte[] value)
    key の value と有効期限を seconds に設定します。
    byte[]
    setGet(byte[] key, byte[] value, Expiration expiration, RedisStringCommands.SetOption option)
    key に value を設定します。
    BooleanSE
    setNX(byte[] key, byte[] value)
    key が存在しない場合にのみ、key に value を設定します。
    void
    setRange(byte[] key, byte[] value, long offset)
    指定された offset から始まる key の一部を、指定された value で上書きします。
    LongSE
    strLen(byte[] key)
    key に格納されている値の長さを取得します。

  • メソッドの詳細

    • get

      @Nullable byte[] get(byte[] key)
      key の値を取得します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
      関連事項:

    • getDel

      @Nullable byte[] getDel(byte[] key)
      key の値を返し、キーを削除します。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
      導入:
      2.6
      関連事項:

    • getEx

      @Nullable byte[] getEx(byte[] key, Expiration expiration)
      key で値を返し、Expiration を適用してキーを期限切れにします。

      EX には Expiration.seconds(long) を使用します。
       PX には Expiration.milliseconds(long) を使用します。
       EXAT | PXAT には Expiration.unixTimestamp(long, TimeUnit) を使用します。

      パラメーター:
      key - null であってはなりません。
      expiration - null であってはなりません。
      戻り値:
      キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
      導入:
      2.6
      関連事項:

    • getSet

      @Nullable byte[] getSet(byte[] key, byte[] value)
      key の value を設定し、古い値を返します。
      パラメーター:
      key - null であってはなりません。
      value - null であってはなりません。
      戻り値:
      キーがパイプライン / トランザクションで使用される前または使用されたときに存在しなかった場合は null。
      関連事項:

    • mGet

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

    • set

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

    • set

      @Nullable BooleanSE set(byte[] key, byte[] value, Expiration expiration, RedisStringCommands.SetOption option)
      key の value を設定し、設定されている場合は expiration からのタイムアウトを適用し、option に応じて値を挿入 / 更新します。
      パラメーター:
      key - null であってはなりません。
      value - null であってはなりません。
      expiration - null であってはなりません。Expiration.persistent() を使用して、ttl または Expiration.keepTtl() を設定しないで、既存の有効期限を維持します。
      option - null であってはなりません。RedisStringCommands.SetOption.upsert() を使用して、存在しないものを追加します。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      1.7
      関連事項:

    • setGet

      @Nullable byte[] setGet(byte[] key, byte[] value, Expiration expiration, RedisStringCommands.SetOption option)
      key に value を設定します。キーに格納されている古い文字列を返します。キーが存在しない場合は null を返します。キーに格納されている値が文字列でない場合はエラーが返され、SET は中止されます。
      パラメーター:
      key - null であってはなりません。
      value - null であってはなりません。
      expiration - null であってはなりません。Expiration.persistent() を使用して、ttl または Expiration.keepTtl() を設定しないで、既存の有効期限を維持します。
      option - null にすることはできません。存在しないものを追加するには、RedisStringCommands.SetOption.upsert() を使用してください。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      3.5
      関連事項:

    • setNX

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

    • setEx

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

    • pSetEx

      @Nullable BooleanSE pSetEx(byte[] key, long milliseconds, byte[] value)
      key の value と有効期限を milliseconds に設定します。
      パラメーター:
      key - null であってはなりません。
      milliseconds -
      value - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      1.3
      関連事項:

    • mSet

      @Nullable BooleanSE mSet(MapSE<byte[],byte[]> tuple)
      tuple で提供されるキーと値のペアを使用して、複数のキーを複数の値に設定します。
      パラメーター:
      tuple - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • mSetNX

      @Nullable BooleanSE mSetNX(MapSE<byte[],byte[]> tuple)
      提供されたキーが存在しない場合にのみ、tuple で提供されるキーと値のペアを使用して、複数のキーを複数の値に設定します。
      パラメーター:
      tuple - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • incr

      @Nullable LongSE incr(byte[] key)
      key の文字列値として格納されている整数値を 1 つインクリメントします。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • incrBy

      @Nullable LongSE incrBy(byte[] key, long value)
      key に格納されている整数値を delta でインクリメントします。
      パラメーター:
      key - null であってはなりません。
      value -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • incrBy

      @Nullable DoubleSE incrBy(byte[] key, double value)
      key の浮動小数点数の値を delta だけインクリメントします。
      パラメーター:
      key - null であってはなりません。
      value -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • decr

      @Nullable LongSE decr(byte[] key)
      key の文字列値として格納されている整数値を 1 デクリメントします。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • decrBy

      @Nullable LongSE decrBy(byte[] key, long value)
      key の文字列値として格納されている整数値を value でデクリメントします。
      パラメーター:
      key - null であってはなりません。
      value -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • append

      @Nullable LongSE append(byte[] key, byte[] value)
      value を key に追加します。
      パラメーター:
      key - null であってはなりません。
      value - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • getRange

      @Nullable byte[] getRange(byte[] key, long start, long end)
      start と end の間の key の値の部分文字列を取得します。
      パラメーター:
      key - null であってはなりません。
      start -
      end -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • setRange

      void setRange(byte[] key, byte[] value, long offset)
      指定された offset から始まる key の一部を、指定された value で上書きします。
      パラメーター:
      key - null であってはなりません。
      value -
      offset -
      関連事項:

    • getBit

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

    • setBit

      @Nullable BooleanSE setBit(byte[] key, long offset, boolean value)
      key に格納されている値の offset のビットを設定します。
      パラメーター:
      key - null であってはなりません。
      offset -
      value -
      戻り値:
      offset に格納されている元のビット値、またはパイプライン / トランザクションで使用される場合は null。
      関連事項:

    • bitCount

      @Nullable LongSE bitCount(byte[] key)
      key に格納されている値のセットビット数（ポピュレーションカウント）をカウントします。
      パラメーター:
      key - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • bitCount

      @Nullable LongSE bitCount(byte[] key, long start, long end)
      start と end の間の key に格納されている値のセットビット数（母集団カウント）をカウントします。
      パラメーター:
      key - null であってはなりません。
      start -
      end -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • bitField

      @Nullable ListSE<LongSE> bitField(byte[] key, BitFieldSubCommands subCommands)
      さまざまなビット幅の特定の整数フィールドと、特定の key に格納されている任意の非（必要な）整列オフセットを取得 / 操作します。
      パラメーター:
      key - null であってはなりません。
      subCommands - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.1

    • bitOp

      @Nullable LongSE bitOp(RedisStringCommands.BitOperation op, byte[] destination, byte[]... keys)
      文字列間でビット演算を実行します。
      パラメーター:
      op - null であってはなりません。
      destination - null であってはなりません。
      keys - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • bitPos

      @Nullable default LongSE bitPos(byte[] key, boolean bit)
      文字列内の指定された bit に設定された最初のビットの位置を返します。
      パラメーター:
      key - 実際の文字列を保持するキー。
      bit - 探すビット値。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。リクエストに応じて、最初のビットの位置が 1 または 0 に設定されます。
      導入:
      2.1
      関連事項:

    • bitPos

      @Nullable LongSE bitPos(byte[] key, boolean bit, Range<LongSE> range)
      文字列内の指定された bit に設定された最初のビットの位置を返します。Range の開始と終了には、文字列の末尾から始まるバイトにインデックスを付けるために負の値を含めることができます。ここで、-1 は最後のバイト、-2 は最後から 2 番目のバイトです。
      パラメーター:
      key - 実際の文字列を保持するキー。
      bit - 探すビット値。
      range - null であってはなりません。検索を制限しないようにするには、Range.unbounded() を使用します。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。リクエストに応じて、最初のビットの位置が 1 または 0 に設定されます。
      導入:
      2.1
      関連事項:

    • strLen

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