インターフェース RedisListCommands
- 既知のすべてのサブインターフェース:
DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection
- すべての既知の実装クラス:
AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection
@NullUnmarked
public interface RedisListCommands
Redis でサポートされているリスト固有のコマンド。
- 作成者:
- Costin Leau, Christoph Strobl, Mark Paluch, dengliming
- 関連事項:
ネストされたクラスの概要
ネストされたクラス修飾子と型インターフェース説明static enum移動方向をリストします。static enumリスト挿入位置。方法の概要
修飾子と型メソッド説明byte[]bLMove(byte @NonNull[] sourceKey, byte @NonNull[] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to, double timeout) sourceKeyに格納されたリストの最初 / 最後の要素 (引数fromに応じてヘッド / テール) をアトミックに 返して削除し、destinationKeyに格納されたリストの最初 / 最後の要素 (引数toに応じてヘッド / テール) に要素をプッシュします。@Nullable ListSE<byte @NonNull[]> bLPop(int timeout, byte @NonNull[] @NonNull... keys) keysに格納されているリストから最初の要素を削除して返します。ListSE<byte @NonNull[]> bRPop(int timeout, byte @NonNull[] @NonNull... keys) keysに格納されているリストから最後の要素を削除して返します。byte[]bRPopLPush(int timeout, byte @NonNull[] srcKey, byte @NonNull[] dstKey) srcKeyのリストから最後の要素を削除し、それをdstKeyに追加して、その値を返します。byte[]lIndex(byte @NonNull[] key, long index) keyのindexフォームリストで要素を取得します。lInsert(byte @NonNull[] key, @NonNull RedisListCommands.Position where, byte @NonNull[] pivot, byte @NonNull[] value) keyのvalueRedisListCommands.Position.BEFOREまたはRedisListCommands.Position.AFTER既存のpivotを挿入します。lLen(byte @NonNull[] key) keyに保存されているリストのサイズを取得します。byte[]lMove(byte @NonNull[] sourceKey, byte @NonNull[] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to) sourceKeyに格納されたリストの最初 / 最後の要素 (引数fromに応じてヘッド / テール) をアトミックに 返して削除し、destinationKeyに格納されたリストの最初 / 最後の要素 (引数toに応じてヘッド / テール) に要素をプッシュします。byte[]lPop(byte @NonNull[] key) keyに保存されているリストの最初の要素を削除して返します。ListSE<byte @NonNull[]> lPop(byte @NonNull[] key, long count) keyに格納されているリストの最初の要素を削除して返します。default LongSElPos(byte @NonNull[] key, byte @NonNull[] element) 指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。lPos(byte @NonNull[] key, byte @NonNull[] element, @Nullable IntegerSE rank, @Nullable IntegerSE count) 指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。lPush(byte @NonNull[] key, byte @NonNull[] @NonNull... values) valuesをkeyの前に追加します。lPushX(byte @NonNull[] key, byte @NonNull[] value) リストが存在する場合にのみ、valuesをkeyの前に付加します。ListSE<byte @NonNull[]> lRange(byte @NonNull[] key, long start, long end) keyのリストからstartとendの間の要素を取得します。lRem(byte @NonNull[] key, long count, byte @NonNull[] value) keyに格納されているリストからvalueの最初のcount出現箇所を削除します。voidlSet(byte @NonNull[] key, long index, byte @NonNull[] value) valueリスト要素をindexに設定します。voidlTrim(byte @NonNull[] key, long start, long end) keyのリストをstartとendの間の要素にトリムします。byte[]rPop(byte @NonNull[] key) keyに保存されているリストの最後の要素を削除して返します。ListSE<byte @NonNull[]> rPop(byte @NonNull[] key, long count) keyに保存されているリストの最後の要素を削除して返します。byte[]rPopLPush(byte @NonNull[] srcKey, byte @NonNull[] dstKey) srcKeyのリストから最後の要素を削除し、それをdstKeyに追加して、その値を返します。rPush(byte @NonNull[] key, byte @NonNull[] @NonNull... values) valuesをkeyに追加します。rPushX(byte @NonNull[] key, byte @NonNull[] value) リストが存在する場合にのみ、valuesをkeyに追加します。
メソッドの詳細
rPush
valuesをkeyに追加します。- パラメーター:
key- null であってはなりません。values- 空であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lPos
指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
Redis 6.0.6 以降が必要です。- パラメーター:
key- null であってはなりません。element- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 導入:
- 2.4
- 関連事項:
lPos
ListSE<LongSE> lPos(byte @NonNull [] key, byte @NonNull [] element, @Nullable IntegerSE rank, @Nullable IntegerSE count) 指定されたキーに格納されているリスト内の一致する要素のインデックスを返します。
Redis 6.0.6 以降が必要です。- パラメーター:
key- null であってはなりません。element- null であってはなりません。rank- 複数の一致がある場合に、返される最初の要素の「ランク」を指定します。ランク 1 は最初の一致を返すことを意味し、2 は 2 番目の一致を返すことを意味します。count- 返す一致の数。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 導入:
- 2.4
- 関連事項:
lPush
valuesをkeyの前に追加します。- パラメーター:
key- null であってはなりません。values- 空であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
rPushX
リストが存在する場合にのみ、valuesをkeyに追加します。- パラメーター:
key- null であってはなりません。value- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lPushX
リストが存在する場合にのみ、valuesをkeyの前に付加します。- パラメーター:
key- null であってはなりません。value- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lLen
keyに保存されているリストのサイズを取得します。- パラメーター:
key- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lRange
lTrim
void lTrim(byte @NonNull [] key, long start, long end) keyのリストをstartとendの間の要素にトリムします。- パラメーター:
key- null であってはなりません。start-end-- 関連事項:
lIndex
byte[] lIndex(byte @NonNull [] key, long index) keyのindexフォームリストで要素を取得します。- パラメーター:
key- null であってはなりません。index- ゼロベースのインデックス値。負の数を使用して、末尾から始まる要素を指定します。- 戻り値:
- インデックスが範囲外の場合、またはパイプライン / トランザクションで使用される場合は null。
- 関連事項:
lInsert
LongSE lInsert(byte @NonNull [] key, @NonNull RedisListCommands.Position where, byte @NonNull [] pivot, byte @NonNull [] value) keyのvalueRedisListCommands.Position.BEFOREまたはRedisListCommands.Position.AFTER既存のpivotを挿入します。- パラメーター:
key- null であってはなりません。where- null であってはなりません。pivot- null であってはなりません。value- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lMove
byte[] lMove(byte @NonNull [] sourceKey, byte @NonNull [] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to) sourceKeyに格納されたリストの最初 / 最後の要素 (引数fromに応じてヘッド / テール) をアトミックに 返して削除し、destinationKeyに格納されたリストの最初 / 最後の要素 (引数toに応じてヘッド / テール) に要素をプッシュします。- パラメーター:
sourceKey- null であってはなりません。destinationKey- null であってはなりません。from- null であってはなりません。to- null であってはなりません。- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 導入:
- 2.6
- 関連事項:
bLMove
byte[] bLMove(byte @NonNull [] sourceKey, byte @NonNull [] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull 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 @NonNull [] key, long index, byte @NonNull [] value) valueリスト要素をindexに設定します。- パラメーター:
key- null であってはなりません。index-value-- 関連事項:
lRem
keyに格納されているリストからvalueの最初のcount出現箇所を削除します。- パラメーター:
key- null であってはなりません。count-value-- 戻り値:
- パイプライン / トランザクションで使用される場合は null。
- 関連事項:
lPop
byte[] lPop(byte @NonNull [] key) keyに保存されているリストの最初の要素を削除して返します。- パラメーター:
key- null であってはなりません。- 戻り値:
- キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
- 関連事項:
lPop
keyに格納されているリストの最初の要素を削除して返します。- パラメーター:
key- null であってはなりません。count-- 戻り値:
- キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
- 導入:
- 2.6
- 関連事項:
rPop
byte[] rPop(byte @NonNull [] key) keyに保存されているリストの最後の要素を削除して返します。- パラメーター:
key- null であってはなりません。- 戻り値:
- キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
- 関連事項:
rPop
keyに保存されているリストの最後の要素を削除して返します。- パラメーター:
key- null であってはなりません。count-- 戻り値:
- キーが存在しないか、パイプライン / トランザクションで使用されていない場合は null。
- 導入:
- 2.6
- 関連事項:
bLPop
bRPop
rPopLPush
byte[] rPopLPush(byte @NonNull [] srcKey, byte @NonNull [] dstKey) srcKeyのリストから最後の要素を削除し、それをdstKeyに追加して、その値を返します。- パラメーター:
srcKey- null であってはなりません。dstKey- null であってはなりません。- 戻り値:
- null でもかまいません。
- 関連事項:
bRPopLPush
byte[] bRPopLPush(int timeout, byte @NonNull [] srcKey, byte @NonNull [] dstKey) srcKeyのリストから最後の要素を削除し、それをdstKeyに追加して、その値を返します。
要素が使用可能になるか、timeoutに到達するまで、 接続をブロックします。- パラメーター:
timeout- ブロックする秒数。srcKey- null であってはなりません。dstKey- null であってはなりません。- 戻り値:
- null でもかまいません。
- 関連事項: