Interface ClusterOperations<K,V>

@NullUnmarked
public interface ClusterOperations<K,V>

Redis operations for cluster specific operations. A RedisClusterNode can be obtained from a connection or it can be constructed using either host and RedisNode.getPort() or the node Id.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch, Dennis Neufeld

Method Summary

Modifier and Type	Method	Description
void	addSlots(@NonNull RedisClusterNode node, int... slots)	Add slots to given node;
void	addSlots(@NonNull RedisClusterNode node, @NonNull RedisClusterNode.SlotRange range)	Add slots in RedisClusterNode.SlotRange to given node.
void	bgReWriteAof(@NonNull RedisClusterNode node)	Start an Append Only File rewrite process on given node.
void	bgSave(@NonNull RedisClusterNode node)	Start background saving of db on given node.
void	flushDb(@NonNull RedisClusterNode node)	Flush db on node.
void	flushDb(@NonNull RedisClusterNode node, @NonNull RedisServerCommands.FlushOption option)	Flush db on node using the specified RedisServerCommands.FlushOption.
void	forget(@NonNull RedisClusterNode node)	Remove the node from the cluster.
Collection<@NonNull RedisClusterNode>	getReplicas(@NonNull RedisClusterNode node)
Set<@NonNull K>	keys(@NonNull RedisClusterNode node, @NonNull K pattern)	Retrieve all keys located at given node matching the given pattern.
void	meet(@NonNull RedisClusterNode node)	Add the node to cluster.
String	ping(@NonNull RedisClusterNode node)	Ping the given node;
K	randomKey(@NonNull RedisClusterNode node)	Get a random key from the range served by the given node.
void	reshard(@NonNull RedisClusterNode source, int slot, @NonNull RedisClusterNode target)	Move slot assignment from one source to target node and copy keys associated with the slot.
void	save(@NonNull RedisClusterNode node)	Synchronous save current db snapshot on server.
void	shutdown(@NonNull RedisClusterNode node)	Shutdown given node.

Method Details

keys

Set<@NonNull K> keys(@NonNull RedisClusterNode node,
 @NonNull K pattern)

Retrieve all keys located at given node matching the given pattern.

IMPORTANT: The KEYS command is non-interruptible and scans the entire keyspace which may cause performance issues.

Parameters:

node - must not be null.

pattern -

Returns:

never null.

See Also:

• DefaultedRedisConnection.keys(byte[])

ping

String ping(@NonNull RedisClusterNode node)

Ping the given node;

Parameters:

node - must not be null.

Returns:

See Also:

• RedisConnectionCommands.ping()

randomKey

K randomKey(@NonNull RedisClusterNode node)

Get a random key from the range served by the given node.

Parameters:

node - must not be null.

Returns:

See Also:

• DefaultedRedisConnection.randomKey()

addSlots

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

Add slots to given node;

Parameters:

node - must not be null.

slots - must not be null.

addSlots

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

Add slots in RedisClusterNode.SlotRange to given node.

Parameters:

node - must not be null.

range - must not be null.

bgReWriteAof

void bgReWriteAof(@NonNull RedisClusterNode node)

Start an Append Only File rewrite process on given node.

Parameters:

node - must not be null.

See Also:

• DefaultedRedisConnection.bgReWriteAof()

bgSave

void bgSave(@NonNull RedisClusterNode node)

Start background saving of db on given node.

Parameters:

node - must not be null.

See Also:

• DefaultedRedisConnection.bgSave()

meet

void meet(@NonNull RedisClusterNode node)

Add the node to cluster.

Parameters:

node - must not be null.

forget

void forget(@NonNull RedisClusterNode node)

Remove the node from the cluster.

Parameters:

node - must not be null.

flushDb

void flushDb(@NonNull RedisClusterNode node)

Flush db on node.

Parameters:

node - must not be null.

See Also:

• DefaultedRedisConnection.flushDb()

flushDb

void flushDb(@NonNull RedisClusterNode node,
 @NonNull RedisServerCommands.FlushOption option)

Flush db on node using the specified RedisServerCommands.FlushOption.

Parameters:

node - must not be null.

option - must not be null.

Since:

2.7

See Also:

• DefaultedRedisConnection.flushDb(FlushOption)

getReplicas

Collection<@NonNull RedisClusterNode> getReplicas(@NonNull RedisClusterNode node)

Parameters:

node - must not be null.

Returns:

save

void save(@NonNull RedisClusterNode node)

Synchronous save current db snapshot on server.

Parameters:

node - must not be null.

See Also:

• DefaultedRedisConnection.save()

shutdown

void shutdown(@NonNull RedisClusterNode node)

Shutdown given node.

Parameters:

node - must not be null.

See Also:

• DefaultedRedisConnection.shutdown()

reshard

void reshard(@NonNull RedisClusterNode source,
 int slot,
 @NonNull RedisClusterNode target)

Move slot assignment from one source to target node and copy keys associated with the slot.

Parameters:

source - must not be null.

slot -

target - must not be null.