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

Class ValkeyGlideClusterServerCommands

java.lang.Object

io.valkey.springframework.data.valkey.connection.valkeyglide.ValkeyGlideClusterServerCommands

All Implemented Interfaces:

ValkeyClusterServerCommands, ValkeyServerCommands

public class ValkeyGlideClusterServerCommands
extends Object
implements ValkeyClusterServerCommands

Implementation of ValkeyClusterServerCommands for Valkey-Glide. Uses the elegant execute(Route, ...) pattern for cluster command routing.

Since:

2.0

Author:

Ilia Kolominsky

Nested Class Summary

Nested classes/interfaces inherited from interface io.valkey.springframework.data.valkey.connection.ValkeyServerCommands

ValkeyServerCommands.FlushOption, ValkeyServerCommands.MigrateOption, ValkeyServerCommands.ShutdownOption

Constructor Summary

Constructors

Constructor	Description
ValkeyGlideClusterServerCommands(ValkeyGlideClusterConnection connection)	Create a new ValkeyGlideClusterServerCommands.

Method Summary

Modifier and Type	Method	Description
void	bgReWriteAof()	Start an Append Only File rewrite process on server.
void	bgReWriteAof(ValkeyClusterNode node)
void	bgSave()	Start background saving of db on server.
void	bgSave(ValkeyClusterNode node)
Long	dbSize()	Get the total number of available keys in currently selected database.
Long	dbSize(ValkeyClusterNode node)
void	flushAll()	Delete all all keys from all databases.
void	flushAll(ValkeyClusterNode node)
void	flushAll(ValkeyClusterNode node, ValkeyServerCommands.FlushOption option)
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(ValkeyClusterNode node)
void	flushDb(ValkeyClusterNode node, ValkeyServerCommands.FlushOption option)
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.
List<ValkeyClientInfo>	getClientList(ValkeyClusterNode node)
String	getClientName()	Returns the name of the current connection.
Properties	getConfig(ValkeyClusterNode node, String pattern)
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(ValkeyClusterNode node)
Properties	info(ValkeyClusterNode node, String section)
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 ValkeyServerCommands.bgSave() operation in seconds.
Long	lastSave(ValkeyClusterNode node)
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	resetConfigStats(ValkeyClusterNode node)
void	rewriteConfig()	Rewrites the valkey.conf file.
void	rewriteConfig(ValkeyClusterNode node)
void	save()	Synchronous save current db snapshot on server.
void	save(ValkeyClusterNode node)
void	setClientName(byte[] name)	Assign given name to current connection.
void	setConfig(ValkeyClusterNode node, String param, String value)
void	setConfig(String param, String value)	Set server configuration for param to value.
void	shutdown()	Shutdown server.
void	shutdown(ValkeyClusterNode node)
void	shutdown(ValkeyServerCommands.ShutdownOption option)	Shutdown server.
Long	time(ValkeyClusterNode node, TimeUnit timeUnit)
Long	time(TimeUnit timeUnit)	Request server timestamp using TIME command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.valkey.springframework.data.valkey.connection.ValkeyClusterServerCommands

time

Methods inherited from interface io.valkey.springframework.data.valkey.connection.ValkeyServerCommands

time

Constructor Details

ValkeyGlideClusterServerCommands

public ValkeyGlideClusterServerCommands(ValkeyGlideClusterConnection connection)

Create a new ValkeyGlideClusterServerCommands.

Parameters:

connection - must not be null.

Method Details

bgReWriteAof

public void bgReWriteAof()

Description copied from interface: ValkeyServerCommands

Start an Append Only File rewrite process on server.

Specified by:

bgReWriteAof in interface ValkeyServerCommands

See Also:

• Valkey Documentation: BGREWRITEAOF

bgSave

public void bgSave()

Description copied from interface: ValkeyServerCommands

Start background saving of db on server.

Specified by:

bgSave in interface ValkeyServerCommands

See Also:

• Valkey Documentation: BGSAVE

lastSave

public Long lastSave()

Description copied from interface: ValkeyServerCommands

Get time of last ValkeyServerCommands.bgSave() operation in seconds.

Specified by:

lastSave in interface ValkeyServerCommands

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: LASTSAVE

save

public void save()

Description copied from interface: ValkeyServerCommands

Synchronous save current db snapshot on server.

Specified by:

save in interface ValkeyServerCommands

See Also:

• Valkey Documentation: SAVE

dbSize

public Long dbSize()

Description copied from interface: ValkeyServerCommands

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

Specified by:

dbSize in interface ValkeyServerCommands

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: DBSIZE

flushDb

public void flushDb()

Description copied from interface: ValkeyServerCommands

Delete all keys of the currently selected database.

Specified by:

flushDb in interface ValkeyServerCommands

See Also:

• Valkey Documentation: FLUSHDB

flushDb

public void flushDb(ValkeyServerCommands.FlushOption option)

Description copied from interface: ValkeyServerCommands

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

Specified by:

flushDb in interface ValkeyServerCommands

See Also:

• Valkey Documentation: FLUSHDB

flushAll

public void flushAll()

Description copied from interface: ValkeyServerCommands

Delete all all keys from all databases.

Specified by:

flushAll in interface ValkeyServerCommands

See Also:

• Valkey Documentation: FLUSHALL

flushAll

public void flushAll(ValkeyServerCommands.FlushOption option)

Description copied from interface: ValkeyServerCommands

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

Specified by:

flushAll in interface ValkeyServerCommands

See Also:

• Valkey Documentation: FLUSHALL

info

public Properties info()

Description copied from interface: ValkeyServerCommands

Load default server information like

• memory
• cpu utilization
• replication

Specified by:

info in interface ValkeyServerCommands

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: INFO

info

public Properties info(String section)

Description copied from interface: ValkeyServerCommands

Load server information for given selection.

Specified by:

info in interface ValkeyServerCommands

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: INFO

shutdown

public void shutdown()

Description copied from interface: ValkeyServerCommands

Shutdown server.

Specified by:

shutdown in interface ValkeyServerCommands

See Also:

• Valkey Documentation: SHUTDOWN

shutdown

public void shutdown(ValkeyServerCommands.ShutdownOption option)

Description copied from interface: ValkeyServerCommands

Shutdown server.

Specified by:

shutdown in interface ValkeyServerCommands

See Also:

• Valkey Documentation: SHUTDOWN

getConfig

public Properties getConfig(String pattern)

Description copied from interface: ValkeyServerCommands

Load configuration parameters for given pattern from server.

Specified by:

getConfig in interface ValkeyServerCommands

Parameters:

pattern - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: CONFIG GET

setConfig

public void setConfig(String param,
 String value)

Description copied from interface: ValkeyServerCommands

Set server configuration for param to value.

Specified by:

setConfig in interface ValkeyServerCommands

Parameters:

param - must not be null.

value - must not be null.

See Also:

• Valkey Documentation: CONFIG SET

resetConfigStats

public void resetConfigStats()

Description copied from interface: ValkeyServerCommands

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

Specified by:

resetConfigStats in interface ValkeyServerCommands

See Also:

• Valkey Documentation: CONFIG RESETSTAT

rewriteConfig

public void rewriteConfig()

Description copied from interface: ValkeyServerCommands

Rewrites the valkey.conf file.

Specified by:

rewriteConfig in interface ValkeyServerCommands

See Also:

• Valkey Documentation: CONFIG REWRITE

time

public Long time(TimeUnit timeUnit)

Description copied from interface: ValkeyServerCommands

Request server timestamp using TIME command.

Specified by:

time in interface ValkeyServerCommands

Parameters:

timeUnit - target unit.

Returns:

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

See Also:

• Valkey Documentation: TIME

getClientList

public List<ValkeyClientInfo> getClientList()

Description copied from interface: ValkeyServerCommands

Request information and statistics about connected clients.

Specified by:

getClientList in interface ValkeyServerCommands

Returns:

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

See Also:

• Valkey Documentation: CLIENT LIST

killClient

public void killClient(String host,
 int port)

Description copied from interface: ValkeyServerCommands

Closes a given client connection identified by host:port.

Specified by:

killClient in interface ValkeyServerCommands

Parameters:

host - of connection to close.

port - of connection to close

See Also:

