インターフェース RedisListCommands

すべての既知のサブインターフェース:
DefaultedRedisClusterConnectionDefaultedRedisConnectionRedisClusterConnectionRedisCommandsRedisConnectionRedisConnectionUtils.RedisConnectionProxyStringRedisConnection
すべての既知の実装クラス:
AbstractRedisConnectionDefaultStringRedisConnectionJedisClusterConnectionJedisConnectionLettuceClusterConnectionLettuceConnection

public interface RedisListCommands
Redis でサポートされているリスト固有のコマンド。
作成者:
Costin Leau, Christoph Strobl, Mark Paluch, dengliming
  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static enum
    移動方向をリストします。
    static enum
    リスト挿入位置。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    byte[]
    bLMove(byte[] sourceKey, byte[] destinationKey, RedisListCommands.Direction from, RedisListCommands.Direction to, double timeout)
    sourceKey に格納されたリストの最初 / 最後の要素 (引数 from に応じてヘッド / テール) をアトミックに 返して削除し、destinationKey に格納されたリストの最初 / 最後の要素 (引数 to に応じてヘッド / テール) に要素をプッシュします。
    ListSE<byte[]>
    bLPop(int timeout, byte[]... keys)
    keys に格納されているリストから最初の要素を削除して返します。
    ListSE<byte[]>
    bRPop(int timeout, byte[]... keys)
    keys に格納されているリストから最後の要素を削除して返します。
    byte[]
    bRPopLPush(int timeout, byte[] srcKey, byte[] dstKey)
    srcKey のリストから最後の要素を削除し、それを dstKey に追加して、その値を返します。
    byte[]
    lIndex(byte[] key, long index)
    key の index フォームリストで要素を取得します。
    lInsert(byte[] key, RedisListCommands.Position where, byte[] pivot, byte[] value)
    key の value RedisListCommands.Position.BEFORE または RedisListCommands.Position.AFTER 既存の pivot を挿入します。
    lLen(byte[] key)
    key に保存されているリストのサイズを取得します。
    byte[]
    lMove(byte[] sourceKey, byte[] destinationKey, RedisListCommands.Direction from, RedisListCommands.Direction to)
    sourceKey に格納されたリストの最初 / 最後の要素 (引数 from に応じてヘッド / テール) をアトミックに 返して削除し、destinationKey に格納されたリストの最初 / 最後の要素 (引数 to に応じてヘッド / テール) に要素をプッシュします。
    byte[]
    lPop(byte[] key)
    key に保存されているリストの最初の要素を削除して返します。
    ListSE<byte[]>
    lPop(byte[] key, long count)
    key に格納されているリストの最初の要素を削除して返します。
    default LongSE
    lPos(byte[] key, byte[] element)
    指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
    lPos(byte[] key, byte[] element, IntegerSE rank, IntegerSE count)
    指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
    lPush(byte[] key, byte[]... values)
    values を key の前に追加します。
    lPushX(byte[] key, byte[] value)
    リストが存在する場合にのみ、values を key の前に付加します。
    ListSE<byte[]>
    lRange(byte[] key, long start, long end)
    key のリストから start と end の間の要素を取得します。
    lRem(byte[] key, long count, byte[] value)
    key に格納されているリストから value の最初の count 出現箇所を削除します。
    void
    lSet(byte[] key, long index, byte[] value)
    value リスト要素を index に設定します。
    void
    lTrim(byte[] key, long start, long end)
    key のリストを start と end の間の要素にトリムします。
    byte[]
    rPop(byte[] key)
    key に保存されているリストの最後の要素を削除して返します。
    ListSE<byte[]>
    rPop(byte[] key, long count)
    key に保存されているリストの最後の要素を削除して返します。
    byte[]
    rPopLPush(byte[] srcKey, byte[] dstKey)
    srcKey のリストから最後の要素を削除し、それを dstKey に追加して、その値を返します。
    rPush(byte[] key, byte[]... values)
    values を key に追加します。
    rPushX(byte[] key, byte[] value)
    リストが存在する場合にのみ、values を key に追加します。
  • メソッドの詳細

    • rPush

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

      @Nullable default LongSE lPos(byte[] key, byte[] element)
      指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
      Redis 6.0.6 以降が必要です。
      パラメーター:
      key - null であってはなりません。
      element - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.4
      関連事項:
    • lPos

      @Nullable ListSE<LongSE> lPos(byte[] key, byte[] element, @Nullable IntegerSE rank, @Nullable IntegerSE count)
      指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
      Redis 6.0.6 以降が必要です。
      パラメーター:
      key - null であってはなりません。
      element - null であってはなりません。
      rank - 複数の一致がある場合に、返される最初の要素の「ランク」を指定します。ランク 1 は最初の一致を返すことを意味し、2 は 2 番目の一致を返すことを意味します。
      count - 返す一致の数。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.4
      関連事項:
    • lPush

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

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

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

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

      @Nullable ListSE<byte[]> lRange(byte[] key, long start, long end)
      key のリストから start と end の間の要素を取得します。
      パラメーター:
      key - null であってはなりません。
      start -
      end -
      戻り値:
      キーが存在しないか、範囲に値が含まれていない場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。
      関連事項:
    • lTrim

      void lTrim(byte[] key, long start, long end)
      key のリストを start と end の間の要素にトリムします。
      パラメーター:
      key - null であってはなりません。
      start -
      end -
      関連事項:
    • lIndex

      @Nullable byte[] lIndex(byte[] key, long index)
      key の index フォームリストで要素を取得します。
      パラメーター:
      key - null であってはなりません。
      index - ゼロベースのインデックス値。負の数を使用して、末尾から始まる要素を指定します。
      戻り値:
      インデックスが範囲外の場合、またはパイプライン / トランザクションで使用される場合は null。
      関連事項:
    • lInsert

      @Nullable LongSE lInsert(byte[] key, RedisListCommands.Position where, byte[] pivot, byte[] value)
      key の value RedisListCommands.Position.BEFORE または RedisListCommands.Position.AFTER 既存の pivot を挿入します。
      パラメーター:
      key - null であってはなりません。
      where - null であってはなりません。
      pivot - null であってはなりません。
      value - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:
    • lMove

      @Nullable byte[] lMove(byte[] sourceKey, byte[] destinationKey, RedisListCommands.Direction from, RedisListCommands.Direction to)
      sourceKey に格納されたリストの最初 / 最後の要素 (引数 from に応じてヘッド / テール) をアトミックに 返して削除し、destinationKey に格納されたリストの最初 / 最後の要素 (引数 to に応じてヘッド / テール) に要素をプッシュします。
      パラメーター:
      sourceKey - null であってはなりません。
      destinationKey - null であってはなりません。
      from - null であってはなりません。
      to - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:
    • bLMove

      @Nullable byte[] bLMove(byte[] sourceKey, byte[] destinationKey, RedisListCommands.Direction from, RedisListCommands.Direction to, double timeout)
      sourceKey に格納されたリストの最初 / 最後の要素 (引数 from に応じてヘッド / テール) をアトミックに 返して削除し、destinationKey に格納されたリストの最初 / 最後の要素 (引数 to に応じてヘッド / テール) に要素をプッシュします。

      要素が使用可能になるか、timeout に達するまで、 接続をブロックします。

      パラメーター:
      sourceKey - null であってはなりません。
      destinationKey - null であってはなりません。
      from - null であってはなりません。
      to - null であってはなりません。
      timeout -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.6
      関連事項:
    • lSet

      void lSet(byte[] key, long index, byte[] value)
      value リスト要素を index に設定します。
      パラメーター:
      key - null であってはなりません。
      index -
      value -
      関連事項:
    • lRem

      @Nullable LongSE lRem(byte[] key, long count, byte[] value)
      key に格納されているリストから value の最初の count 出現箇所を削除します。
      パラメーター:
      key - null であってはなりません。
      count -
      value -
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:
    • lPop

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

      @Nullable ListSE<byte[]> lPop(byte[] key, long count)
      key に格納されているリストの最初の要素を削除して返します。
      パラメーター:
      key - null であってはなりません。
      count -
      戻り値:
      キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
      導入:
      2.6
      関連事項:
    • rPop

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

      @Nullable ListSE<byte[]> rPop(byte[] key, long count)
      key に保存されているリストの最後の要素を削除して返します。
      パラメーター:
      key - null であってはなりません。
      count -
      戻り値:
      キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
      導入:
      2.6
      関連事項:
    • bLPop

      @Nullable ListSE<byte[]> bLPop(int timeout, byte[]... keys)
      keys に格納されているリストから最初の要素を削除して返します。
      要素が使用可能になるか、timeout に達するまで、 接続をブロックします
      パラメーター:
      timeout - ブロックする秒数。
      keys - null であってはなりません。
      戻り値:
      要素をポップできず、タイムアウトに達した場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。
      関連事項:
    • bRPop

      @Nullable ListSE<byte[]> bRPop(int timeout, byte[]... keys)
      keys に格納されているリストから最後の要素を削除して返します。
      要素が使用可能になるか、timeout に達するまで、 接続をブロックします
      パラメーター:
      timeout - ブロックする秒数。
      keys - null であってはなりません。
      戻り値:
      要素をポップできず、タイムアウトに達した場合は、ListSE を空にします。パイプライン / トランザクションで使用される場合は null。
      関連事項:
    • rPopLPush

      @Nullable byte[] rPopLPush(byte[] srcKey, byte[] dstKey)
      srcKey のリストから最後の要素を削除し、それを dstKey に追加して、その値を返します。
      パラメーター:
      srcKey - null であってはなりません。
      dstKey - null であってはなりません。
      戻り値:
      null でもかまいません。
      関連事項:
    • bRPopLPush

      @Nullable byte[] bRPopLPush(int timeout, byte[] srcKey, byte[] dstKey)
      srcKey のリストから最後の要素を削除し、それを dstKey に追加して、その値を返します。
      要素が使用可能になるか、timeout に到達するまで、 接続をブロックします
      パラメーター:
      timeout - ブロックする秒数。
      srcKey - null であってはなりません。
      dstKey - null であってはなりません。
      戻り値:
      null でもかまいません。
      関連事項: