Package org.springframework.data.redis.connection

Interface ReactiveClusterCommands

All Known Subinterfaces:

ReactiveRedisClusterConnection

public interface ReactiveClusterCommands

Interface for the cluster commands supported by Redis executed using reactive infrastructure. A RedisClusterNode can be obtained from clusterGetNodes() or it can be constructed using either host and RedisNode.getPort() or the node Id.

Since:

2.3.2

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ReactiveClusterCommands.AddSlots

Method Summary

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

Method Details

clusterGetNodes

Flux<RedisClusterNode> clusterGetNodes()

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

Returns:

a Flux emitting cluster nodes, an empty one if none found.

See Also:

• Redis Documentation: CLUSTER NODES

clusterGetReplicas

Flux<RedisClusterNode> clusterGetReplicas(RedisClusterNode master)

Retrieve information about connected replicas for given master node.

Parameters:

master - must not be null.

Returns:

a Flux emitting cluster nodes, an empty one if none found.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetMasterReplicaMap

Mono<Map<RedisClusterNode,Collection<RedisClusterNode>>> clusterGetMasterReplicaMap()

Retrieve information about masters and their connected replicas.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetSlotForKey

Mono<Integer> clusterGetSlotForKey(ByteBuffer key)

Find the slot for a given key.

Parameters:

key - must not be null.

Returns:

a Mono emitting the calculated slog.

See Also:

• Redis Documentation: CLUSTER KEYSLOT

clusterGetNodeForSlot

Mono<RedisClusterNode> clusterGetNodeForSlot(int slot)

Find the RedisClusterNode serving given slot.

Parameters:

slot -

Returns:

a Mono emitting the RedisClusterNode handling the given slot.

clusterGetNodeForKey

Mono<RedisClusterNode> clusterGetNodeForKey(ByteBuffer key)

Find the RedisClusterNode serving given key.

Parameters:

key - must not be null.

Returns:

a Mono emitting the RedisClusterNode handling the slot for the given key.

clusterGetClusterInfo

Mono<ClusterInfo> clusterGetClusterInfo()

Get cluster information.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER INFO

clusterAddSlots

Mono<Void> clusterAddSlots(RedisClusterNode node,
 int... slots)

Assign slots to given RedisClusterNode.

Parameters:

node - must not be null.

slots - must not be empty.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterAddSlots

Mono<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.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterCountKeysInSlot

Mono<Long> clusterCountKeysInSlot(int slot)

Count the number of keys assigned to one slot.

Parameters:

slot -

Returns:

a Mono emitting the number of keys stored at the given slot.

See Also:

• Redis Documentation: CLUSTER COUNTKEYSINSLOT

clusterDeleteSlots

Mono<Void> clusterDeleteSlots(RedisClusterNode node,
 int... slots)

Remove slots from RedisClusterNode.

Parameters:

node - must not be null.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

Mono<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.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterForget

Mono<Void> clusterForget(RedisClusterNode node)

Remove given node from cluster.

Parameters:

node - must not be null.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER FORGET

clusterMeet

Mono<Void> clusterMeet(RedisClusterNode node)

Add given node to cluster.

Parameters:

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

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER MEET

clusterSetSlot

Mono<Void> clusterSetSlot(RedisClusterNode node,
 int slot,
 ReactiveClusterCommands.AddSlots mode)

Parameters:

node - must not be null.

slot -

mode - must not benull.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER SETSLOT

clusterGetKeysInSlot

Flux<ByteBuffer> clusterGetKeysInSlot(int slot,
 int count)

Get keys served by slot.

Parameters:

slot -

count - must not be null.

Returns:

a Flux emitting the number of requested keys in the given slot, or signalling completion if none found.

See Also:

• Redis Documentation: CLUSTER GETKEYSINSLOT

clusterReplicate

Mono<Void> clusterReplicate(RedisClusterNode master,
 RedisClusterNode replica)

Assign a replica to given master.

Parameters:

master - must not be null.

replica - must not be null.

Returns:

a Mono signaling completion.

See Also:

• Redis Documentation: CLUSTER REPLICATE