Package org.springframework.data.redis.connection

Interface RedisClusterCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, RedisClusterConnection

All Known Implementing Classes:

JedisClusterConnection, LettuceClusterConnection

@NullUnmarked
public interface RedisClusterCommands

Interface for the cluster commands supported by Redis. A RedisClusterNode can be obtained from clusterGetNodes() or it can be constructed using either host and RedisNode.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	RedisClusterCommands.AddSlots

Method Summary

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

Method Details

clusterGetNodes

Iterable<@NonNull RedisClusterNode> clusterGetNodes()

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

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER NODES

clusterGetReplicas

Collection<@NonNull RedisClusterNode> clusterGetReplicas(@NonNull RedisClusterNode master)

Retrieve information about connected replicas for given master node.

Parameters:

master - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetMasterReplicaMap

Map<@NonNull RedisClusterNode,@NonNull Collection<@NonNull RedisClusterNode>> clusterGetMasterReplicaMap()

Retrieve information about masters and their connected replicas.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetSlotForKey

Integer clusterGetSlotForKey(byte @NonNull [] key)

Find the slot for a given key.

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER KEYSLOT

clusterGetNodeForSlot

RedisClusterNode clusterGetNodeForSlot(int slot)

Find the RedisClusterNode serving given slot.

Parameters:

slot -

Returns:

clusterGetNodeForKey

RedisClusterNode clusterGetNodeForKey(byte @NonNull [] key)

Find the RedisClusterNode serving given key.

Parameters:

key - must not be null.

Returns:

clusterGetClusterInfo

ClusterInfo clusterGetClusterInfo()

Get cluster information.

Returns:

See Also:

• Redis Documentation: CLUSTER INFO

clusterAddSlots

void clusterAddSlots(@NonNull RedisClusterNode node,
 int @NonNull ... slots)

Assign slots to given RedisClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterAddSlots

void clusterAddSlots(@NonNull RedisClusterNode node,
 @NonNull RedisClusterNode.SlotRange range)

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

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterCountKeysInSlot

Long clusterCountKeysInSlot(int slot)

Count the number of keys assigned to one slot.

Parameters:

slot -

Returns:

See Also:

• Redis Documentation: CLUSTER COUNTKEYSINSLOT

clusterDeleteSlots

void clusterDeleteSlots(@NonNull RedisClusterNode node,
 int @NonNull ... slots)

Remove slots from RedisClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

void clusterDeleteSlotsInRange(@NonNull RedisClusterNode node,
 @NonNull RedisClusterNode.SlotRange range)

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

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterForget

void clusterForget(@NonNull RedisClusterNode node)

Remove given node from cluster.

Parameters:

node - must not be null.

See Also:

• Redis Documentation: CLUSTER FORGET

clusterMeet

void clusterMeet(@NonNull RedisClusterNode node)

Add given node to cluster.

Parameters:

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

See Also:

• Redis Documentation: CLUSTER MEET

clusterSetSlot

void clusterSetSlot(@NonNull RedisClusterNode node,
 int slot,
 @NonNull RedisClusterCommands.AddSlots mode)

Parameters:

node - must not be null.

slot -

mode - must not benull.

See Also:

• Redis Documentation: CLUSTER SETSLOT

clusterGetKeysInSlot

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

Get keys served by slot.

Parameters:

slot -

count - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER GETKEYSINSLOT

clusterReplicate

void clusterReplicate(@NonNull RedisClusterNode master,
 @NonNull RedisClusterNode replica)

Assign a replica to given master.

Parameters:

master - must not be null.

replica - must not be null.

See Also:

• Redis Documentation: CLUSTER REPLICATE