Interface RedisListCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterConnection, RedisCommands, RedisConnection, RedisConnectionUtils.RedisConnectionProxy, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

@NullUnmarked
public interface RedisListCommands

List-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, dengliming

See Also:

• RedisCommands

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RedisListCommands.Direction	List move direction.
static enum	RedisListCommands.Position	List insertion position.

Method Summary

Modifier and Type	Method	Description
byte[]	bLMove(byte @NonNull [] sourceKey, byte @NonNull [] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to, double timeout)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
@Nullable List<byte @NonNull []>	bLPop(int timeout, byte @NonNull [] @NonNull ... keys)	Removes and returns first element from lists stored at keys.
List<byte @NonNull []>	bRPop(int timeout, byte @NonNull [] @NonNull ... keys)	Removes and returns last element from lists stored at keys.
byte[]	bRPopLPush(int timeout, byte @NonNull [] srcKey, byte @NonNull [] dstKey)	Remove the last element from list at srcKey, append it to dstKey and return its value.
byte[]	lIndex(byte @NonNull [] key, long index)	Get element at index form list at key.
Long	lInsert(byte @NonNull [] key, @NonNull RedisListCommands.Position where, byte @NonNull [] pivot, byte @NonNull [] value)	Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.
Long	lLen(byte @NonNull [] key)	Get the size of list stored at key.
byte[]	lMove(byte @NonNull [] sourceKey, byte @NonNull [] destinationKey, @NonNull RedisListCommands.Direction from, @NonNull RedisListCommands.Direction to)	Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.
byte[]	lPop(byte @NonNull [] key)	Removes and returns first element in list stored at key.
List<byte @NonNull []>	lPop(byte @NonNull [] key, long count)	Removes and returns first elements in list stored at key.
default Long	lPos(byte @NonNull [] key, byte @NonNull [] element)	Returns the index of matching elements inside the list stored at given key.
List<Long>	lPos(byte @NonNull [] key, byte @NonNull [] element, @Nullable Integer rank, @Nullable Integer count)	Returns the index of matching elements inside the list stored at given key.
Long	lPush(byte @NonNull [] key, byte @NonNull [] @NonNull ... values)	Prepend values to key.
Long	lPushX(byte @NonNull [] key, byte @NonNull [] value)	Prepend values to key only if the list exists.
List<byte @NonNull []>	lRange(byte @NonNull [] key, long start, long end)	Get elements between start and end from list at key.
Long	lRem(byte @NonNull [] key, long count, byte @NonNull [] value)	Removes the first count occurrences of value from the list stored at key.
void	lSet(byte @NonNull [] key, long index, byte @NonNull [] value)	Set the value list element at index.
void	lTrim(byte @NonNull [] key, long start, long end)	Trim list at key to elements between start and end.
byte[]	rPop(byte @NonNull [] key)	Removes and returns last element in list stored at key.
List<byte @NonNull []>	rPop(byte @NonNull [] key, long count)	Removes and returns last elements in list stored at key.
byte[]	rPopLPush(byte @NonNull [] srcKey, byte @NonNull [] dstKey)	Remove the last element from list at srcKey, append it to dstKey and return its value.
Long	rPush(byte @NonNull [] key, byte @NonNull [] @NonNull ... values)	Append values to key.
Long	rPushX(byte @NonNull [] key, byte @NonNull [] value)	Append values to key only if the list exists.

Method Details

rPush

Long rPush(byte @NonNull [] key,
 byte @NonNull [] @NonNull ... values)

Append values to key.

Parameters:

key - must not be null.

values - must not be empty.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: RPUSH

lPos

default Long lPos(byte @NonNull [] key,
 byte @NonNull [] element)

Returns the index of matching elements inside the list stored at given key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

element - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: LPOS

lPos

List<Long> lPos(byte @NonNull [] key,
 byte @NonNull [] element,
 @Nullable Integer rank,
 @Nullable Integer count)

Returns the index of matching elements inside the list stored at given key.
Requires Redis 6.0.6 or newer.

Parameters:

key - must not be null.

element - must not be null.

rank - specifies the "rank" of the first element to return, in case there are multiple matches. A rank of 1 means to return the first match, 2 to return the second match, and so forth.

count - number of matches to return.

Returns:

null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: LPOS

lPush

Long lPush(byte @NonNull [] key,
 byte @NonNull [] @NonNull ... values)

Prepend values to key.

Parameters:

key - must not be null.

values - must not be empty.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LPUSH

rPushX

Long rPushX(byte @NonNull [] key,
 byte @NonNull [] value)

Append values to key only if the list exists.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: RPUSHX

lPushX

Long lPushX(byte @NonNull [] key,
 byte @NonNull [] value)

Prepend values to key only if the list exists.

Parameters:

key - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LPUSHX

lLen

Long lLen(byte @NonNull [] key)

Get the size of list stored at key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LLEN