• Valkey Documentation: CLIENT KILL

bgReWriteAof

public void bgReWriteAof(ValkeyClusterNode node)

Specified by:

bgReWriteAof in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.bgReWriteAof()

bgSave

public void bgSave(ValkeyClusterNode node)

Specified by:

bgSave in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.bgSave()

lastSave

public Long lastSave(ValkeyClusterNode node)

Specified by:

lastSave in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.lastSave()

save

public void save(ValkeyClusterNode node)

Specified by:

save in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.save()

dbSize

public Long dbSize(ValkeyClusterNode node)

Specified by:

dbSize in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.dbSize()

flushDb

public void flushDb(ValkeyClusterNode node)

Specified by:

flushDb in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.flushDb()

flushDb

public void flushDb(ValkeyClusterNode node,
 ValkeyServerCommands.FlushOption option)

Specified by:

flushDb in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.flushDb(FlushOption)

flushAll

public void flushAll(ValkeyClusterNode node)

Specified by:

flushAll in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.flushAll()

flushAll

public void flushAll(ValkeyClusterNode node,
 ValkeyServerCommands.FlushOption option)

Specified by:

flushAll in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.flushAll(FlushOption)

info

public Properties info(ValkeyClusterNode node)

Specified by:

info in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.info()

info

public Properties info(ValkeyClusterNode node,
 String section)

Specified by:

info in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.info(String)

shutdown

public void shutdown(ValkeyClusterNode node)

Specified by:

shutdown in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.shutdown()

getConfig

public Properties getConfig(ValkeyClusterNode node,
 String pattern)

Specified by:

getConfig in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.getConfig(String)

setConfig

public void setConfig(ValkeyClusterNode node,
 String param,
 String value)

Specified by:

setConfig in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.setConfig(String, String)

resetConfigStats

public void resetConfigStats(ValkeyClusterNode node)

Specified by:

resetConfigStats in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.resetConfigStats()

rewriteConfig

public void rewriteConfig(ValkeyClusterNode node)

Specified by:

rewriteConfig in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

See Also:

• ValkeyServerCommands.rewriteConfig()

time

public Long time(ValkeyClusterNode node,
 TimeUnit timeUnit)

Specified by:

time in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

timeUnit - must not be null.

Returns:

See Also:

• ValkeyServerCommands.time(TimeUnit)

getClientList

public List<ValkeyClientInfo> getClientList(ValkeyClusterNode node)

Specified by:

getClientList in interface ValkeyClusterServerCommands

Parameters:

node - must not be null.

Returns:

See Also:

• ValkeyServerCommands.getClientList()

setClientName

public void setClientName(byte[] name)

Description copied from interface: ValkeyServerCommands

Assign given name to current connection.

Specified by:

setClientName in interface ValkeyServerCommands

See Also:

• Valkey Documentation: CLIENT SETNAME

getClientName

public String getClientName()

Description copied from interface: ValkeyServerCommands

Returns the name of the current connection.

Specified by:

getClientName in interface ValkeyServerCommands

Returns:

null when used in pipeline / transaction.

See Also:

• Valkey Documentation: CLIENT GETNAME

replicaOf

public void replicaOf(String host,
 int port)

Description copied from interface: ValkeyServerCommands

Change valkey replication setting to new master.

Specified by:

replicaOf in interface ValkeyServerCommands

Parameters:

host - must not be null.

See Also:

• Valkey Documentation: REPLICAOF

replicaOfNoOne

public void replicaOfNoOne()

Description copied from interface: ValkeyServerCommands

Change server into master.

Specified by:

replicaOfNoOne in interface ValkeyServerCommands

See Also:

• Valkey Documentation: REPLICAOF

migrate

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

Description copied from interface: ValkeyServerCommands

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.

Specified by:

migrate in interface ValkeyServerCommands

Parameters:

key - must not be null.

target - must not be null.

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

See Also:

• Valkey Documentation: MIGRATE

migrate

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

Description copied from interface: ValkeyServerCommands

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.

Specified by:

migrate in interface ValkeyServerCommands

Parameters:

key - must not be null.

target - must not be null.

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

See Also:

• Valkey Documentation: MIGRATE