io.lettuce.core.cluster.api.async

Interface RedisClusterAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

BaseRedisAsyncCommands<K,V>, RedisGeoAsyncCommands<K,V>, RedisHashAsyncCommands<K,V>, RedisHLLAsyncCommands<K,V>, RedisKeyAsyncCommands<K,V>, RedisListAsyncCommands<K,V>, RedisScriptingAsyncCommands<K,V>, RedisServerAsyncCommands<K,V>, RedisSetAsyncCommands<K,V>, RedisSortedSetAsyncCommands<K,V>, RedisStreamAsyncCommands<K,V>, RedisStringAsyncCommands<K,V>

All Known Subinterfaces:

RedisAdvancedClusterAsyncCommands<K,V>, RedisAsyncCommands<K,V>, RedisClusterPubSubAsyncCommands<K,V>, RedisPubSubAsyncCommands<K,V>

All Known Implementing Classes:

AbstractRedisAsyncCommands, RedisAdvancedClusterAsyncCommandsImpl, RedisAsyncCommandsImpl, RedisClusterPubSubAsyncCommandsImpl, RedisPubSubAsyncCommandsImpl

public interface RedisClusterAsyncCommands<K,V>
extends BaseRedisAsyncCommands<K,V>, RedisGeoAsyncCommands<K,V>, RedisHashAsyncCommands<K,V>, RedisHLLAsyncCommands<K,V>, RedisKeyAsyncCommands<K,V>, RedisListAsyncCommands<K,V>, RedisScriptingAsyncCommands<K,V>, RedisServerAsyncCommands<K,V>, RedisSetAsyncCommands<K,V>, RedisSortedSetAsyncCommands<K,V>, RedisStreamAsyncCommands<K,V>, RedisStringAsyncCommands<K,V>

A complete asynchronous and thread-safe cluster Redis API with 400+ Methods.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
RedisFuture<String>	asking() The asking command is required after a -ASK redirection.
String	auth(String password) Authenticate to the server.
RedisFuture<String>	clusterAddSlots(int... slots) Adds slots to the cluster node.
RedisFuture<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.
RedisFuture<Long>	clusterCountFailureReports(String nodeId) Returns the number of failure reports for the specified node.
RedisFuture<Long>	clusterCountKeysInSlot(int slot) Returns the number of keys in the specified Redis Cluster hash slot.
RedisFuture<String>	clusterDelSlots(int... slots) Removes slots from the cluster node.
RedisFuture<String>	clusterFailover(boolean force) Failover a cluster node.
RedisFuture<String>	clusterFlushslots() Delete all the slots associated with the specified node.
RedisFuture<String>	clusterForget(String nodeId) Blacklist and remove the cluster node from the cluster.
RedisFuture<List<K>>	clusterGetKeysInSlot(int slot, int count) Retrieve the list of keys within the slot.
RedisFuture<String>	clusterInfo() Get information and statistics about the cluster viewed by the current node.
RedisFuture<Long>	clusterKeyslot(K key) Returns an integer identifying the hash slot the specified key hashes to.
RedisFuture<String>	clusterMeet(String ip, int port) Meet another cluster node to include the node into the cluster.
RedisFuture<String>	clusterMyId() Obtain the nodeId for the currently connected node.
RedisFuture<String>	clusterNodes() Obtain details about all cluster nodes.
RedisFuture<String>	clusterReplicate(String nodeId) Turn this node into a replica of the node with the id nodeId.
RedisFuture<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 replica, 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 replica, the whole data set is flushed away
RedisFuture<String>	clusterSaveconfig() Forces a node to save the nodes.conf configuration on disk.
RedisFuture<String>	clusterSetConfigEpoch(long configEpoch) This command sets a specific config epoch in a fresh node.
RedisFuture<String>	clusterSetSlotImporting(int slot, String nodeId) Flag a slot as IMPORTING (incoming) from the node specified in nodeId.
RedisFuture<String>	clusterSetSlotMigrating(int slot, String nodeId) Flag a slot as MIGRATING (outgoing) towards the node specified in nodeId.
RedisFuture<String>	clusterSetSlotNode(int slot, String nodeId) Assign a slot to a node.
RedisFuture<String>	clusterSetSlotStable(int slot) Clears migrating / importing state from the slot.
RedisFuture<List<String>>	clusterSlaves(String nodeId) List replicas for a certain node identified by its nodeId.
RedisFuture<List<Object>>	clusterSlots() Get array of cluster slots to node mappings.
RedisFuture<Long>	del(K... keys) Delete a key with pipelining.
RedisFuture<List<KeyValue<K,V>>>	mget(K... keys) Get the values of all the given keys with pipelining.
RedisFuture<String>	mset(Map<K,V> map) Set multiple keys to multiple values with pipelining.
RedisFuture<Boolean>	msetnx(Map<K,V> map) Set multiple keys to multiple values, only if none of the keys exist with pipelining.
RedisFuture<String>	readOnly() Tells a Redis cluster replica node that the client is ok reading possibly stale data and is not interested in running write queries.
RedisFuture<String>	readWrite() Resets readOnly flag.
void	setTimeout(Duration timeout) Set the default timeout for operations.
void	setTimeout(long timeout, TimeUnit unit) Deprecated. since 5.0, use setTimeout(Duration).

