redis.clients.jedis.executors

Class ClusterCommandExecutor

java.lang.Object

redis.clients.jedis.executors.ClusterCommandExecutor

All Implemented Interfaces:

java.lang.AutoCloseable, CommandExecutor

public class ClusterCommandExecutor
extends java.lang.Object
implements CommandExecutor

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandFlagsRegistry	flags
protected int	maxAttempts
protected java.time.Duration	maxTotalRetriesDuration
ClusterConnectionProvider	provider

Constructor Summary

Constructors

Constructor and Description
ClusterCommandExecutor(ClusterConnectionProvider provider, int maxAttempts, java.time.Duration maxTotalRetriesDuration) Deprecated. use ClusterCommandExecutor(ClusterConnectionProvider, int, Duration, CommandFlagsRegistry) instead. This constructor will be removed in the next major version.
ClusterCommandExecutor(ClusterConnectionProvider provider, int maxAttempts, java.time.Duration maxTotalRetriesDuration, CommandFlagsRegistry flags)

Method Summary

Modifier and Type	Method and Description
<T> T	broadcastCommand(CommandObject<T> commandObject, boolean primaryOnly) Broadcast a command to cluster nodes.
void	close()
protected <T> T	execute(Connection connection, CommandObject<T> commandObject) WARNING: This method is accessible for the purpose of testing.
<T> T	executeCommand(CommandObject<T> commandObject)
<T> T	executeCommandToReplica(CommandObject<T> commandObject)
<T> T	executeMultiShardCommand(java.util.List<CommandObject<T>> commandObjects) Execute multiple command objects across different cluster shards and aggregate the results.
protected void	sleep(long sleepMillis) WARNING: This method is accessible for the purpose of testing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

provider

public final ClusterConnectionProvider provider

maxAttempts

protected final int maxAttempts

maxTotalRetriesDuration

protected final java.time.Duration maxTotalRetriesDuration

flags

protected final CommandFlagsRegistry flags

Constructor Detail

ClusterCommandExecutor

@Deprecated
public ClusterCommandExecutor(ClusterConnectionProvider provider,
                                          int maxAttempts,
                                          java.time.Duration maxTotalRetriesDuration)

Deprecated. use ClusterCommandExecutor(ClusterConnectionProvider, int, Duration, CommandFlagsRegistry) instead. This constructor will be removed in the next major version.

ClusterCommandExecutor

public ClusterCommandExecutor(ClusterConnectionProvider provider,
                              int maxAttempts,
                              java.time.Duration maxTotalRetriesDuration,
                              CommandFlagsRegistry flags)

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

broadcastCommand

public final <T> T broadcastCommand(CommandObject<T> commandObject,
                                    boolean primaryOnly)

Broadcast a command to cluster nodes.

This method uses doExecuteCommand(redis.clients.jedis.CommandObject<T>, redis.clients.jedis.executors.ConnectionResolver, boolean) with a SingleConnectionResolver for each node, which adds retry logic and connection failure handling to broadcast commands. Redirections are not followed since we want to execute on specific nodes.

Error handling depends on the command's response policy:

• ONE_SUCCEEDED: Returns success if at least one node succeeds
• Other policies: Throws JedisBroadcastException if any node fails

Parameters:

commandObject - the command to broadcast

primaryOnly - if true, broadcast only to primary nodes; if false, broadcast to all nodes including replicas

Returns:

the reply from the command

Throws:

JedisBroadcastException - if error handling criteria based on response policy are not met

executeMultiShardCommand

public final <T> T executeMultiShardCommand(java.util.List<CommandObject<T>> commandObjects)

Execute multiple command objects across different cluster shards and aggregate the results.

This method is designed for commands that need to operate on keys distributed across multiple hash slots (e.g., DEL, EXISTS, MGET with keys from different slots). Each CommandObject in the list is executed on its appropriate shard based on the key's hash slot, and the results are aggregated using the command's response policy.

Error handling depends on the command's response policy:

• ONE_SUCCEEDED: Returns success if at least one shard succeeds
• Other policies: Throws JedisBroadcastException if any shard fails

Type Parameters:

T - the return type of the command

Parameters:

commandObjects - list of CommandObject instances, each targeting keys in the same hash slot

Returns:

the aggregated reply from all shards

Throws:

JedisBroadcastException - if error handling criteria based on response policy are not met

executeCommand

public final <T> T executeCommand(CommandObject<T> commandObject)

Specified by:

executeCommand in interface CommandExecutor

executeCommandToReplica

public final <T> T executeCommandToReplica(CommandObject<T> commandObject)

execute

@VisibleForTesting
protected <T> T execute(Connection connection,
                                           CommandObject<T> commandObject)

WARNING: This method is accessible for the purpose of testing. This should not be used or overriden.

sleep

@VisibleForTesting
protected void sleep(long sleepMillis)

WARNING: This method is accessible for the purpose of testing. This should not be used or overriden.