Interface RedisServerCommands

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

@NullUnmarked
public interface RedisServerCommands

Server-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Thomas Darimont, Mark Paluch, Dennis Neufeld

See Also:

• RedisCommands

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RedisServerCommands.FlushOption
static enum	RedisServerCommands.MigrateOption
static enum	RedisServerCommands.ShutdownOption

Method Summary

Modifier and Type	Method	Description
void	bgReWriteAof()	Start an Append Only File rewrite process on server.
void	bgSave()	Start background saving of db on server.
Long	dbSize()	Get the total number of available keys in currently selected database.
void	flushAll()	Delete all all keys from all databases.
void	flushAll(@NonNull RedisServerCommands.FlushOption option)	Delete all all keys from all databases using the specified RedisServerCommands.FlushOption.
void	flushDb()	Delete all keys of the currently selected database.
void	flushDb(@NonNull RedisServerCommands.FlushOption option)	Delete all keys of the currently selected database using the specified RedisServerCommands.FlushOption.
List<@NonNull RedisClientInfo>	getClientList()	Request information and statistics about connected clients.
String	getClientName()	Returns the name of the current connection.
Properties	getConfig(@NonNull String pattern)	Load configuration parameters for given pattern from server.
Properties	info()	Load default server information like memory cpu utilization replication
Properties	info(@NonNull String section)	Load server information for given selection.
void	killClient(@NonNull String host, int port)	Closes a given client connection identified by host:port.
Long	lastSave()	Get time of last bgSave() operation in seconds.
void	migrate(byte @NonNull [] key, @NonNull RedisNode target, int dbIndex, @Nullable RedisServerCommands.MigrateOption option)	Atomically transfer a key from a source Redis instance to a destination Redis instance.
void	migrate(byte @NonNull [] key, @NonNull RedisNode target, int dbIndex, @Nullable RedisServerCommands.MigrateOption option, long timeout)	Atomically transfer a key from a source Redis instance to a destination Redis instance.
void	replicaOf(@NonNull String host, int port)	Change redis replication setting to new master.
void	replicaOfNoOne()	Change server into master.
void	resetConfigStats()	Reset statistic counters on server.
void	rewriteConfig()	Rewrites the redis.conf file.
void	save()	Synchronous save current db snapshot on server.
void	setClientName(byte @NonNull [] name)	Assign given name to current connection.
void	setConfig(@NonNull String param, @NonNull String value)	Set server configuration for param to value.
void	shutdown()	Shutdown server.
void	shutdown(@Nullable RedisServerCommands.ShutdownOption option)	Shutdown server.
default Long	time()	Request server timestamp using TIME command in TimeUnit.MILLISECONDS.
Long	time(@NonNull TimeUnit timeUnit)	Request server timestamp using TIME command.

Method Details

bgReWriteAof

void bgReWriteAof()

Start an Append Only File rewrite process on server.

Since:

1.3

See Also:

• Redis Documentation: BGREWRITEAOF

bgSave

void bgSave()

Start background saving of db on server.

See Also:

• Redis Documentation: BGSAVE

lastSave

Long lastSave()

Get time of last bgSave() operation in seconds.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: LASTSAVE

save

void save()

Synchronous save current db snapshot on server.

See Also:

• Redis Documentation: SAVE

dbSize

Long dbSize()

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

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: DBSIZE

flushDb

void flushDb()

Delete all keys of the currently selected database.

See Also:

• Redis Documentation: FLUSHDB

flushDb

void flushDb(@NonNull RedisServerCommands.FlushOption option)

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

Parameters:

option -

Since:

2.7

See Also:

• Redis Documentation: FLUSHDB

flushAll

void flushAll()

Delete all all keys from all databases.

See Also:

• Redis Documentation: FLUSHALL

flushAll

void flushAll(@NonNull RedisServerCommands.FlushOption option)

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

Parameters:

option -

Since:

2.7

See Also:

• Redis Documentation: FLUSHALL

info

Properties info()

Load default server information like

• memory
• cpu utilization
• replication

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: INFO

info

Properties info(@NonNull String section)

Load server information for given selection.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: INFO

shutdown

void shutdown()

Shutdown server.

See Also:

• Redis Documentation: SHUTDOWN

shutdown

void shutdown(@Nullable RedisServerCommands.ShutdownOption option)

Shutdown server.

Parameters:

option - shutdown options if applicable.

Since:

1.3

See Also:

• Redis Documentation: SHUTDOWN

getConfig

Properties getConfig(@NonNull String pattern)

Load configuration parameters for given pattern from server.

Parameters:

pattern - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Redis Documentation: CONFIG GET

setConfig

void setConfig(@NonNull String param,
 @NonNull String value)

Set server configuration for param to value.

Parameters:

param - must not be null.

value - must not be null.

See Also:

• Redis Documentation: CONFIG SET

resetConfigStats

void resetConfigStats()

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

See Also:

• Redis Documentation: CONFIG RESETSTAT

rewriteConfig

void rewriteConfig()

Rewrites the redis.conf file.

Since:

2.5

See Also:

• Redis Documentation: CONFIG REWRITE

time

default Long time()

Request server timestamp using TIME command in TimeUnit.MILLISECONDS.

Returns:

current server time in milliseconds or null when used in pipeline / transaction.

Since:

1.1

See Also:

• Redis Documentation: TIME

time

Long time(@NonNull TimeUnit timeUnit)

Request server timestamp using TIME command.

Parameters:

timeUnit - target unit.

Returns:

current server time in TimeUnit or null when used in pipeline / transaction.

Since:

2.5

See Also:

• Redis Documentation: TIME

killClient

void killClient(@NonNull String host,
 int port)

Closes a given client connection identified by host:port.

Parameters:

host - of connection to close.

port - of connection to close

Since:

1.3

See Also:

• Redis Documentation: CLIENT KILL

setClientName

void setClientName(byte @NonNull [] name)

Assign given name to current connection.

Parameters:

name -

Since:

1.3

See Also:

• Redis Documentation: CLIENT SETNAME

getClientName

String getClientName()

Returns the name of the current connection.

Returns:

null when used in pipeline / transaction.

Since:

1.3

See Also:

• Redis Documentation: CLIENT GETNAME

getClientList

List<@NonNull RedisClientInfo> getClientList()

Request information and statistics about connected clients.

Returns:

List of RedisClientInfo objects or null when used in pipeline / transaction.

Since:

1.3

See Also:

• Redis Documentation: CLIENT LIST

replicaOf

void replicaOf(@NonNull String host,
 int port)

Change redis replication setting to new master.

Parameters:

host - must not be null.

port -

Since:

3.0

See Also:

• Redis Documentation: REPLICAOF

replicaOfNoOne

void replicaOfNoOne()

Change server into master.

Since:

1.3

See Also:

• Redis Documentation: REPLICAOF

migrate

void migrate(byte @NonNull [] key,
 @NonNull RedisNode target,
 int dbIndex,
 @Nullable RedisServerCommands.MigrateOption option)

Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance and is guaranteed to exist in the target instance.

Parameters:

key - must not be null.

target - must not be null.

dbIndex -

option - can be null. Defaulted to RedisServerCommands.MigrateOption.COPY.

Since:

1.7

See Also:

• Redis Documentation: MIGRATE

migrate

void migrate(byte @NonNull [] key,
 @NonNull RedisNode target,
 int dbIndex,
 @Nullable RedisServerCommands.MigrateOption option,
 long timeout)

Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance and is guaranteed to exist in the target instance.

Parameters:

key - must not be null.

target - must not be null.

dbIndex -

option - can be null. Defaulted to RedisServerCommands.MigrateOption.COPY.

timeout -

Since:

1.7

See Also:

• Redis Documentation: MIGRATE