Methods inherited from interface io.lettuce.core.api.async.BaseRedisAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisGeoAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisHashAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisHLLAsyncCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.async.RedisKeyAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisListAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisScriptingAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisServerAsyncCommands

bgrewriteaof, bgsave, clientGetname, clientId, clientKill, clientKill, clientList, clientPause, clientSetname, clientUnblock, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, dbsize, debugCrashAndRecover, debugHtstats, debugObject, debugOom, debugReload, debugRestart, debugSdslen, debugSegfault, flushall, flushallAsync, flushdb, flushdbAsync, info, info, lastsave, memoryUsage, save, shutdown, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, time

Methods inherited from interface io.lettuce.core.api.async.RedisSetAsyncCommands

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 io.lettuce.core.api.async.RedisSortedSetAsyncCommands

bzpopmax, bzpopmin, zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zlexcount, zpopmax, zpopmax, zpopmin, zpopmin, 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 io.lettuce.core.api.async.RedisStreamAsyncCommands

xack, xadd, xadd, xadd, xadd, xclaim, xclaim, xdel, xgroupCreate, xgroupCreate, xgroupDelconsumer, xgroupDestroy, xgroupSetid, xinfoConsumers, xinfoGroups, xinfoStream, xlen, xpending, xpending, xpending, xrange, xrange, xread, xread, xreadgroup, xreadgroup, xrevrange, xrevrange, xtrim, xtrim

Methods inherited from interface io.lettuce.core.api.async.RedisStringAsyncCommands

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

Method Detail

setTimeout

void setTimeout(Duration timeout)

Set the default timeout for operations. A zero timeout value indicates to not time out.

Parameters:

timeout - the timeout value.

Since:

5.0

setTimeout

@Deprecated
void setTimeout(long timeout,
                            TimeUnit unit)

Deprecated. since 5.0, use setTimeout(Duration).

Set the default timeout for operations. A zero timeout value indicates to not time out.

Parameters:

timeout - the timeout value.

unit - the unit of the timeout value.

auth

String auth(String password)

Authenticate to the server.

Parameters:

password - the password.

Returns:

String simple-string-reply.

clusterBumpepoch

RedisFuture<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

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

Parameters:

ip - IP address of the host.

port - port number.

Returns:

String simple-string-reply.

clusterForget

RedisFuture<String> clusterForget(String nodeId)

Blacklist and remove the cluster node from the cluster.

Parameters:

nodeId - the node Id.

Returns:

String simple-string-reply.

clusterAddSlots

RedisFuture<String> clusterAddSlots(int... slots)

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

Parameters:

slots - one or more slots from 0 to 16384.

Returns:

String simple-string-reply.

