Package org.springframework.data.redis.connection

Interface ReactiveClusterServerCommands

All Superinterfaces:

ReactiveServerCommands

public interface ReactiveClusterServerCommands
extends ReactiveServerCommands

Redis Server commands executed in cluster environment using reactive infrastructure.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, Dennis Neufeld

Method Summary

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

Methods inherited from interface org.springframework.data.redis.connection.ReactiveServerCommands

bgReWriteAof, bgSave, dbSize, flushAll, flushAll, flushDb, flushDb, getClientList, getClientName, getConfig, info, info, killClient, lastSave, resetConfigStats, save, setClientName, setConfig, time, time

Method Details

bgReWriteAof

Mono<String> bgReWriteAof(RedisClusterNode node)

Start an Append Only File rewrite process on the specific server.

Parameters:

node - must not be null.

Returns:

Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.bgReWriteAof()

bgSave

Mono<String> bgSave(RedisClusterNode node)

Start background saving of db on server.

Parameters:

node - must not be null.

Returns:

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

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.bgSave()

lastSave

Mono<Long> lastSave(RedisClusterNode node)

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

Parameters:

node - must not be null.

Returns:

Mono wrapping unix timestamp.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.lastSave()

save

Mono<String> save(RedisClusterNode node)

Synchronous save current db snapshot on server.

Parameters:

node - must not be null.

Returns:

Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.save()

dbSize

Mono<Long> dbSize(RedisClusterNode node)

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

Parameters:

node - must not be null.

Returns:

Mono wrapping number of keys.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.dbSize()

flushDb

Mono<String> flushDb(RedisClusterNode node)

Delete all keys of the currently selected database.

Parameters:

node - must not be null. Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.flushDb()

flushDb

Mono<String> flushDb(RedisClusterNode node,
 RedisServerCommands.FlushOption option)

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

Parameters:

node - must not be null. Mono indicating command completion.

option -

Throws:

IllegalArgumentException - when node is null.

Since:

2.7

See Also:

• RedisServerCommands.flushDb(FlushOption)

flushAll

Mono<String> flushAll(RedisClusterNode node)

Delete all all keys from all databases.

Parameters:

node - must not be null.

Returns:

Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.flushAll()

flushAll

Mono<String> flushAll(RedisClusterNode node,
 RedisServerCommands.FlushOption option)

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

Parameters:

node - must not be null.

option -

Returns:

Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

Since:

2.7

See Also:

• RedisServerCommands.flushAll(FlushOption)

info

Mono<Properties> info(RedisClusterNode node)

Load default server information like

• memory
• cpu utilization
• replication

Parameters:

node - must not be null.

Returns:

Mono wrapping server information.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.info()

info

Mono<Properties> info(RedisClusterNode node,
 String section)

Load server information for given selection.

Parameters:

node - must not be null.

section - must not be null nor empty.

Returns:

Mono wrapping server information of given section.

Throws:

IllegalArgumentException - when node is null.

IllegalArgumentException - when section is null or empty.

See Also:

• RedisServerCommands.info(String)

getConfig

Mono<Properties> getConfig(RedisClusterNode node,
 String pattern)

Load configuration parameters for given pattern from server.

Parameters:

node - must not be null.

pattern - must not be null.

Returns:

Mono wrapping configuration parameters matching given pattern.

Throws:

IllegalArgumentException - when node is null.

IllegalArgumentException - when pattern is null or empty.

See Also:

• RedisServerCommands.getConfig(String)

setConfig

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

Set server configuration for param to value.

Parameters:

node - must not be null.

param - must not be null nor empty.

value - must not be null nor empty.

Throws:

IllegalArgumentException - when node is null.

IllegalArgumentException - when pattern / value is null or empty.

See Also:

• RedisServerCommands.setConfig(String, String)

resetConfigStats

Mono<String> resetConfigStats(RedisClusterNode node)

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

Parameters:

node - must not be null.

Returns:

Mono indicating command completion.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.resetConfigStats()

time

Mono<Long> time(RedisClusterNode node)

Request server timestamp using TIME command.

Parameters:

node - must not be null.

Returns:

Mono wrapping current server time in milliseconds.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.time()

getClientList

Flux<RedisClientInfo> getClientList(RedisClusterNode node)

Request information and statistics about connected clients.

Parameters:

node - must not be null.

Returns:

Flux emitting RedisClientInfo objects.

Throws:

IllegalArgumentException - when node is null.

See Also:

• RedisServerCommands.getClientList()