lRange

List<byte @NonNull []> lRange(byte @NonNull [] key,
 long start,
 long end)

Get elements between start and end from list at key.

Parameters:

key - must not be null.

start -

end -

Returns:

empty List if key does not exists or range does not contain values. null when used in pipeline / transaction.

See Also:

• Redis Documentation: LRANGE

lTrim

void lTrim(byte @NonNull [] key,
 long start,
 long end)

Trim list at key to elements between start and end.

Parameters:

key - must not be null.

start -

end -

See Also:

• Redis Documentation: LTRIM

lIndex

byte[] lIndex(byte @NonNull [] key,
 long index)

Get element at index form list at key.

Parameters:

key - must not be null.

index - zero based index value. Use negative number to designate elements starting at the tail.

Returns:

null when index is out of range or when used in pipeline / transaction.

See Also:

• Redis Documentation: LINDEX

lInsert

Long lInsert(byte @NonNull [] key,
 @NonNull RedisListCommands.Position where,
 byte @NonNull [] pivot,
 byte @NonNull [] value)

Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.

Parameters:

key - must not be null.

where - must not be null.

pivot - must not be null.

value - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LINSERT

lMove

byte[] lMove(byte @NonNull [] sourceKey,
 byte @NonNull [] destinationKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull RedisListCommands.Direction to)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

from - must not be null.

to - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: LMOVE
• bLMove(byte[], byte[], Direction, Direction, double)

bLMove

byte[] bLMove(byte @NonNull [] sourceKey,
 byte @NonNull [] destinationKey,
 @NonNull RedisListCommands.Direction from,
 @NonNull RedisListCommands.Direction to,
 double timeout)

Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at sourceKey, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destinationKey.

Blocks connection until element available or timeout reached.

Parameters:

sourceKey - must not be null.

destinationKey - must not be null.

from - must not be null.

to - must not be null.

timeout -

Returns:

null when used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: BLMOVE
• lMove(byte[], byte[], Direction, Direction)

lSet

void lSet(byte @NonNull [] key,
 long index,
 byte @NonNull [] value)

Set the value list element at index.

Parameters:

key - must not be null.

index -

value -

See Also:

• Redis Documentation: LSET

lRem

Long lRem(byte @NonNull [] key,
 long count,
 byte @NonNull [] value)

Removes the first count occurrences of value from the list stored at key.

Parameters:

key - must not be null.

count -

value -

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LREM

lPop

byte[] lPop(byte @NonNull [] key)

Removes and returns first element in list stored at key.

Parameters:

key - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

See Also:

• Redis Documentation: LPOP

lPop

List<byte @NonNull []> lPop(byte @NonNull [] key,
 long count)

Removes and returns first elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

null when key does not exist or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: LPOP

rPop

byte[] rPop(byte @NonNull [] key)

Removes and returns last element in list stored at key.

Parameters:

key - must not be null.

Returns:

null when key does not exist or used in pipeline / transaction.

See Also:

• Redis Documentation: RPOP

rPop

List<byte @NonNull []> rPop(byte @NonNull [] key,
 long count)

Removes and returns last elements in list stored at key.

Parameters:

key - must not be null.

count -

Returns:

null when key does not exist or used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: RPOP

bLPop

@Nullable List<byte @NonNull []> bLPop(int timeout,
 byte @NonNull [] @NonNull ... keys)

Removes and returns first element from lists stored at keys.
Blocks connection until element available or timeout reached.

Parameters:

timeout - seconds to block.

keys - must not be null.

Returns:

empty List when no element could be popped and the timeout was reached. null when used in pipeline / transaction.

See Also:

• Redis Documentation: BLPOP
• lPop(byte[])

bRPop

List<byte @NonNull []> bRPop(int timeout,
 byte @NonNull [] @NonNull ... keys)

Removes and returns last element from lists stored at keys.
Blocks connection until element available or timeout reached.

Parameters:

timeout - seconds to block.

keys - must not be null.

Returns:

empty List when no element could be popped and the timeout was reached. null when used in pipeline / transaction.

See Also:

• Redis Documentation: BRPOP
• rPop(byte[])

rPopLPush

byte[] rPopLPush(byte @NonNull [] srcKey,
 byte @NonNull [] dstKey)

Remove the last element from list at srcKey, append it to dstKey and return its value.

Parameters:

srcKey - must not be null.

dstKey - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: RPOPLPUSH

bRPopLPush

byte[] bRPopLPush(int timeout,
 byte @NonNull [] srcKey,
 byte @NonNull [] dstKey)

Remove the last element from list at srcKey, append it to dstKey and return its value.
Blocks connection until element available or timeout reached.

Parameters:

timeout - seconds to block.

srcKey - must not be null.

dstKey - must not be null.

Returns:

can be null.

See Also:

• Redis Documentation: BRPOPLPUSH
• rPopLPush(byte[], byte[])