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

Interface ValkeyClusterCommands

All Known Subinterfaces:

DefaultedValkeyClusterConnection, ValkeyClusterConnection

All Known Implementing Classes:

JedisClusterConnection, LettuceClusterConnection, ValkeyGlideClusterConnection

public interface ValkeyClusterCommands

Interface for the cluster commands supported by Valkey. A ValkeyClusterNode can be obtained from clusterGetNodes() or it can be constructed using either host and ValkeyNode.getPort() or the node Id.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ValkeyClusterCommands.AddSlots

Method Summary

Modifier and Type	Method	Description
void	clusterAddSlots(ValkeyClusterNode node, int... slots)	Assign slots to given ValkeyClusterNode.
void	clusterAddSlots(ValkeyClusterNode node, ValkeyClusterNode.SlotRange range)	Assign ValkeyClusterNode.SlotRange.getSlotsArray() to given ValkeyClusterNode.
Long	clusterCountKeysInSlot(int slot)	Count the number of keys assigned to one slot.
void	clusterDeleteSlots(ValkeyClusterNode node, int... slots)	Remove slots from ValkeyClusterNode.
void	clusterDeleteSlotsInRange(ValkeyClusterNode node, ValkeyClusterNode.SlotRange range)	Removes ValkeyClusterNode.SlotRange.getSlotsArray() from given ValkeyClusterNode.
void	clusterForget(ValkeyClusterNode node)	Remove given node from cluster.
ClusterInfo	clusterGetClusterInfo()	Get cluster information.
List<byte[]>	clusterGetKeysInSlot(int slot, Integer count)	Get keys served by slot.
Map<ValkeyClusterNode,Collection<ValkeyClusterNode>>	clusterGetMasterReplicaMap()	Retrieve information about masters and their connected replicas.
ValkeyClusterNode	clusterGetNodeForKey(byte[] key)	Find the ValkeyClusterNode serving given key.
ValkeyClusterNode	clusterGetNodeForSlot(int slot)	Find the ValkeyClusterNode serving given slot.
Iterable<ValkeyClusterNode>	clusterGetNodes()	Retrieve cluster node information such as id, host, port and slots.
Collection<ValkeyClusterNode>	clusterGetReplicas(ValkeyClusterNode master)	Retrieve information about connected replicas for given master node.
Integer	clusterGetSlotForKey(byte[] key)	Find the slot for a given key.
void	clusterMeet(ValkeyClusterNode node)	Add given node to cluster.
void	clusterReplicate(ValkeyClusterNode master, ValkeyClusterNode replica)	Assign a replica to given master.
void	clusterSetSlot(ValkeyClusterNode node, int slot, ValkeyClusterCommands.AddSlots mode)

Method Details

clusterGetNodes

Iterable<ValkeyClusterNode> clusterGetNodes()

Retrieve cluster node information such as id, host, port and slots.

Returns:

never null.

See Also:

• Valkey Documentation: CLUSTER NODES

clusterGetReplicas

Collection<ValkeyClusterNode> clusterGetReplicas(ValkeyClusterNode master)

Retrieve information about connected replicas for given master node.

Parameters:

master - must not be null.

Returns:

never null.

See Also:

• Valkey Documentation: CLUSTER REPLICAS

clusterGetMasterReplicaMap

Map<ValkeyClusterNode,Collection<ValkeyClusterNode>> clusterGetMasterReplicaMap()

Retrieve information about masters and their connected replicas.

Returns:

never null.

See Also:

• Valkey Documentation: CLUSTER REPLICAS

clusterGetSlotForKey

Integer clusterGetSlotForKey(byte[] key)

Find the slot for a given key.

Parameters:

key - must not be null.

Returns:

See Also:

• Valkey Documentation: CLUSTER KEYSLOT

clusterGetNodeForSlot

ValkeyClusterNode clusterGetNodeForSlot(int slot)

Find the ValkeyClusterNode serving given slot.

Parameters:

slot -

Returns:

clusterGetNodeForKey

ValkeyClusterNode clusterGetNodeForKey(byte[] key)

Find the ValkeyClusterNode serving given key.

Parameters:

key - must not be null.

Returns:

clusterGetClusterInfo

ClusterInfo clusterGetClusterInfo()

Get cluster information.

Returns:

See Also:

• Valkey Documentation: CLUSTER INFO

clusterAddSlots

void clusterAddSlots(ValkeyClusterNode node,
 int... slots)

Assign slots to given ValkeyClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Valkey Documentation: CLUSTER ADDSLOTS

clusterAddSlots

void clusterAddSlots(ValkeyClusterNode node,
 ValkeyClusterNode.SlotRange range)

Assign ValkeyClusterNode.SlotRange.getSlotsArray() to given ValkeyClusterNode.

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Valkey Documentation: CLUSTER ADDSLOTS

clusterCountKeysInSlot

Long clusterCountKeysInSlot(int slot)

Count the number of keys assigned to one slot.

Parameters:

slot -

Returns:

See Also:

• Valkey Documentation: CLUSTER COUNTKEYSINSLOT

clusterDeleteSlots

void clusterDeleteSlots(ValkeyClusterNode node,
 int... slots)

Remove slots from ValkeyClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Valkey Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

void clusterDeleteSlotsInRange(ValkeyClusterNode node,
 ValkeyClusterNode.SlotRange range)

Removes ValkeyClusterNode.SlotRange.getSlotsArray() from given ValkeyClusterNode.

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Valkey Documentation: CLUSTER DELSLOTS

clusterForget

void clusterForget(ValkeyClusterNode node)

Remove given node from cluster.

Parameters:

node - must not be null.

See Also:

• Valkey Documentation: CLUSTER FORGET

clusterMeet

void clusterMeet(ValkeyClusterNode node)

Add given node to cluster.

Parameters:

node - must contain host and ValkeyNode.getPort() and must not be null.

See Also:

• Valkey Documentation: CLUSTER MEET

clusterSetSlot

void clusterSetSlot(ValkeyClusterNode node,
 int slot,
 ValkeyClusterCommands.AddSlots mode)

Parameters:

node - must not be null.

slot -

mode - must not benull.

See Also:

• Valkey Documentation: CLUSTER SETSLOT

clusterGetKeysInSlot

List<byte[]> clusterGetKeysInSlot(int slot,
 Integer count)

Get keys served by slot.

Parameters:

slot -

count - must not be null.

Returns:

See Also:

• Valkey Documentation: CLUSTER GETKEYSINSLOT

clusterReplicate

void clusterReplicate(ValkeyClusterNode master,
 ValkeyClusterNode replica)

Assign a replica to given master.

Parameters:

master - must not be null.

replica - must not be null.

See Also:

• Valkey Documentation: CLUSTER REPLICATE