Package io.valkey.springframework.data.valkey.connection

Interface ValkeyServerCommands

All Known Subinterfaces:

DefaultedValkeyClusterConnection, DefaultedValkeyConnection, StringValkeyConnection, ValkeyClusterConnection, ValkeyClusterServerCommands, ValkeyCommands, ValkeyConnection, ValkeyConnectionUtils.ValkeyConnectionProxy

All Known Implementing Classes:

AbstractValkeyConnection, DefaultStringValkeyConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection, ValkeyGlideClusterConnection, ValkeyGlideClusterServerCommands, ValkeyGlideConnection, ValkeyGlideServerCommands

public interface ValkeyServerCommands

Server-specific commands supported by Valkey.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ValkeyServerCommands.FlushOption
static enum	ValkeyServerCommands.MigrateOption
static enum	ValkeyServerCommands.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(ValkeyServerCommands.FlushOption option)	Delete all all keys from all databases using the specified ValkeyServerCommands.FlushOption.
void	flushDb()	Delete all keys of the currently selected database.
void	flushDb(ValkeyServerCommands.FlushOption option)	Delete all keys of the currently selected database using the specified ValkeyServerCommands.FlushOption.
List<ValkeyClientInfo>	getClientList()	Request information and statistics about connected clients.
String	getClientName()	Returns the name of the current connection.
Properties	getConfig(String pattern)	Load configuration parameters for given pattern from server.
Properties	info()	Load default server information like memory cpu utilization replication
Properties	info(String section)	Load server information for given selection.
void	killClient(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[] key, ValkeyNode target, int dbIndex, ValkeyServerCommands.MigrateOption option)	Atomically transfer a key from a source Valkey instance to a destination Valkey instance.
void	migrate(byte[] key, ValkeyNode target, int dbIndex, ValkeyServerCommands.MigrateOption option, long timeout)	Atomically transfer a key from a source Valkey instance to a destination Valkey instance.
void	replicaOf(String host, int port)	Change valkey replication setting to new master.
void	replicaOfNoOne()	Change server into master.
void	resetConfigStats()	Reset statistic counters on server.
void	rewriteConfig()	Rewrites the valkey.conf file.
void	save()	Synchronous save current db snapshot on server.
void	setClientName(byte[] name)	Assign given name to current connection.
void	setConfig(String param, String value)	Set server configuration for param to value.
void	shutdown()	Shutdown server.
void	shutdown(ValkeyServerCommands.ShutdownOption option)	Shutdown server.
default Long	time()	Request server timestamp using TIME command in TimeUnit.MILLISECONDS.
Long	time(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:

• Valkey Documentation: BGREWRITEAOF

bgSave

void bgSave()

Start background saving of db on server.

See Also:

• Valkey Documentation: BGSAVE

lastSave

@Nullable
Long lastSave()

Get time of last bgSave() operation in seconds.

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: LASTSAVE

save

void save()

Synchronous save current db snapshot on server.

See Also:

• Valkey Documentation: SAVE

dbSize

@Nullable
Long dbSize()

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

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: DBSIZE

flushDb

void flushDb()

Delete all keys of the currently selected database.

See Also:

• Valkey Documentation: FLUSHDB

flushDb

void flushDb(ValkeyServerCommands.FlushOption option)

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

Parameters:

option -

Since:

2.7

See Also:

• Valkey Documentation: FLUSHDB

flushAll

void flushAll()

Delete all all keys from all databases.

See Also:

• Valkey Documentation: FLUSHALL

flushAll

void flushAll(ValkeyServerCommands.FlushOption option)

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

Parameters:

option -

Since:

2.7

See Also:

• Valkey Documentation: FLUSHALL

info

@Nullable
Properties info()

Load default server information like

• memory
• cpu utilization
• replication

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: INFO

info

@Nullable
Properties info(String section)

Load server information for given selection.

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: INFO

shutdown

void shutdown()

Shutdown server.

See Also:

• Valkey Documentation: SHUTDOWN

shutdown

void shutdown(ValkeyServerCommands.ShutdownOption option)

Shutdown server.

Since:

1.3

See Also:

• Valkey Documentation: SHUTDOWN

getConfig

@Nullable
Properties getConfig(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:

• Valkey Documentation: CONFIG GET

setConfig

void setConfig(String param,
 String value)

Set server configuration for param to value.

Parameters:

param - must not be null.

value - must not be null.

See Also:

• Valkey Documentation: CONFIG SET

resetConfigStats

void resetConfigStats()

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

See Also:

• Valkey Documentation: CONFIG RESETSTAT

rewriteConfig

void rewriteConfig()

Rewrites the valkey.conf file.

Since:

2.5

See Also:

• Valkey Documentation: CONFIG REWRITE

time

@Nullable
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:

• Valkey Documentation: TIME

time

@Nullable
Long time(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:

• Valkey Documentation: TIME

killClient

void killClient(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:

• Valkey Documentation: CLIENT KILL

setClientName

void setClientName(byte[] name)

Assign given name to current connection.

Parameters:

name -

Since:

1.3

See Also:

• Valkey Documentation: CLIENT SETNAME

getClientName

@Nullable
String getClientName()

Returns the name of the current connection.

Returns:

null when used in pipeline / transaction.

Since:

1.3

See Also:

• Valkey Documentation: CLIENT GETNAME

getClientList

@Nullable
List<ValkeyClientInfo> getClientList()

Request information and statistics about connected clients.

Returns:

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

Since:

1.3

See Also:

• Valkey Documentation: CLIENT LIST

replicaOf

void replicaOf(String host,
 int port)

Change valkey replication setting to new master.

Parameters:

host - must not be null.

port -

Since:

3.0

See Also:

• Valkey Documentation: REPLICAOF

replicaOfNoOne

void replicaOfNoOne()

Change server into master.

Since:

1.3

See Also:

• Valkey Documentation: REPLICAOF

migrate

void migrate(byte[] key,
 ValkeyNode target,
 int dbIndex,
 @Nullable
 ValkeyServerCommands.MigrateOption option)

Atomically transfer a key from a source Valkey instance to a destination Valkey 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 ValkeyServerCommands.MigrateOption.COPY.

Since:

1.7

See Also:

• Valkey Documentation: MIGRATE

migrate

void migrate(byte[] key,
 ValkeyNode target,
 int dbIndex,
 @Nullable
 ValkeyServerCommands.MigrateOption option,
 long timeout)

Atomically transfer a key from a source Valkey instance to a destination Valkey 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 ValkeyServerCommands.MigrateOption.COPY.

timeout -

Since:

1.7

See Also:

• Valkey Documentation: MIGRATE