Package org.springframework.data.redis.connection

Interface RedisClusterCommands

All Known Subinterfaces:

DefaultedRedisClusterConnection, RedisClusterConnection

All Known Implementing Classes:

JedisClusterConnection, LettuceClusterConnection

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(RedisClusterNode node, int... slots)	Assign slots to given RedisClusterNode.
void	clusterAddSlots(RedisClusterNode node, 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(RedisClusterNode node, int... slots)	Remove slots from RedisClusterNode.
void	clusterDeleteSlotsInRange(RedisClusterNode node, RedisClusterNode.SlotRange range)	Removes RedisClusterNode.SlotRange.getSlotsArray() from given RedisClusterNode.
void	clusterForget(RedisClusterNode node)	Remove given node from cluster.
ClusterInfo	clusterGetClusterInfo()	Get cluster information.
List<byte[]>	clusterGetKeysInSlot(int slot, Integer count)	Get keys served by slot.
Map<RedisClusterNode,Collection<RedisClusterNode>>	clusterGetMasterReplicaMap()	Retrieve information about masters and their connected replicas.
RedisClusterNode	clusterGetNodeForKey(byte[] key)	Find the RedisClusterNode serving given key.
RedisClusterNode	clusterGetNodeForSlot(int slot)	Find the RedisClusterNode serving given slot.
Iterable<RedisClusterNode>	clusterGetNodes()	Retrieve cluster node information such as id, host, port and slots.
Collection<RedisClusterNode>	clusterGetReplicas(RedisClusterNode master)	Retrieve information about connected replicas for given master node.
Integer	clusterGetSlotForKey(byte[] key)	Find the slot for a given key.
void	clusterMeet(RedisClusterNode node)	Add given node to cluster.
void	clusterReplicate(RedisClusterNode master, RedisClusterNode replica)	Assign a replica to given master.
void	clusterSetSlot(RedisClusterNode node, int slot, RedisClusterCommands.AddSlots mode)

Method Details

clusterGetNodes

Iterable<RedisClusterNode> clusterGetNodes()

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

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER NODES

clusterGetReplicas

Collection<RedisClusterNode> clusterGetReplicas(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<RedisClusterNode,Collection<RedisClusterNode>> clusterGetMasterReplicaMap()

Retrieve information about masters and their connected replicas.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetSlotForKey

Integer clusterGetSlotForKey(byte[] 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[] 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(RedisClusterNode node,
 int... slots)

Assign slots to given RedisClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterAddSlots

void clusterAddSlots(RedisClusterNode node,
 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(RedisClusterNode node,
 int... slots)

Remove slots from RedisClusterNode.

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

void clusterDeleteSlotsInRange(RedisClusterNode node,
 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(RedisClusterNode node)

Remove given node from cluster.

Parameters:

node - must not be null.

See Also:

• Redis Documentation: CLUSTER FORGET

clusterMeet

void clusterMeet(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(RedisClusterNode node,
 int slot,
 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,
 Integer count)

Get keys served by slot.

Parameters:

slot -

count - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER GETKEYSINSLOT

clusterReplicate

void clusterReplicate(RedisClusterNode master,
 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