clusterDelSlots

RedisFuture<String> clusterDelSlots(int... slots)

Removes slots from the cluster node.

Parameters:

slots - one or more slots from 0 to 16384.

Returns:

String simple-string-reply.

clusterSetSlotNode

RedisFuture<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

Parameters:

slot - the slot.

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

Returns:

String simple-string-reply.

clusterSetSlotStable

RedisFuture<String> clusterSetSlotStable(int slot)

Clears migrating / importing state from the slot.

Parameters:

slot - the slot.

Returns:

String simple-string-reply.

clusterSetSlotMigrating

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

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

RedisFuture<String> clusterSetSlotImporting(int slot,
                                            String nodeId)

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

Parameters:

slot - the slot.

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

Returns:

String simple-string-reply.

clusterInfo

RedisFuture<String> clusterInfo()

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

Returns:

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

clusterMyId

RedisFuture<String> clusterMyId()

Obtain the nodeId for the currently connected node.

Returns:

String simple-string-reply.

clusterNodes

RedisFuture<String> clusterNodes()

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

Returns:

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

clusterSlaves

RedisFuture<List<String>> clusterSlaves(String nodeId)

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

Parameters:

nodeId - node id of the master node.

Returns:

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

clusterGetKeysInSlot

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

Retrieve the list of keys within the slot.

Parameters:

slot - the slot.

count - maximal number of keys.

Returns:

List<K> array-reply list of keys.

clusterCountKeysInSlot

RedisFuture<Long> clusterCountKeysInSlot(int slot)

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

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

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

Parameters:

nodeId - the node id.

Returns:

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

clusterKeyslot

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

Parameters:

key - the key.

Returns:

Integer reply: The hash slot number.

clusterSaveconfig

RedisFuture<String> clusterSaveconfig()

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

Returns:

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

clusterSetConfigEpoch

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

Parameters:

configEpoch - the config epoch.

Returns:

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

clusterSlots

RedisFuture<List<Object>> clusterSlots()

Get array of cluster slots to node mappings.

Returns:

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

asking

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

Returns:

String simple-string-reply.

clusterReplicate

RedisFuture<String> clusterReplicate(String nodeId)

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

Parameters:

nodeId - master node id.

Returns:

String simple-string-reply.

clusterFailover

RedisFuture<String> clusterFailover(boolean force)

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

Parameters:

force - do not coordinate with master if true.

Returns:

String simple-string-reply.

clusterReset

RedisFuture<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 replica, 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 replica, the whole data set is flushed away

Parameters:

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

Returns:

String simple-string-reply.

clusterFlushslots

RedisFuture<String> clusterFlushslots()

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

Returns:

String simple-string-reply.

readOnly

RedisFuture<String> readOnly()

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

Specified by:

readOnly in interface BaseRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

readWrite

RedisFuture<String> readWrite()

Resets readOnly flag.

Specified by:

readWrite in interface BaseRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

del

RedisFuture<Long> del(K... keys)

Delete a key with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

del in interface RedisKeyAsyncCommands<K,V>

Parameters:

keys - the key.

Returns:

RedisFuture<Long> integer-reply The number of keys that were removed.

mget

RedisFuture<List<KeyValue<K,V>>> mget(K... keys)

Get the values of all the given keys with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

mget in interface RedisStringAsyncCommands<K,V>

Parameters:

keys - the key.

Returns:

RedisFuture<List<V>> array-reply list of values at the specified keys.

mset

RedisFuture<String> mset(Map<K,V> map)

Set multiple keys to multiple values with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

mset in interface RedisStringAsyncCommands<K,V>

Parameters:

map - the null.

Returns:

RedisFuture<String> simple-string-reply always OK since MSET can't fail.

msetnx

RedisFuture<Boolean> msetnx(Map<K,V> map)

Set multiple keys to multiple values, only if none of the keys exist with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

msetnx in interface RedisStringAsyncCommands<K,V>

Parameters:

map - the null.

Returns:

RedisFuture<Boolean> integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed).