Package org.springframework.data.redis.connection

Interface ReactiveServerCommands

All Known Subinterfaces:

ReactiveClusterServerCommands

public interface ReactiveServerCommands

Redis Server commands executed using reactive infrastructure.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, Dennis Neufeld

Method Summary

Modifier and Type	Method	Description
Mono<String>	bgReWriteAof()	Start an Append Only File rewrite process on server.
Mono<String>	bgSave()	Start background saving of db on server.
Mono<Long>	dbSize()	Get the total number of available keys in currently selected database.
Mono<String>	flushAll()	Delete all keys from all databases.
Mono<String>	flushAll(RedisServerCommands.FlushOption option)	Delete all keys from all databases using the specified RedisServerCommands.FlushOption.
Mono<String>	flushDb()	Delete all keys of the currently selected database.
Mono<String>	flushDb(RedisServerCommands.FlushOption option)	Delete all keys of the currently selected database using the specified RedisServerCommands.FlushOption.
Flux<RedisClientInfo>	getClientList()	Request information and statistics about connected clients.
Mono<String>	getClientName()	Returns the name of the current connection.
Mono<Properties>	getConfig(String pattern)	Load configuration parameters for given pattern from server.
Mono<Properties>	info()	Load default server information like memory cpu utilization replication
Mono<Properties>	info(String section)	Load server information for given selection.
Mono<String>	killClient(String host, int port)	Closes a given client connection identified by host:port.
Mono<Long>	lastSave()	Get time unix timestamp of last successful bgSave() operation in seconds.
Mono<String>	resetConfigStats()	Reset statistic counters on server.
Mono<String>	save()	Synchronous save current db snapshot on server.
Mono<String>	setClientName(String name)	Assign given name to current connection.
Mono<String>	setConfig(String param, String value)	Set server configuration for param to value.
default Mono<Long>	time()	Request server timestamp using TIME command in TimeUnit.MILLISECONDS.
Mono<Long>	time(TimeUnit timeUnit)	Request server timestamp using TIME command.

Method Details

bgReWriteAof

Mono<String> bgReWriteAof()

Start an Append Only File rewrite process on server.

Returns:

Mono indicating command completion.

See Also:

• Redis Documentation: BGREWRITEAOF

bgSave

Mono<String> bgSave()

Start background saving of db on server.

Returns:

Mono indicating command received by server. Operation success needs to be checked via lastSave().

See Also:

• Redis Documentation: BGSAVE

lastSave

Mono<Long> lastSave()

Get time unix timestamp of last successful bgSave() operation in seconds.

Returns:

Mono wrapping unix timestamp.

See Also:

• Redis Documentation: LASTSAVE

save

Mono<String> save()

Synchronous save current db snapshot on server.

Returns:

Mono indicating command completion.

See Also:

• Redis Documentation: SAVE

dbSize

Mono<Long> dbSize()

Get the total number of available keys in currently selected database.

Returns:

Mono wrapping number of keys.

See Also:

• Redis Documentation: DBSIZE

flushDb

Mono<String> flushDb()

Delete all keys of the currently selected database.

Returns:

Mono indicating command completion.

See Also:

• Redis Documentation: FLUSHDB

flushDb

Mono<String> flushDb(RedisServerCommands.FlushOption option)

Delete all keys of the currently selected database using the specified RedisServerCommands.FlushOption.

Parameters:

option -

Returns:

Mono indicating command completion.

Since:

2.7

See Also:

• Redis Documentation: FLUSHDB

flushAll

Mono<String> flushAll()

Delete all keys from all databases.

Returns:

Mono indicating command completion.

See Also:

• Redis Documentation: FLUSHALL

flushAll

Mono<String> flushAll(RedisServerCommands.FlushOption option)

Delete all keys from all databases using the specified RedisServerCommands.FlushOption.

Parameters:

option -

Returns:

Mono indicating command completion.

Since:

2.7

See Also:

• Redis Documentation: FLUSHALL

info

Mono<Properties> info()

Load default server information like

• memory
• cpu utilization
• replication

Returns:

Mono wrapping server information.

See Also:

• Redis Documentation: INFO

info

Mono<Properties> info(String section)

Load server information for given selection.

Parameters:

section - must not be null nor empty.

Returns:

Mono wrapping server information of given section.

Throws:

IllegalArgumentException - when section is null or empty.

See Also:

• Redis Documentation: INFO

getConfig

Mono<Properties> getConfig(String pattern)

Load configuration parameters for given pattern from server.

Parameters:

pattern - must not be null.

Returns:

Mono wrapping configuration parameters matching given pattern.

Throws:

IllegalArgumentException - when pattern is null or empty.

See Also:

• Redis Documentation: CONFIG GET

setConfig

Mono<String> setConfig(String param,
 String value)

Set server configuration for param to value.

Parameters:

param - must not be null nor empty.

value - must not be null nor empty.

Throws:

IllegalArgumentException - when pattern / value is null or empty.

See Also:

• Redis Documentation: CONFIG SET

resetConfigStats

Mono<String> resetConfigStats()

Reset statistic counters on server.
Counters can be retrieved using info().

Returns:

Mono indicating command completion.

See Also:

• Redis Documentation: CONFIG RESETSTAT

time

default Mono<Long> time()

Request server timestamp using TIME command in TimeUnit.MILLISECONDS.

Returns:

Mono wrapping current server time in milliseconds.

See Also:

• Redis Documentation: TIME

time

Mono<Long> time(TimeUnit timeUnit)

Request server timestamp using TIME command.

Parameters:

timeUnit - target unit.

Returns:

Mono wrapping current server time in TimeUnit.

Since:

2.5

See Also:

• Redis Documentation: TIME

killClient

Mono<String> killClient(String host,
 int port)

Closes a given client connection identified by host:port.

Parameters:

host - of connection to close. Must not be null nor empty.

port - of connection to close

Returns:

Mono wrapping String representation of the command result.

Throws:

IllegalArgumentException - if host is null or empty.

See Also:

• Redis Documentation: CLIENT KILL

setClientName

Mono<String> setClientName(String name)

Assign given name to current connection.

Parameters:

name - must not be null nor empty.

Throws:

IllegalArgumentException - when name is null or empty.

See Also:

• Redis Documentation: CLIENT SETNAME

getClientName

Mono<String> getClientName()

Returns the name of the current connection.

Returns:

Mono wrapping the connection name.

See Also:

• Redis Documentation: CLIENT GETNAME

getClientList

Flux<RedisClientInfo> getClientList()

Request information and statistics about connected clients.

Returns:

Flux emitting RedisClientInfo objects.

See Also:

• Redis Documentation: CLIENT LIST