Package org.springframework.data.redis.connection

Interface ReactiveKeyCommands

All Known Subinterfaces:

ReactiveClusterKeyCommands

public interface ReactiveKeyCommands

Redis Key commands executed using reactive infrastructure.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, Dahye Anne Lee

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReactiveKeyCommands.CopyCommand	MOVE command parameters.
static class	ReactiveKeyCommands.ExpireAtCommand	EXPIREAT/PEXPIREAT command parameters.
static class	ReactiveKeyCommands.ExpireCommand	EXPIRE/PEXPIRE command parameters.
static class	ReactiveKeyCommands.MoveCommand	MOVE command parameters.
static class	ReactiveKeyCommands.RenameCommand	RENAME command parameters.

Method Summary

Modifier and Type	Method	Description
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>>	applyExpiration(Publisher<ReactiveKeyCommands.ExpireCommand> commands)	Expire a List of field after a given Duration of time, measured in milliseconds, has passed.
default Mono<Boolean>	copy(ByteBuffer sourceKey, ByteBuffer targetKey, boolean replace)	Copy given key to a target key.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.CopyCommand>>	copy(Publisher<ReactiveKeyCommands.CopyCommand> commands)	Copy keys one-by-one.
default Mono<Long>	del(ByteBuffer key)	Delete key.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	del(Publisher<ReactiveRedisConnection.KeyCommand> keys)	Delete keys one by one.
Mono<ValueEncoding>	encodingOf(ByteBuffer key)	Get the type of internal representation used for storing the value at the given key.
default Mono<Boolean>	exists(ByteBuffer key)	Determine if given key exists.
Mono<Long>	exists(List<ByteBuffer> keys)	Determine the number of given keys that exist.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.KeyCommand>>	exists(Publisher<ReactiveRedisConnection.KeyCommand> keys)	Determine if given key exists.
default Mono<Boolean>	expire(ByteBuffer key, Duration timeout)	Set time to live for given key in seconds.
default Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>>	expire(Publisher<ReactiveKeyCommands.ExpireCommand> commands)	Expire keys one by one.
default Mono<Boolean>	expireAt(ByteBuffer key, Instant expireAt)	Set the expiration for given key as a UNIX timestamp.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireAtCommand>>	expireAt(Publisher<ReactiveKeyCommands.ExpireAtCommand> commands)	Set one-by-one the expiration for given key as a UNIX timestamp.
Mono<Duration>	idletime(ByteBuffer key)	Get the Duration since the object stored at the given key is idle.
default Mono<List<ByteBuffer>>	keys(ByteBuffer pattern)	Retrieve all keys matching the given pattern via KEYS command.
Flux<ReactiveRedisConnection.MultiValueResponse<ByteBuffer,ByteBuffer>>	keys(Publisher<ByteBuffer> patterns)	Find all keys matching the given pattern. It is recommended to use scan(ScanOptions) to iterate over the keyspace as keys(Publisher) is a non-interruptible and expensive Redis operation.
default Mono<Long>	mDel(List<ByteBuffer> keys)	Delete multiple keys one in one batch.
Flux<ReactiveRedisConnection.NumericResponse<List<ByteBuffer>,Long>>	mDel(Publisher<List<ByteBuffer>> keys)	Delete multiple keys in batches.
default Mono<Boolean>	move(ByteBuffer key, int database)	Move given key to database with index.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.MoveCommand>>	move(Publisher<ReactiveKeyCommands.MoveCommand> commands)	Move keys one-by-one between databases.
default Mono<Long>	mUnlink(List<ByteBuffer> keys)	Unlink the keys from the keyspace.
Flux<ReactiveRedisConnection.NumericResponse<List<ByteBuffer>,Long>>	mUnlink(Publisher<List<ByteBuffer>> keys)	Unlink the keys from the keyspace.
default Mono<Boolean>	persist(ByteBuffer key)	Remove the expiration from given key.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.KeyCommand>>	persist(Publisher<ReactiveRedisConnection.KeyCommand> commands)	Remove one-by-one the expiration from given key.
default Mono<Boolean>	pExpire(ByteBuffer key, Duration timeout)	Set time to live for given key in milliseconds.
default Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>>	pExpire(Publisher<ReactiveKeyCommands.ExpireCommand> commands)	Expire keys one by one.
default Mono<Boolean>	pExpireAt(ByteBuffer key, Instant expireAt)	Set the expiration for given key as a UNIX timestamp.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireAtCommand>>	pExpireAt(Publisher<ReactiveKeyCommands.ExpireAtCommand> commands)	Set one-by-one the expiration for given key as a UNIX timestamp in milliseconds.
default Mono<Long>	pTtl(ByteBuffer key)	Get the time to live for key in milliseconds.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	pTtl(Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get one-by-one the time to live for keys.
Mono<ByteBuffer>	randomKey()	Return a random key from the keyspace.
Mono<Long>	refcount(ByteBuffer key)	Get the number of references of the value associated with the specified key.
default Mono<Boolean>	rename(ByteBuffer oldKey, ByteBuffer newKey)	Rename key oldKey to newKey.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.RenameCommand>>	rename(Publisher<ReactiveKeyCommands.RenameCommand> command)	Rename key oldKey to newKey.
default Mono<Boolean>	renameNX(ByteBuffer key, ByteBuffer newKey)	Rename key oldKey to newKey only if newKey does not exist.
Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.RenameCommand>>	renameNX(Publisher<ReactiveKeyCommands.RenameCommand> command)	Rename key oldKey to newKey only if newKey does not exist.
default Flux<ByteBuffer>	scan()	Use a Flux to iterate over keys.
default Flux<ByteBuffer>	scan(KeyScanOptions options)	Use a Flux to iterate over keys.
Flux<ByteBuffer>	scan(ScanOptions options)	Use a Flux to iterate over keys.
default Mono<Long>	touch(Collection<ByteBuffer> keys)	Alter the last access time of given key(s).
Flux<ReactiveRedisConnection.NumericResponse<Collection<ByteBuffer>,Long>>	touch(Publisher<Collection<ByteBuffer>> keys)	Alter the last access time of given key(s).
default Mono<Long>	ttl(ByteBuffer key)	Get the time to live for key in seconds.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	ttl(Publisher<ReactiveRedisConnection.KeyCommand> commands)	Get one-by-one the time to live for keys.
default Mono<DataType>	type(ByteBuffer key)	Determine the type stored at key.
Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,DataType>>	type(Publisher<ReactiveRedisConnection.KeyCommand> keys)	Determine the type stored at key.
default Mono<Long>	unlink(ByteBuffer key)	Unlink the key from the keyspace.
Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	unlink(Publisher<ReactiveRedisConnection.KeyCommand> keys)	Unlink the key from the keyspace.

Method Details

copy

default Mono<Boolean> copy(ByteBuffer sourceKey,
 ByteBuffer targetKey,
 boolean replace)

Copy given key to a target key.

Parameters:

sourceKey - must not be null.

targetKey - must not be null.

replace - whether to replace existing keys.

Returns:

Since:

2.6

See Also:

• Redis Documentation: COPY

copy

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.CopyCommand>> copy(Publisher<ReactiveKeyCommands.CopyCommand> commands)

Copy keys one-by-one.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key to move along with the copy result.

Since:

2.6

See Also:

• Redis Documentation: COPY

exists

default Mono<Boolean> exists(ByteBuffer key)

Determine if given key exists.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: EXISTS

exists

Mono<Long> exists(List<ByteBuffer> keys)

Determine the number of given keys that exist.

Parameters:

keys - must not be null or empty.

Returns:

Mono emitting the number of existing keys.

Since:

3.5

See Also:

• Redis Documentation: EXISTS

exists

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.KeyCommand>> exists(Publisher<ReactiveRedisConnection.KeyCommand> keys)

Determine if given key exists.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: EXISTS

type

default Mono<DataType> type(ByteBuffer key)

Determine the type stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: TYPE

type

Flux<ReactiveRedisConnection.CommandResponse<ReactiveRedisConnection.KeyCommand,DataType>> type(Publisher<ReactiveRedisConnection.KeyCommand> keys)

Determine the type stored at key.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: TYPE

touch

default Mono<Long> touch(Collection<ByteBuffer> keys)

Alter the last access time of given key(s).

Parameters:

keys - must not be null.

Returns:

Mono emitting the number of keys touched.

Since:

2.1

See Also:

• Redis Documentation: TOUCH

touch

Flux<ReactiveRedisConnection.NumericResponse<Collection<ByteBuffer>,Long>> touch(Publisher<Collection<ByteBuffer>> keys)

Alter the last access time of given key(s).

Parameters:

keys - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: TOUCH

keys

default Mono<List<ByteBuffer>> keys(ByteBuffer pattern)

Retrieve all keys matching the given pattern via KEYS command.

IMPORTANT: This command is non-interruptible and scans the entire keyspace which may cause performance issues. Consider scan(ScanOptions) for large datasets.

Parameters:

pattern - must not be null.

Returns:

See Also:

• Redis Documentation: KEYS

keys

Flux<ReactiveRedisConnection.MultiValueResponse<ByteBuffer,ByteBuffer>> keys(Publisher<ByteBuffer> patterns)

Find all keys matching the given pattern.
It is recommended to use scan(ScanOptions) to iterate over the keyspace as keys(Publisher) is a non-interruptible and expensive Redis operation.

Parameters:

patterns - must not be null.

Returns:

See Also:

• Redis Documentation: KEYS

scan

default Flux<ByteBuffer> scan()

Use a Flux to iterate over keys. The resulting Flux acts as a cursor and issues SCAN commands itself as long as the subscriber signals demand.

Returns:

never null.

Since:

2.1

See Also:

• Redis Documentation: SCAN

scan

default Flux<ByteBuffer> scan(KeyScanOptions options)

Use a Flux to iterate over keys. The resulting Flux acts as a cursor and issues SCAN commands itself as long as the subscriber signals demand.

Parameters:

options - must not be null.

Returns:

the Flux emitting keys one by one.

Throws:

IllegalArgumentException - when options is null.

Since:

2.6

See Also:

• Redis Documentation: SCAN

scan

Flux<ByteBuffer> scan(ScanOptions options)

Use a Flux to iterate over keys. The resulting Flux acts as a cursor and issues SCAN commands itself as long as the subscriber signals demand.

Parameters:

options - must not be null.

Returns:

the Flux emitting keys one by one.

Throws:

IllegalArgumentException - when options is null.

Since:

2.1

See Also:

• Redis Documentation: SCAN

randomKey

Mono<ByteBuffer> randomKey()

Return a random key from the keyspace.

Returns:

See Also:

• Redis Documentation: RANDOMKEY

rename

default Mono<Boolean> rename(ByteBuffer oldKey,
 ByteBuffer newKey)

Rename key oldKey to newKey.

Parameters:

oldKey - must not be null.

newKey - must not be null.

Returns:

See Also:

• Redis Documentation: RENAME

rename

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.RenameCommand>> rename(Publisher<ReactiveKeyCommands.RenameCommand> command)

Rename key oldKey to newKey.

Parameters:

command - must not be null.

Returns:

See Also:

• Redis Documentation: RENAME

renameNX

default Mono<Boolean> renameNX(ByteBuffer key,
 ByteBuffer newKey)

Rename key oldKey to newKey only if newKey does not exist.

Parameters:

key - must not be null.

newKey - must not be null.

Returns:

See Also:

• Redis Documentation: RENAMENX

renameNX

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.RenameCommand>> renameNX(Publisher<ReactiveKeyCommands.RenameCommand> command)

Rename key oldKey to newKey only if newKey does not exist.

Parameters:

command - must not be null.

Returns:

See Also:

• Redis Documentation: RENAMENX

del

default Mono<Long> del(ByteBuffer key)

Delete key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: DEL

del

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> del(Publisher<ReactiveRedisConnection.KeyCommand> keys)

Delete keys one by one.

Parameters:

keys - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the key removed along with the deletion result.

See Also:

• Redis Documentation: DEL

mDel

default Mono<Long> mDel(List<ByteBuffer> keys)

Delete multiple keys one in one batch.

Parameters:

keys - must not be null.

Returns:

See Also:

• Redis Documentation: DEL

mDel

Flux<ReactiveRedisConnection.NumericResponse<List<ByteBuffer>,Long>> mDel(Publisher<List<ByteBuffer>> keys)

Delete multiple keys in batches.

Parameters:

keys - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the keys removed along with the deletion result.

See Also:

• Redis Documentation: DEL

unlink

default Mono<Long> unlink(ByteBuffer key)

Unlink the key from the keyspace. Unlike with del(ByteBuffer) the actual memory reclaiming here happens asynchronously.

Parameters:

key - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: UNLINK

unlink

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> unlink(Publisher<ReactiveRedisConnection.KeyCommand> keys)

Unlink the key from the keyspace. Unlike with del(ByteBuffer) the actual memory reclaiming here happens asynchronously.

Parameters:

keys - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the key removed along with the unlink result.

Since:

2.1

See Also:

• Redis Documentation: UNLINK

mUnlink

default Mono<Long> mUnlink(List<ByteBuffer> keys)

Unlink the keys from the keyspace. Unlike with mDel(List) the actual memory reclaiming here happens asynchronously.

Parameters:

keys - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: UNLINK

mUnlink

Flux<ReactiveRedisConnection.NumericResponse<List<ByteBuffer>,Long>> mUnlink(Publisher<List<ByteBuffer>> keys)

Unlink the keys from the keyspace. Unlike with mDel(Publisher) the actual memory reclaiming here happens asynchronously.

Parameters:

keys - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the key removed along with the deletion result.

Since:

2.1

See Also:

• Redis Documentation: UNLINK

applyExpiration

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>> applyExpiration(Publisher<ReactiveKeyCommands.ExpireCommand> commands)

Expire a List of field after a given Duration of time, measured in milliseconds, has passed.

Parameters:

commands - must not be null.

Returns:

a Flux emitting the expiration results one by one, true if the timeout was set or false if the timeout was not set; for example, the key doesn't exist, or the operation was skipped because of the provided arguments.

Since:

3.5

See Also:

• Redis Documentation: EXPIRE
• Redis Documentation: PEXPIRE
• Redis Documentation: EXPIREAT
• Redis Documentation: PEXPIREAT
• Redis Documentation: PERSIST

expire

default Mono<Boolean> expire(ByteBuffer key,
 Duration timeout)

Set time to live for given key in seconds.

Parameters:

key - must not be null.

timeout - must not be null.

Returns:

See Also:

• Redis Documentation: EXPIRE

expire

default Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>> expire(Publisher<ReactiveKeyCommands.ExpireCommand> commands)

Expire keys one by one.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key removed along with the expiration result.

See Also:

• Redis Documentation: EXPIRE

pExpire

default Mono<Boolean> pExpire(ByteBuffer key,
 Duration timeout)

Set time to live for given key in milliseconds.

Parameters:

key - must not be null.

timeout - must not be null.

Returns:

See Also:

• Redis Documentation: PEXPIRE

pExpire

default Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireCommand>> pExpire(Publisher<ReactiveKeyCommands.ExpireCommand> commands)

Expire keys one by one.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key removed along with the expiration result.

See Also:

• Redis Documentation: PEXPIRE

expireAt

default Mono<Boolean> expireAt(ByteBuffer key,
 Instant expireAt)

Set the expiration for given key as a UNIX timestamp.

Parameters:

key - must not be null.

expireAt - must not be null.

Returns:

See Also:

• Redis Documentation: EXPIREAT

expireAt

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireAtCommand>> expireAt(Publisher<ReactiveKeyCommands.ExpireAtCommand> commands)

Set one-by-one the expiration for given key as a UNIX timestamp.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key removed along with the expiration result.

See Also:

• Redis Documentation: EXPIREAT

pExpireAt

default Mono<Boolean> pExpireAt(ByteBuffer key,
 Instant expireAt)

Set the expiration for given key as a UNIX timestamp.

Parameters:

key - must not be null.

expireAt - must not be null.

Returns:

See Also:

• Redis Documentation: PEXPIREAT

pExpireAt

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.ExpireAtCommand>> pExpireAt(Publisher<ReactiveKeyCommands.ExpireAtCommand> commands)

Set one-by-one the expiration for given key as a UNIX timestamp in milliseconds.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key removed along with the expiration result.

See Also:

• Redis Documentation: PEXPIREAT

persist

default Mono<Boolean> persist(ByteBuffer key)

Remove the expiration from given key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: PERSIST

persist

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.KeyCommand>> persist(Publisher<ReactiveRedisConnection.KeyCommand> commands)

Remove one-by-one the expiration from given key.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key persisted along with the persist result.

See Also:

• Redis Documentation: PERSIST

ttl

default Mono<Long> ttl(ByteBuffer key)

Get the time to live for key in seconds.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: TTL

ttl

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> ttl(Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get one-by-one the time to live for keys.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the key along with the time to live result.

See Also:

• Redis Documentation: TTL

pTtl

default Mono<Long> pTtl(ByteBuffer key)

Get the time to live for key in milliseconds.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: TTL

pTtl

Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> pTtl(Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get one-by-one the time to live for keys.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.NumericResponse holding the key along with the time to live result.

See Also:

• Redis Documentation: PTTL

move

default Mono<Boolean> move(ByteBuffer key,
 int database)

Move given key to database with index.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: MOVE

move

Flux<ReactiveRedisConnection.BooleanResponse<ReactiveKeyCommands.MoveCommand>> move(Publisher<ReactiveKeyCommands.MoveCommand> commands)

Move keys one-by-one between databases.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the key to move along with the move result.

See Also:

• Redis Documentation: MOVE

encodingOf

Mono<ValueEncoding> encodingOf(ByteBuffer key)

Get the type of internal representation used for storing the value at the given key.

Parameters:

key - must not be null.

Returns:

the Mono emitting ValueEncoding.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

See Also:

• Redis Documentation: OBJECT ENCODING

idletime

Mono<Duration> idletime(ByteBuffer key)

Get the Duration since the object stored at the given key is idle.

Parameters:

key - must not be null.

Returns:

the Mono emitting the idletime of the key of Mono.empty() if the key does not exist.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

See Also:

• Redis Documentation: OBJECT IDLETIME

refcount

Mono<Long> refcount(ByteBuffer key)

Get the number of references of the value associated with the specified key.

Parameters:

key - must not be null.

Returns:

Mono.empty() if key does not exist.

Throws:

IllegalArgumentException - if key is null.

Since:

2.1

See Also:

• Redis Documentation: OBJECT REFCOUNT