RedisClusterReactiveCommands (lettuce 4.4.1.Final API)

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, BaseRedisReactiveCommands<K,V>, RedisGeoReactiveCommands<K,V>, RedisHashReactiveCommands<K,V>, RedisHLLReactiveCommands<K,V>, RedisKeyReactiveCommands<K,V>, RedisListReactiveCommands<K,V>, RedisScriptingReactiveCommands<K,V>, RedisServerReactiveCommands<K,V>, RedisSetReactiveCommands<K,V>, RedisSortedSetReactiveCommands<K,V>, RedisStringReactiveCommands<K,V>

All Known Subinterfaces:

RedisAdvancedClusterReactiveCommands<K,V>, RedisClusterPubSubReactiveCommands<K,V>, RedisPubSubReactiveCommands<K,V>, RedisReactiveCommands<K,V>

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl
```
public interface RedisClusterReactiveCommands<K,V>
extends RedisHashReactiveCommands<K,V>, RedisKeyReactiveCommands<K,V>, RedisStringReactiveCommands<K,V>, RedisListReactiveCommands<K,V>, RedisSetReactiveCommands<K,V>, RedisSortedSetReactiveCommands<K,V>, RedisScriptingReactiveCommands<K,V>, RedisServerReactiveCommands<K,V>, RedisHLLReactiveCommands<K,V>, RedisGeoReactiveCommands<K,V>, BaseRedisReactiveCommands<K,V>
```
A complete reactive and thread-safe cluster Redis API with 400+ Methods.

Since:

4.0

Author:

Mark Paluch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`rx.Observable<String>`	`asking()` The asking command is required after a `-ASK` redirection.
`rx.Observable<String>`	`auth(String password)` Authenticate to the server.
`rx.Observable<String>`	`clusterAddSlots(int... slots)` Adds slots to the cluster node.
`rx.Observable<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.
`rx.Observable<Long>`	`clusterCountFailureReports(String nodeId)` Returns the number of failure reports for the specified node.
`rx.Observable<Long>`	`clusterCountKeysInSlot(int slot)` Returns the number of keys in the specified Redis Cluster hash `slot`.
`rx.Observable<String>`	`clusterDelSlots(int... slots)` Removes slots from the cluster node.
`rx.Observable<String>`	`clusterFailover(boolean force)` Failover a cluster node.
`rx.Observable<String>`	`clusterFlushslots()` Delete all the slots associated with the specified node.
`rx.Observable<String>`	`clusterForget(String nodeId)` Blacklist and remove the cluster node from the cluster.
`rx.Observable<K>`	`clusterGetKeysInSlot(int slot, int count)` Retrieve the list of keys within the `slot`.
`rx.Observable<String>`	`clusterInfo()` Get information and statistics about the cluster viewed by the current node.
`rx.Observable<Long>`	`clusterKeyslot(K key)` Returns an integer identifying the hash slot the specified key hashes to.
`rx.Observable<String>`	`clusterMeet(String ip, int port)` Meet another cluster node to include the node into the cluster.
`rx.Observable<String>`	`clusterMyId()` Obtain the nodeId for the currently connected node.
`rx.Observable<String>`	`clusterNodes()` Obtain details about all cluster nodes.
`rx.Observable<String>`	`clusterReplicate(String nodeId)` Turn this node into a slave of the node with the id `nodeId`.
`rx.Observable<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
`rx.Observable<String>`	`clusterSaveconfig()` Forces a node to save the nodes.conf configuration on disk.
`rx.Observable<String>`	`clusterSetConfigEpoch(long configEpoch)` This command sets a specific config epoch in a fresh node.
`rx.Observable<String>`	`clusterSetSlotImporting(int slot, String nodeId)` Flag a slot as IMPORTING (incoming) from the node specified in `nodeId`.
`rx.Observable<String>`	`clusterSetSlotMigrating(int slot, String nodeId)` Flag a slot as MIGRATING (outgoing) towards the node specified in `nodeId`.
`rx.Observable<String>`	`clusterSetSlotNode(int slot, String nodeId)` Assign a slot to a node.
`rx.Observable<String>`	`clusterSetSlotStable(int slot)` Clears migrating / importing state from the slot.
`rx.Observable<String>`	`clusterSlaves(String nodeId)` List slaves for a certain node identified by its `nodeId`.
`rx.Observable<Object>`	`clusterSlots()` Get array of cluster slots to node mappings.
`rx.Observable<Long>`	`del(K... keys)` Delete a key with pipelining.
`rx.Observable<V>`	`mget(K... keys)` Get the values of all the given keys with pipelining.
`rx.Observable<String>`	`mset(Map<K,V> map)` Set multiple keys to multiple values with pipelining.
`rx.Observable<Boolean>`	`msetnx(Map<K,V> map)` Set multiple keys to multiple values, only if none of the keys exist with pipelining.
`rx.Observable<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.
`rx.Observable<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.rx.RedisHashReactiveCommands
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.rx.RedisKeyReactiveCommands
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.rx.RedisStringReactiveCommands
append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, psetex, set, set, setbit, setex, setnx, setrange, strlen

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisListReactiveCommands
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.rx.RedisSetReactiveCommands
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.rx.RedisSortedSetReactiveCommands
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.rx.RedisScriptingReactiveCommands
digest, eval, eval, evalsha, evalsha, scriptExists, scriptFlush, scriptKill, scriptLoad

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisServerReactiveCommands
bgrewriteaof, bgsave, clientGetname, clientKill, clientKill, clientList, clientPause, clientSetname, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, dbsize, debugCrashAndRecover, debugHtstats, debugObject, debugOom, debugReload, debugRestart, debugSdslen, debugSegfault, flushall, flushallAsync, flushdb, flushdbAsync, info, info, lastsave, save, shutdown, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, sync, time

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisHLLReactiveCommands
pfadd, pfcount, pfmerge

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisGeoReactiveCommands
geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember

Methods inherited from interface com.lambdaworks.redis.api.rx.BaseRedisReactiveCommands
close, dispatch, dispatch, echo, isOpen, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, reset, role, waitForReplication

- Method Detail
  - setTimeout
```
void setTimeout(long timeout,
                TimeUnit unit)
```
    Set the default timeout for operations.
    
    Parameters:
    
    timeout - the timeout value
    
    unit - the unit of the timeout value
  - auth
```
rx.Observable<String> auth(String password)
```
    Authenticate to the server.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    String simple-string-reply
  - clusterBumpepoch
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<String> clusterForget(String nodeId)
```
    Blacklist and remove the cluster node from the cluster.
    
    Parameters:
    
    nodeId - the node Id
    
    Returns:
    
    String simple-string-reply
  - clusterAddSlots
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<String> clusterSetSlotStable(int slot)
```
    Clears migrating / importing state from the slot.
    
    Parameters:
    
    slot - the slot
    
    Returns:
    
    String simple-string-reply
  - clusterSetSlotMigrating
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<String> clusterMyId()
```
    Obtain the nodeId for the currently connected node.
    
    Returns:
    
    String simple-string-reply
  - clusterNodes
```
rx.Observable<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
```
rx.Observable<String> clusterSlaves(String nodeId)
```
    List slaves 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 slaves. The command returns data in the same format as clusterNodes() but one line per slave.
  - clusterGetKeysInSlot
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<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
```
rx.Observable<Object> clusterSlots()
```
    Get array of cluster slots to node mappings.
    
    Returns:
    
    List<Object> array-reply nested list of slot ranges with IP/Port mappings.
  - asking
```
rx.Observable<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
```
rx.Observable<String> clusterReplicate(String nodeId)
```
    Turn this node into a slave of the node with the id nodeId.
    
    Parameters:
    
    nodeId - master node id
    
    Returns:
    
    String simple-string-reply
  - clusterFailover
```
rx.Observable<String> clusterFailover(boolean force)
```
    Failover a cluster node. Turns the currently connected node into a master and the master into its slave.
    
    Parameters:
    
    force - do not coordinate with master if true
    
    Returns:
    
    String simple-string-reply
  - clusterReset
```
rx.Observable<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
    Parameters:
    
    hard - true for hard reset. Generates a new nodeId and currentEpoch/configEpoch are set to 0
    
    Returns:
    
    String simple-string-reply
  - clusterFlushslots
```
rx.Observable<String> clusterFlushslots()
```
    Delete all the slots associated with the specified node. The number of deleted slots is returned.
    
    Returns:
    
    String simple-string-reply
  - readOnly
```
rx.Observable<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 BaseRedisReactiveCommands<K,V>
    
    Returns:
    
    String simple-string-reply
  - readWrite
```
rx.Observable<String> readWrite()
```
    Resets readOnly flag.
    
    Specified by:
    
    readWrite in interface BaseRedisReactiveCommands<K,V>
    
    Returns:
    
    String simple-string-reply
  - del
```
rx.Observable<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 RedisKeyReactiveCommands<K,V>
    
    Parameters:
    
    keys - the key
    
    Returns:
    
    Observable<Long> integer-reply The number of keys that were removed.
  - mget
```
rx.Observable<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 RedisStringReactiveCommands<K,V>
    
    Parameters:
    
    keys - the key
    
    Returns:
    
    Observable<List<V>> array-reply list of values at the specified keys.
  - mset
```
rx.Observable<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 RedisStringReactiveCommands<K,V>
    
    Parameters:
    
    map - the null
    
    Returns:
    
    Observable<String> simple-string-reply always OK since MSET can't fail.
  - msetnx
```
rx.Observable<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 RedisStringReactiveCommands<K,V>
    
    Parameters:
    
    map - the null
    
    Returns:
    
    Observable<Boolean> integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed).

Interface RedisClusterReactiveCommands<K,V>

Method Summary

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisHashReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisKeyReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisStringReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisListReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisSetReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisSortedSetReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisScriptingReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisServerReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisHLLReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.RedisGeoReactiveCommands

Methods inherited from interface com.lambdaworks.redis.api.rx.BaseRedisReactiveCommands

Method Detail

setTimeout

auth

clusterBumpepoch

clusterMeet

clusterForget

clusterAddSlots

clusterDelSlots

clusterSetSlotNode

clusterSetSlotStable

clusterSetSlotMigrating

clusterSetSlotImporting

clusterInfo

clusterMyId

clusterNodes

clusterSlaves

clusterGetKeysInSlot

clusterCountKeysInSlot

clusterCountFailureReports

clusterKeyslot

clusterSaveconfig

clusterSetConfigEpoch

clusterSlots

asking

clusterReplicate

clusterFailover

clusterReset

clusterFlushslots

readOnly

readWrite

del

mget

mset

msetnx