K
- Key type.V
- Value type.public interface RedisClusterCommands<K,V> extends BaseRedisCommands<K,V>, RedisGeoCommands<K,V>, RedisHashCommands<K,V>, RedisHLLCommands<K,V>, RedisKeyCommands<K,V>, RedisListCommands<K,V>, RedisScriptingCommands<K,V>, RedisServerCommands<K,V>, RedisSetCommands<K,V>, RedisSortedSetCommands<K,V>, RedisStreamCommands<K,V>, RedisStringCommands<K,V>
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.
|
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 replica 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 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
|
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 replicas 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 replica 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(Duration timeout)
Set the default timeout for operations.
|
void |
setTimeout(long timeout,
TimeUnit unit)
Deprecated.
since 5.0, use
setTimeout(Duration) . |
dispatch, dispatch, echo, isOpen, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, reset, role, waitForReplication
geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember
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
pfadd, pfcount, pfmerge
del, 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
blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpos, lpos, lpos, lpos, lpush, lpushx, lrange, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx
digest, eval, eval, evalsha, evalsha, scriptExists, scriptFlush, scriptKill, scriptLoad
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
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
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
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
append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, bitpos, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mget, mset, msetnx, psetex, set, set, setbit, setex, setnx, setrange, stralgoLcs, strlen
void setTimeout(Duration timeout)
timeout
- the timeout value.@Deprecated void setTimeout(long timeout, TimeUnit unit)
setTimeout(Duration)
.timeout
- the timeout value.unit
- the unit of the timeout value.String auth(String password)
password
- the password.String clusterBumpepoch()
String clusterMeet(String ip, int port)
ip
- IP address of the host.port
- port number.String clusterForget(String nodeId)
nodeId
- the node Id.String clusterAddSlots(int... slots)
slots
- one or more slots from 0 to 16384.String clusterDelSlots(int... slots)
slots
- one or more slots from 0 to 16384.String clusterSetSlotNode(int slot, String nodeId)
nodeId
slot
- the slot.nodeId
- the id of the node that will become the master for the slot.String clusterSetSlotStable(int slot)
slot
- the slot.String clusterSetSlotMigrating(int slot, String nodeId)
nodeId
. The slot must be handled by
the current node in order to be migrated.slot
- the slot.nodeId
- the id of the node is targeted to become the master for the slot.String clusterSetSlotImporting(int slot, String nodeId)
nodeId
.slot
- the slot.nodeId
- the id of the node is the master of the slot.String clusterInfo()
String clusterMyId()
String clusterNodes()
ClusterPartitionParser.parse(java.lang.String)
List<String> clusterSlaves(String nodeId)
nodeId
. Can be parsed using
ClusterPartitionParser.parse(java.lang.String)
nodeId
- node id of the master node.clusterNodes()
but one line per replica.List<K> clusterGetKeysInSlot(int slot, int count)
slot
.slot
- the slot.count
- maximal number of keys.Long clusterCountKeysInSlot(int slot)
slot
.slot
- the slot.Long clusterCountFailureReports(String nodeId)
nodeId
- the node id.Long clusterKeyslot(K key)
SlotHash.getSlot(byte[])
. If not, call Houston and report that we've got a problem.key
- the key.String clusterSaveconfig()
OK
or an error if the operation fails.String clusterSetConfigEpoch(long configEpoch)
configEpoch
- the config epoch.OK
or an error if the operation fails.List<Object> clusterSlots()
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.String clusterReplicate(String nodeId)
nodeId
.nodeId
- master node id.String clusterFailover(boolean force)
force
- do not coordinate with master if true
.String clusterReset(boolean hard)
hard
- true
for hard reset. Generates a new nodeId and currentEpoch/configEpoch are set to 0.String clusterFlushslots()
String readOnly()
readOnly
in interface BaseRedisCommands<K,V>
String readWrite()
readWrite
in interface BaseRedisCommands<K,V>
Copyright © 2020 lettuce.io. All rights reserved.