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

インターフェース RedisStreamCommands

すべての既知のサブインターフェース:
DefaultedRedisClusterConnection、DefaultedRedisConnection、RedisClusterConnection、RedisCommands、RedisConnection、RedisConnectionUtils.RedisConnectionProxy、StringRedisConnection
すべての既知の実装クラス:
AbstractRedisConnection、DefaultStringRedisConnection、JedisClusterConnection、JedisConnection、LettuceClusterConnection、LettuceConnection
public interface RedisStreamCommands
ストリーム固有の Redis コマンド。
導入:
2.2
作成者:
Mark Paluch, Christoph Strobl, Tugdual Grall, Dengliming, Mark John Moreno
関連事項:

  • メソッドの詳細

    • xAck

      @Nullable default LongSE xAck(byte[] key, StringSE group, StringSE... recordIds)
      ID で識別された 1 つ以上のレコードを処理済みとして確認します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      recordIds - 確認するレコードの ID の文字列表現。
      戻り値:
      確認応答されたメッセージの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xAck

      @Nullable LongSE xAck(byte[] key, StringSE group, RecordId... recordIds)
      ID で識別された 1 つ以上のレコードを処理済みとして確認します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      recordIds - 確認するレコードの ID。
      戻り値:
      確認応答されたメッセージの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xAdd

      @Nullable default RecordId xAdd(byte[] key, MapSE<byte[],byte[]> content)
      指定された field/value pairsSE をコンテンツとして含む新しいレコードを key に保存されているストリームに追加します。
      パラメーター:
      key - ストリームが保存されているキー。
      content - field/value pairsSE としてモデル化されたレコードコンテンツ。
      戻り値:
      サーバーは id を生成しました。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xAdd

      @Nullable default RecordId xAdd(MapRecord<byte[],byte[],byte[]> record)
      指定された record を Record#getStream に保存されているストリームに追加します。サーバーで生成されたものよりも手動で ID を割り当てる場合は、Record#withId を介して ID を指定してください。
      パラメーター:
      record - 追加する record。
      戻り値:
      保存後の id。パイプライン / トランザクションで使用される場合は null。

    • xAdd

      @Nullable RecordId xAdd(MapRecord<byte[],byte[],byte[]> record, RedisStreamCommands.XAddOptions options)
      指定された record を Record#getStream に保存されているストリームに追加します。サーバーで生成されたものよりも手動で ID を割り当てる場合は、Record#withId を介して ID を指定してください。
      パラメーター:
      record - 追加する record。
      options - 追加オプション（例: MAXLEN）。null であってはならず、代わりに RedisStreamCommands.XAddOptions.none() を使用してください。
      戻り値:
      保存後の id。パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • xClaimJustId

      @Nullable ListSE<RecordId> xClaimJustId(byte[] key, StringSE group, StringSE newOwner, RedisStreamCommands.XClaimOptions options)
      配信数を増やすことなく、指定された新しいコンシューマーへの保留中のメッセージの所有権を変更します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      newOwner - 新しいコンシューマーの名前。
      options - null であってはなりません。
      戻り値:
      ユーザーを変更した ids のリスト。
      導入:
      2.3
      関連事項:

    • xClaim

      @Nullable default ListSE<ByteRecord> xClaim(byte[] key, StringSE group, StringSE newOwner, DurationSE minIdleTime, RecordId... recordIds)
      指定された新しいコンシューマーへの保留中のメッセージの所有権を変更します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      newOwner - 新しいコンシューマーの名前。
      minIdleTime - null であってはなりません。
      recordIds - null であってはなりません。
      戻り値:
      ユーザーを変更した ByteRecord のリスト。
      導入:
      2.3
      関連事項:

    • xClaim

      @Nullable ListSE<ByteRecord> xClaim(byte[] key, StringSE group, StringSE newOwner, RedisStreamCommands.XClaimOptions options)
      指定された新しいコンシューマーへの保留中のメッセージの所有権を変更します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      newOwner - 新しいコンシューマーの名前。
      options - null であってはなりません。
      戻り値:
      ユーザーを変更した ByteRecord のリスト。
      導入:
      2.3
      関連事項:

    • xDel

      @Nullable default LongSE xDel(byte[] key, StringSE... recordIds)
      指定された ID のレコードをストリームから削除します。削除されたアイテムの数を返します。特定の ID が存在しない場合に渡される ID の数とは異なる場合があります。
      パラメーター:
      key - ストリームが保存されているキー。
      recordIds - 削除するレコードの ID。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xDel

      @Nullable LongSE xDel(byte[] key, RecordId... recordIds)
      指定された ID のレコードをストリームから削除します。削除されたアイテムの数を返します。特定の ID が存在しない場合に渡される ID の数とは異なる場合があります。
      パラメーター:
      key - ストリームが保存されているキー。
      recordIds - 削除するレコードの ID。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xGroupCreate

      @Nullable StringSE xGroupCreate(byte[] key, StringSE groupName, ReadOffset readOffset)
      コンシューマーグループを作成します。
      パラメーター:
      key - ストリームが保存されているキー。
      groupName - 作成するコンシューマーグループの名前。
      readOffset - 開始するオフセット。
      戻り値:
      成功すれば大丈夫。パイプライン / トランザクションで使用される場合は null。

    • xGroupCreate

      @Nullable StringSE xGroupCreate(byte[] key, StringSE groupName, ReadOffset readOffset, boolean mkStream)
      コンシューマーグループを作成します。
      パラメーター:
      key - ストリームが保存されているキー。
      groupName - 作成するコンシューマーグループの名前。
      readOffset - 開始するオフセット。
      mkStream - true の場合、グループはまだ存在しない場合はストリームを作成します (MKSTREAM)
      戻り値:
      成功すれば大丈夫。パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • xGroupDelConsumer

      @Nullable default BooleanSE xGroupDelConsumer(byte[] key, StringSE groupName, StringSE consumerName)
      コンシューマーグループからコンシューマーを削除します。
      パラメーター:
      key - ストリームが保存されているキー。
      groupName - コンシューマーを削除するグループの名前。
      consumerName - グループから削除するコンシューマーの名前。
      戻り値:
      成功した場合は true。パイプライン / トランザクションで使用される場合は null。

    • xGroupDelConsumer

      @Nullable BooleanSE xGroupDelConsumer(byte[] key, Consumer consumer)
      コンシューマーグループからコンシューマーを削除します。
      パラメーター:
      key - ストリームが保存されているキー。
      consumer - グループ名とコンシューマー名で識別されるコンシューマー。
      戻り値:
      成功した場合は true。パイプライン / トランザクションで使用される場合は null。

    • xGroupDestroy

      @Nullable BooleanSE xGroupDestroy(byte[] key, StringSE groupName)
      コンシューマーグループを破棄します。
      パラメーター:
      key - ストリームが保存されているキー。
      groupName - コンシューマーグループの名前。
      戻り値:
      成功した場合は true。パイプライン / トランザクションで使用される場合は null。

    • xInfo

      @Nullable StreamInfo.XInfoStream xInfo(byte[] key)
      指定されたキーに保存されているストリームに関する一般情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • xInfoGroups

      @Nullable StreamInfo.XInfoGroups xInfoGroups(byte[] key)
      指定されたキーに格納されているストリームに関連付けられているコンシューマーグループに関する情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • xInfoConsumers

      @Nullable StreamInfo.XInfoConsumers xInfoConsumers(byte[] key, StringSE groupName)
      指定されたキーに格納されているストリームの特定のコンシューマーグループ内のすべてのコンシューマーに関する情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      groupName - コンシューマーグループの名前。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • xLen

      @Nullable LongSE xLen(byte[] key)
      ストリームの長さを取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      戻り値:
      ストリームの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xPending

      @Nullable PendingMessagesSummary xPending(byte[] key, StringSE groupName)
      特定のコンシューマーグループの PendingMessagesSummary を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      groupName - コンシューマーグループの名前。null であってはなりません。
      戻り値:
      指定されたコンシューマーグループ内の保留中のメッセージの要約、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable default PendingMessages xPending(byte[] key, Consumer consumer)
      特定の Consumer のすべての保留中のメッセージに関する詳細情報を取得しました。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      consumer - PendingMessages をフェッチするコンシューマー。null であってはなりません。
      戻り値:
      指定された Consumer の保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable default PendingMessages xPending(byte[] key, StringSE groupName, StringSE consumerName)
      特定のコンシューマーのすべての保留中のメッセージに関する詳細情報を取得しました。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      groupName - コンシューマーグループの名前。null であってはなりません。
      consumerName - PendingMessages をフェッチするコンシューマー。null であってはなりません。
      戻り値:
      指定された Consumer の保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable default PendingMessages xPending(byte[] key, StringSE groupName, Range<?> range, LongSE count)
      コンシューマーグループ内の特定の Range の保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      groupName - コンシューマーグループの名前。null であってはなりません。
      range - 検索するメッセージ ID の範囲。null であってはなりません。
      count - 結果の数を制限します。null であってはなりません。
      戻り値:
      指定されたコンシューマーグループの保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable default PendingMessages xPending(byte[] key, Consumer consumer, Range<?> range, LongSE count)
      コンシューマーグループ内の特定の Range および Consumer の保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      consumer - Consumer の名前。null であってはなりません。
      range - 検索するメッセージ ID の範囲。null であってはなりません。
      count - 結果の数を制限します。null であってはなりません。
      戻り値:
      指定された Consumer の保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable default PendingMessages xPending(byte[] key, StringSE groupName, StringSE consumerName, Range<?> range, LongSE count)
      特定の Range およびコンシューマーグループ内のコンシューマーの保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      groupName - コンシューマーグループの名前。null であってはなりません。
      consumerName - コンシューマーの名前。null であってはなりません。
      range - 検索するメッセージ ID の範囲。null であってはなりません。
      count - 結果の数を制限します。null であってはなりません。
      戻り値:
      特定のコンシューマーグループ内の特定のコンシューマーに対する保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xPending

      @Nullable PendingMessages xPending(byte[] key, StringSE groupName, RedisStreamCommands.XPendingOptions options)
      指定された options を適用する保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      groupName - コンシューマーグループの名前。null であってはなりません。
      options - 範囲、コンシューマー、カウントを含むオプション。null であってはなりません。
      戻り値:
      指定された条件に一致する保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • xRange

      @Nullable default ListSE<ByteRecord> xRange(byte[] key, Range<StringSE> range)
      キーに格納されているストリームから、特定の Range 内のすべての records を取得します。
      Range.unbounded() を使用して、可能な最小および最大 ID から読み取ります。
      パラメーター:
      key - ストリームが保存されているキー。
      range - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xRange

      @Nullable ListSE<ByteRecord> xRange(byte[] key, Range<StringSE> range, Limit limit)
      キーに格納されているストリームから、特定の Range 内の records の limited number を取得します。
      Range.unbounded() を使用して、可能な最小 ID と最大 ID から読み取ります。
      すべてのレコードを読み取るには、Limit.unlimited() を使用します。
      パラメーター:
      key - ストリームが保存されているキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xRead

      @Nullable default ListSE<ByteRecord> xRead(StreamOffset<byte[]>... streams)
      1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      streams - 読み取るストリーム。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xRead

      @Nullable ListSE<ByteRecord> xRead(StreamReadOptions readOptions, StreamOffset<byte[]>... streams)
      1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xReadGroup

      @Nullable default ListSE<ByteRecord> xReadGroup(Consumer consumer, StreamOffset<byte[]>... streams)
      コンシューマーグループを使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      consumer - コンシューマー / グループ。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xReadGroup

      @Nullable ListSE<ByteRecord> xReadGroup(Consumer consumer, StreamReadOptions readOptions, StreamOffset<byte[]>... streams)
      コンシューマーグループを使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      consumer - コンシューマー / グループ。
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xRevRange

      @Nullable default ListSE<ByteRecord> xRevRange(byte[] key, Range<StringSE> range)
      特定の Range 内のストリームからレコードを逆の順序で読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xRevRange

      @Nullable ListSE<ByteRecord> xRevRange(byte[] key, Range<StringSE> range, Limit limit)
      Limit を逆の順序で適用して、特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xTrim

      @Nullable LongSE xTrim(byte[] key, long count)
      ストリームを count 要素にトリミングします。
      パラメーター:
      key - ストリームキー。
      count - ストリームの長さ。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • xTrim

      @Nullable LongSE xTrim(byte[] key, long count, boolean approximateTrimming)
      ストリームを count 要素にトリミングします。
      パラメーター:
      key - ストリームキー。
      count - ストリームの長さ。
      approximateTrimming - パフォーマンスを最大化するには、おおよその方法でトリミングを実行する必要があります。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      導入:
      2.4
      関連事項: