com.lambdaworks.redis.cluster.api.sync

Interface RedisClusterCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, BaseRedisCommands<K,V>, BaseRedisConnection<K,V>, Closeable, RedisClusterConnection<K,V>, RedisGeoCommands<K,V>, RedisGeoConnection<K,V>, RedisHashCommands<K,V>, RedisHashesConnection<K,V>, RedisHLLCommands<K,V>, RedisHLLConnection<K,V>, RedisKeyCommands<K,V>, RedisKeysConnection<K,V>, RedisListCommands<K,V>, RedisListsConnection<K,V>, RedisScriptingCommands<K,V>, RedisScriptingConnection<K,V>, RedisServerCommands<K,V>, RedisServerConnection<K,V>, RedisSetCommands<K,V>, RedisSetsConnection<K,V>, RedisSortedSetCommands<K,V>, RedisSortedSetsConnection<K,V>, RedisStringCommands<K,V>, RedisStringsConnection<K,V>

All Known Subinterfaces:

RedisAdvancedClusterCommands<K,V>, RedisCommands<K,V>, RedisPubSubCommands<K,V>

public interface RedisClusterCommands<K,V>
extends RedisHashCommands<K,V>, RedisKeyCommands<K,V>, RedisStringCommands<K,V>, RedisListCommands<K,V>, RedisSetCommands<K,V>, RedisSortedSetCommands<K,V>, RedisScriptingCommands<K,V>, RedisServerCommands<K,V>, RedisHLLCommands<K,V>, RedisGeoCommands<K,V>, BaseRedisCommands<K,V>, AutoCloseable, RedisClusterConnection<K,V>

A complete synchronous and thread-safe Redis Cluster API with 400+ Methods.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
String	asking() The asking command is required after a -ASK redirection.
String	auth(String password) Authenticate to the server.
void	close() Close the connection.
String	clusterAddSlots(int... slots) Adds slots to the cluster node.
String	clusterBumpepoch() Generate a new config epoch, incrementing the current epoch, assign the new epoch to this node, WITHOUT any consensus and persist the configuration on disk before sending packets with the new configuration.
Long	clusterCountFailureReports(String nodeId) Returns the number of failure reports for the specified node.
Long	clusterCountKeysInSlot(int slot) Returns the number of keys in the specified Redis Cluster hash slot.
String	clusterDelSlots(int... slots) Removes slots from the cluster node.
String	clusterFailover(boolean force) Failover a cluster node.
String	clusterFlushslots() Delete all the slots associated with the specified node.
String	clusterForget(String nodeId) Blacklist and remove the cluster node from the cluster.
List<K>	clusterGetKeysInSlot(int slot, int count) Retrieve the list of keys within the slot.
String	clusterInfo() Get information and statistics about the cluster viewed by the current node.
Long	clusterKeyslot(K key) Returns an integer identifying the hash slot the specified key hashes to.
String	clusterMeet(String ip, int port) Meet another cluster node to include the node into the cluster.
String	clusterMyId() Obtain the nodeId for the currently connected node.
String	clusterNodes() Obtain details about all cluster nodes.
String	clusterReplicate(String nodeId) Turn this node into a slave of the node with the id nodeId.
String	clusterReset(boolean hard) Reset a node performing a soft or hard reset: All other nodes are forgotten All the assigned / open slots are released If the node is a slave, it turns into a master Only for hard reset: a new Node ID is generated Only for hard reset: currentEpoch and configEpoch are set to 0 The new configuration is saved and the cluster state updated If the node was a slave, the whole data set is flushed away
String	clusterSaveconfig() Forces a node to save the nodes.conf configuration on disk.
String	clusterSetConfigEpoch(long configEpoch) This command sets a specific config epoch in a fresh node.
String	clusterSetSlotImporting(int slot, String nodeId) Flag a slot as IMPORTING (incoming) from the node specified in nodeId.
String	clusterSetSlotMigrating(int slot, String nodeId) Flag a slot as MIGRATING (outgoing) towards the node specified in nodeId.
String	clusterSetSlotNode(int slot, String nodeId) Assign a slot to a node.
String	clusterSetSlotStable(int slot) Clears migrating / importing state from the slot.
List<String>	clusterSlaves(String nodeId) List slaves for a certain node identified by its nodeId.
List<Object>	clusterSlots() Get array of cluster slots to node mappings.
String	readOnly() Tells a Redis cluster slave node that the client is ok reading possibly stale data and is not interested in running write queries.
String	readWrite() Resets readOnly flag.
void	setTimeout(long timeout, TimeUnit unit) Set the default timeout for operations.

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisHashCommands

hdel, hexists, hget, hgetall, hgetall, hincrby, hincrbyfloat, hkeys, hkeys, hlen, hmget, hmget, hmset, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hset, hsetnx, hstrlen, hvals, hvals

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisKeyCommands

del, dump, exists, expire, expireat, expireat, keys, keys, migrate, migrate, move, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pttl, randomkey, rename, renamenx, restore, scan, scan, scan, scan, scan, scan, scan, scan, sort, sort, sort, sort, sortStore, touch, ttl, type, unlink

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisStringCommands

append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mget, mset, msetnx, psetex, set, set, setbit, setex, setnx, setrange, strlen

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisListCommands

blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lpushx, lrange, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx, rpushx

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisSetCommands

sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sinterstore, sismember, smembers, smembers, smove, spop, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sunion, sunion, sunionstore

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisSortedSetCommands

zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zlexcount, zrange, zrange, zrangebylex, zrangebylex, zrangebylex, zrangebylex, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrangeWithScores, zrank, zrem, zremrangebylex, zremrangebylex, zremrangebyrank, zremrangebyscore, zremrangebyscore, zremrangebyscore, zrevrange, zrevrange, zrevrangebylex, zrevrangebylex, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunionstore, zunionstore

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisScriptingCommands

digest, eval, eval, evalsha, evalsha, scriptExists, scriptFlush, scriptKill, scriptLoad

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisHLLCommands

pfadd, pfcount, pfmerge

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisGeoCommands

geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember

Methods inherited from interface com.lambdaworks.redis.api.sync.BaseRedisCommands

dispatch, dispatch, echo, isOpen, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, reset, role, waitForReplication

Methods inherited from interface com.lambdaworks.redis.RedisHashesConnection

hdel, hexists, hget, hgetall, hgetall, hincrby, hincrbyfloat, hkeys, hkeys, hlen, hmget, hmget, hmset, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hset, hsetnx, hstrlen, hvals, hvals

Methods inherited from interface com.lambdaworks.redis.RedisKeysConnection

del, dump, exists, exists, expire, expireat, expireat, keys, keys, migrate, migrate, move, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pttl, randomkey, rename, renamenx, restore, scan, scan, scan, scan, scan, scan, scan, scan, sort, sort, sort, sort, sortStore, touch, ttl, type, unlink

Methods inherited from interface com.lambdaworks.redis.RedisStringsConnection

append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mget, mset, msetnx, psetex, set, set, setbit, setex, setnx, setrange, strlen

Methods inherited from interface com.lambdaworks.redis.RedisListsConnection

blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lpushx, lrange, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx, rpushx

Methods inherited from interface com.lambdaworks.redis.RedisSetsConnection

sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sinterstore, sismember, smembers, smembers, smove, spop, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sunion, sunion, sunionstore

Methods inherited from interface com.lambdaworks.redis.RedisSortedSetsConnection

zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zrange, zrange, zrangebylex, zrangebylex, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrangeWithScores, zrank, zrem, zremrangebylex, zremrangebyrank, zremrangebyscore, zremrangebyscore, zrevrange, zrevrange, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunionstore, zunionstore

Methods inherited from interface com.lambdaworks.redis.RedisScriptingConnection

eval, eval, evalsha, evalsha, scriptExists, scriptFlush, scriptKill, scriptLoad

Methods inherited from interface com.lambdaworks.redis.RedisServerConnection

sync

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisServerCommands

debugCrashAndRecover, debugReload, debugRestart, debugSdslen

Methods inherited from interface com.lambdaworks.redis.RedisHLLConnection

pfadd, pfcount, pfmerge

Methods inherited from interface com.lambdaworks.redis.RedisGeoConnection

geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember

Methods inherited from interface com.lambdaworks.redis.BaseRedisConnection

digest, discard, dispatch, dispatch, echo, exec, isOpen, multi, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, role, unwatch, waitForReplication, watch

Method Detail

setTimeout

void setTimeout(long timeout,
                TimeUnit unit)

Set the default timeout for operations.

Specified by:

setTimeout in interface RedisClusterConnection<K,V>

Parameters:

timeout - the timeout value

unit - the unit of the timeout value

auth

String auth(String password)

Authenticate to the server.

Specified by:

auth in interface RedisClusterConnection<K,V>

Parameters:

password - the password

Returns:

String simple-string-reply

clusterBumpepoch

String clusterBumpepoch()

Generate a new config epoch, incrementing the current epoch, assign the new epoch to this node, WITHOUT any consensus and persist the configuration on disk before sending packets with the new configuration.

Returns:

String simple-string-reply If the new config epoch is generated and assigned either BUMPED (epoch) or STILL (epoch) are returned.

clusterMeet

String clusterMeet(String ip,
                   int port)

Meet another cluster node to include the node into the cluster. The command starts the cluster handshake and returns with OK when the node was added to the cluster.

Specified by:

clusterMeet in interface RedisClusterConnection<K,V>

Parameters:

ip - IP address of the host

port - port number.

Returns:

String simple-string-reply

clusterForget

String clusterForget(String nodeId)

Blacklist and remove the cluster node from the cluster.

Specified by:

clusterForget in interface RedisClusterConnection<K,V>

Parameters:

nodeId - the node Id

Returns:

String simple-string-reply

clusterAddSlots

String clusterAddSlots(int... slots)

Adds slots to the cluster node. The current node will become the master for the specified slots.

Specified by:

clusterAddSlots in interface RedisClusterConnection<K,V>

Parameters:

slots - one or more slots from 0 to 16384

Returns:

String simple-string-reply

clusterDelSlots

String clusterDelSlots(int... slots)

Removes slots from the cluster node.

Specified by:

clusterDelSlots in interface RedisClusterConnection<K,V>

Parameters:

slots - one or more slots from 0 to 16384

Returns:

String simple-string-reply

clusterSetSlotNode

String clusterSetSlotNode(int slot,
                          String nodeId)

Assign a slot to a node. The command migrates the specified slot from the current node to the specified node in nodeId

Specified by:

clusterSetSlotNode in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

nodeId - the id of the node that will become the master for the slot

Returns:

String simple-string-reply

clusterSetSlotStable

String clusterSetSlotStable(int slot)

Clears migrating / importing state from the slot.

Specified by:

clusterSetSlotStable in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

Returns:

String simple-string-reply

clusterSetSlotMigrating

String clusterSetSlotMigrating(int slot,
                               String nodeId)

Flag a slot as MIGRATING (outgoing) towards the node specified in nodeId. The slot must be handled by the current node in order to be migrated.

Specified by:

clusterSetSlotMigrating in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

nodeId - the id of the node is targeted to become the master for the slot

Returns:

String simple-string-reply

clusterSetSlotImporting

String clusterSetSlotImporting(int slot,
                               String nodeId)

Flag a slot as IMPORTING (incoming) from the node specified in nodeId.

Specified by:

clusterSetSlotImporting in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

nodeId - the id of the node is the master of the slot

Returns:

String simple-string-reply

clusterInfo

String clusterInfo()

Get information and statistics about the cluster viewed by the current node.

Specified by:

clusterInfo in interface RedisClusterConnection<K,V>

Returns:

String bulk-string-reply as a collection of text lines.

clusterMyId

String clusterMyId()

Obtain the nodeId for the currently connected node.

Specified by:

clusterMyId in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply

clusterNodes

String clusterNodes()

Obtain details about all cluster nodes. Can be parsed using ClusterPartitionParser.parse(java.lang.String)

Specified by:

clusterNodes in interface RedisClusterConnection<K,V>

Returns:

String bulk-string-reply as a collection of text lines

clusterSlaves

List<String> clusterSlaves(String nodeId)

List slaves for a certain node identified by its nodeId. Can be parsed using ClusterPartitionParser.parse(java.lang.String)

Specified by:

clusterSlaves in interface RedisClusterConnection<K,V>

Parameters:

nodeId - node id of the master node

Returns:

List<String> array-reply list of slaves. The command returns data in the same format as clusterNodes() but one line per slave.

clusterGetKeysInSlot

List<K> clusterGetKeysInSlot(int slot,
                             int count)

Retrieve the list of keys within the slot.

Specified by:

clusterGetKeysInSlot in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

count - maximal number of keys

Returns:

List<K> array-reply list of keys

clusterCountKeysInSlot

Long clusterCountKeysInSlot(int slot)

Returns the number of keys in the specified Redis Cluster hash slot.

Specified by:

clusterCountKeysInSlot in interface RedisClusterConnection<K,V>

Parameters:

slot - the slot

Returns:

Integer reply: The number of keys in the specified hash slot, or an error if the hash slot is invalid.

clusterCountFailureReports

Long clusterCountFailureReports(String nodeId)

Returns the number of failure reports for the specified node. Failure reports are the way Redis Cluster uses in order to promote a PFAIL state, that means a node is not reachable, to a FAIL state, that means that the majority of masters in the cluster agreed within a window of time that the node is not reachable.

Specified by:

clusterCountFailureReports in interface RedisClusterConnection<K,V>

Parameters:

nodeId - the node id

Returns:

Integer reply: The number of active failure reports for the node.

clusterKeyslot

Long clusterKeyslot(K key)

Returns an integer identifying the hash slot the specified key hashes to. This command is mainly useful for debugging and testing, since it exposes via an API the underlying Redis implementation of the hashing algorithm. Basically the same as SlotHash.getSlot(byte[]). If not, call Houston and report that we've got a problem.

Specified by:

clusterKeyslot in interface RedisClusterConnection<K,V>

Parameters:

key - the key.

Returns:

Integer reply: The hash slot number.

clusterSaveconfig

String clusterSaveconfig()

Forces a node to save the nodes.conf configuration on disk.

Specified by:

clusterSaveconfig in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply: OK or an error if the operation fails.

clusterSetConfigEpoch

String clusterSetConfigEpoch(long configEpoch)

This command sets a specific config epoch in a fresh node. It only works when:

• The nodes table of the node is empty.
• The node current config epoch is zero.

Specified by:

clusterSetConfigEpoch in interface RedisClusterConnection<K,V>

Parameters:

configEpoch - the config epoch

Returns:

String simple-string-reply: OK or an error if the operation fails.

clusterSlots

List<Object> clusterSlots()

Get array of cluster slots to node mappings.

Specified by:

clusterSlots in interface RedisClusterConnection<K,V>

Returns:

List<Object> array-reply nested list of slot ranges with IP/Port mappings.

asking

String asking()

The asking command is required after a -ASK redirection. The client should issue ASKING before to actually send the command to the target instance. See the Redis Cluster specification for more information.

Specified by:

asking in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply

clusterReplicate

String clusterReplicate(String nodeId)

Turn this node into a slave of the node with the id nodeId.

Specified by:

clusterReplicate in interface RedisClusterConnection<K,V>

Parameters:

nodeId - master node id

Returns:

String simple-string-reply

clusterFailover

String clusterFailover(boolean force)

Failover a cluster node. Turns the currently connected node into a master and the master into its slave.

Specified by:

clusterFailover in interface RedisClusterConnection<K,V>

Parameters:

force - do not coordinate with master if true

Returns:

String simple-string-reply

clusterReset

String clusterReset(boolean hard)

Reset a node performing a soft or hard reset:

• All other nodes are forgotten
• All the assigned / open slots are released
• If the node is a slave, it turns into a master
• Only for hard reset: a new Node ID is generated
• Only for hard reset: currentEpoch and configEpoch are set to 0
• The new configuration is saved and the cluster state updated
• If the node was a slave, the whole data set is flushed away

Specified by:

clusterReset in interface RedisClusterConnection<K,V>

Parameters:

hard - true for hard reset. Generates a new nodeId and currentEpoch/configEpoch are set to 0

Returns:

String simple-string-reply

clusterFlushslots

String clusterFlushslots()

Delete all the slots associated with the specified node. The number of deleted slots is returned.

Specified by:

clusterFlushslots in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply

readOnly

String readOnly()

Tells a Redis cluster slave node that the client is ok reading possibly stale data and is not interested in running write queries.

Specified by:

readOnly in interface BaseRedisCommands<K,V>

Specified by:

readOnly in interface BaseRedisConnection<K,V>

Specified by:

readOnly in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply

readWrite

String readWrite()

Resets readOnly flag.

Specified by:

readWrite in interface BaseRedisCommands<K,V>

Specified by:

readWrite in interface BaseRedisConnection<K,V>

Specified by:

readWrite in interface RedisClusterConnection<K,V>

Returns:

String simple-string-reply

close

void close()

Close the connection. The connection will become not usable anymore as soon as this method was called.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BaseRedisCommands<K,V>

Specified by:

close in interface BaseRedisConnection<K,V>

Specified by:

close in interface Closeable