K
- Key type.V
- Value type.public interface RedisClusterAsyncCommands<K,V> extends BaseRedisAsyncCommands<K,V>, RedisAclAsyncCommands<K,V>, RedisFunctionAsyncCommands<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>
Modifier and Type | Method and Description |
---|---|
RedisFuture<String> |
asking()
The asking command is required after a
-ASK redirection. |
RedisFuture<String> |
auth(CharSequence password)
Authenticate to the server.
|
RedisFuture<String> |
auth(String username,
CharSequence password)
Authenticate to the server with username and password.
|
RedisFuture<String> |
clusterAddSlots(int... slots)
Adds slots to the cluster node.
|
RedisFuture<String> |
clusterAddSlotsRange(Range<Integer>... ranges)
Takes a list of slot ranges (specified by start and end slots) to assign to the 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> |
clusterDelSlotsRange(Range<Integer>... ranges)
Takes a list of slot ranges (specified by start and end slots) to remove to the node.
|
RedisFuture<String> |
clusterFailover(boolean force)
Failover a cluster node.
|
RedisFuture<String> |
clusterFailover(boolean force,
boolean takeOver)
Failover a cluster node.
|
RedisFuture<String> |
clusterFlushslots()
Delete all the slots associated with the specified node.
|
RedisFuture<String> |
clusterForget(String nodeId)
Disallow connections 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<List<String>> |
clusterReplicas(String nodeId)
List replicas for a certain node identified by its
nodeId . |
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<Object>> |
clusterShards()
Get array of cluster shards
|
RedisFuture<List<String>> |
clusterSlaves(String nodeId)
Deprecated.
since 6.1.7, use
clusterReplicas(String) instead. |
RedisFuture<List<Object>> |
clusterSlots()
Get array of cluster slots to node mappings.
|
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)
Deprecated.
since 6.2. Use the corresponding
StatefulConnection.setTimeout(Duration) method
on the connection interface. To be removed with Lettuce 7.0. |
dispatch, dispatch, echo, flushCommands, isOpen, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, reset, role, setAutoFlushCommands, waitForReplication
aclCat, aclCat, aclDeluser, aclDryRun, aclDryRun, aclGenpass, aclGenpass, aclGetuser, aclList, aclLoad, aclLog, aclLog, aclLogReset, aclSave, aclSetuser, aclUsers, aclWhoami
fcall, fcall, fcallReadOnly, fcallReadOnly, functionDump, functionFlush, functionKill, functionList, functionList, functionLoad, functionLoad, functionRestore, functionRestore
geoadd, geoadd, geoadd, geoadd, geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember, geosearch, geosearch, geosearchstore
hdel, hexists, hget, hgetall, hgetall, hincrby, hincrbyfloat, hkeys, hkeys, hlen, hmget, hmget, hmset, hrandfield, hrandfield, hrandfieldWithvalues, hrandfieldWithvalues, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hset, hset, hsetnx, hstrlen, hvals, hvals
pfadd, pfcount, pfmerge
copy, copy, del, dump, exists, expire, expire, expire, expire, expireat, expireat, expireat, expireat, expireat, expireat, expiretime, keys, keys, migrate, migrate, move, objectEncoding, objectFreq, objectIdletime, objectRefcount, persist, pexpire, pexpire, pexpire, pexpire, pexpireat, pexpireat, pexpireat, pexpireat, pexpireat, pexpireat, pexpiretime, pttl, randomkey, rename, renamenx, restore, restore, scan, scan, scan, scan, scan, scan, scan, scan, sort, sort, sort, sort, sortReadOnly, sortReadOnly, sortReadOnly, sortReadOnly, sortStore, touch, ttl, type, unlink
blmove, blmove, blmpop, blmpop, blpop, blpop, brpop, brpop, brpoplpush, brpoplpush, lindex, linsert, llen, lmove, lmpop, lpop, lpop, lpos, lpos, lpos, lpos, lpush, lpushx, lrange, lrange, lrem, lset, ltrim, rpop, rpop, rpoplpush, rpush, rpushx
digest, digest, eval, eval, eval, eval, evalReadOnly, evalsha, evalsha, evalshaReadOnly, scriptExists, scriptFlush, scriptFlush, scriptKill, scriptLoad, scriptLoad
bgrewriteaof, bgsave, clientCaching, clientGetname, clientGetredir, clientId, clientInfo, clientKill, clientKill, clientList, clientList, clientNoEvict, clientPause, clientSetinfo, clientSetname, clientTracking, clientUnblock, command, commandCount, commandInfo, commandInfo, configGet, configGet, configResetstat, configRewrite, configSet, configSet, dbsize, debugCrashAndRecover, debugHtstats, debugObject, debugOom, debugReload, debugRestart, debugSdslen, debugSegfault, flushall, flushall, flushallAsync, flushdb, flushdb, flushdbAsync, info, info, lastsave, memoryUsage, replicaof, replicaofNoOne, save, shutdown, shutdown, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, time
sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sintercard, sintercard, sinterstore, sismember, smembers, smembers, smismember, smove, spop, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sunion, sunion, sunionstore
bzmpop, bzmpop, bzmpop, bzmpop, bzpopmax, bzpopmax, bzpopmin, bzpopmin, zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zdiff, zdiffstore, zdiffWithScores, zincrby, zinter, zinter, zintercard, zintercard, zinterstore, zinterstore, zinterWithScores, zinterWithScores, zlexcount, zlexcount, zmpop, zmpop, zmscore, zpopmax, zpopmax, zpopmin, zpopmin, zrandmember, zrandmember, zrandmemberWithScores, zrandmemberWithScores, 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, zrangestore, zrangestorebylex, zrangestorebyscore, zrangeWithScores, zrangeWithScores, zrank, zrankWithScore, 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, zrevrangestore, zrevrangestorebylex, zrevrangestorebyscore, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zrevrankWithScore, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunion, zunion, zunionstore, zunionstore, zunionWithScores, zunionWithScores
xack, xadd, xadd, xadd, xadd, xautoclaim, xclaim, xclaim, xdel, xgroupCreate, xgroupCreate, xgroupCreateconsumer, xgroupDelconsumer, xgroupDestroy, xgroupSetid, xinfoConsumers, xinfoGroups, xinfoStream, xlen, xpending, xpending, xpending, xpending, xrange, xrange, xread, xread, xreadgroup, xreadgroup, xrevrange, xrevrange, xtrim, xtrim, xtrim
append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, bitpos, decr, decrby, get, getbit, getdel, getex, getrange, getset, incr, incrby, incrbyfloat, mget, mget, mset, psetex, set, set, setbit, setex, setGet, setGet, setnx, setrange, stralgoLcs, strlen
@Deprecated void setTimeout(Duration timeout)
StatefulConnection.setTimeout(Duration)
method
on the connection interface. To be removed with Lettuce 7.0.timeout
- the timeout valueRedisFuture<String> asking()
-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.RedisFuture<String> auth(CharSequence password)
password
- the passwordRedisFuture<String> auth(String username, CharSequence password)
username
- the usernamepassword
- the passwordRedisFuture<String> clusterAddSlots(int... slots)
slots
- one or more slots from 0 to 16384RedisFuture<String> clusterBumpepoch()
RedisFuture<Long> clusterCountFailureReports(String nodeId)
nodeId
- the node idRedisFuture<Long> clusterCountKeysInSlot(int slot)
slot
.slot
- the slotRedisFuture<String> clusterAddSlotsRange(Range<Integer>... ranges)
ranges
- a list of slot ranges (specified by start and end slots)RedisFuture<String> clusterDelSlots(int... slots)
slots
- one or more slots from 0 to 16384RedisFuture<String> clusterDelSlotsRange(Range<Integer>... ranges)
ranges
- a list of slot ranges (specified by start and end slots)RedisFuture<String> clusterFailover(boolean force)
force
- do not coordinate with master if true
RedisFuture<String> clusterFailover(boolean force, boolean takeOver)
force
- do not coordinate with master if true
takeOver
- do not coordinate with the rest of the cluster if true
force will take precedence over takeOver
if both are set.RedisFuture<String> clusterFlushslots()
RedisFuture<String> clusterForget(String nodeId)
nodeId
- the node IdRedisFuture<List<K>> clusterGetKeysInSlot(int slot, int count)
slot
.slot
- the slotcount
- maximal number of keysRedisFuture<String> clusterInfo()
RedisFuture<Long> clusterKeyslot(K key)
SlotHash.getSlot(byte[])
. If not, call Houston and report that we've got a problem.key
- the key.RedisFuture<String> clusterMeet(String ip, int port)
ip
- IP address of the hostport
- port number.RedisFuture<String> clusterMyId()
RedisFuture<String> clusterNodes()
ClusterPartitionParser.parse(java.util.List<java.lang.Object>)
RedisFuture<String> clusterReplicate(String nodeId)
nodeId
.nodeId
- master node idRedisFuture<List<String>> clusterReplicas(String nodeId)
nodeId
. Can be parsed using
ClusterPartitionParser.parse(java.util.List<java.lang.Object>)
nodeId
- node id of the master nodeclusterNodes()
but one line per replica.RedisFuture<String> clusterReset(boolean hard)
hard
- true
for hard reset. Generates a new nodeId and currentEpoch/configEpoch are set to 0RedisFuture<String> clusterSaveconfig()
OK
or an error if the operation fails.RedisFuture<String> clusterSetConfigEpoch(long configEpoch)
configEpoch
- the config epochOK
or an error if the operation fails.RedisFuture<String> clusterSetSlotImporting(int slot, String nodeId)
nodeId
.slot
- the slotnodeId
- the id of the node is the master of the slotRedisFuture<String> clusterSetSlotMigrating(int slot, String nodeId)
nodeId
. The slot must be handled by
the current node in order to be migrated.slot
- the slotnodeId
- the id of the node is targeted to become the master for the slotRedisFuture<String> clusterSetSlotNode(int slot, String nodeId)
nodeId
slot
- the slotnodeId
- the id of the node that will become the master for the slotRedisFuture<String> clusterSetSlotStable(int slot)
slot
- the slotRedisFuture<List<Object>> clusterShards()
@Deprecated RedisFuture<List<String>> clusterSlaves(String nodeId)
clusterReplicas(String)
instead.nodeId
. Can be parsed using
ClusterPartitionParser.parse(java.util.List<java.lang.Object>)
nodeId
- node id of the master nodeclusterNodes()
but one line per replica.RedisFuture<List<Object>> clusterSlots()
RedisFuture<Boolean> msetnx(Map<K,V> map)
msetnx
in interface RedisStringAsyncCommands<K,V>
map
- the map1
if the all the keys were set. 0
if no key was set (at least one key already existed).RedisFuture<String> readOnly()
readOnly
in interface BaseRedisAsyncCommands<K,V>
RedisFuture<String> readWrite()
readWrite
in interface BaseRedisAsyncCommands<K,V>
Copyright © 2024 lettuce.io. All rights reserved.