io.lettuce.core.cluster.api.sync

Interface RedisAdvancedClusterCommands<K,V>

All Superinterfaces:

BaseRedisCommands<K,V>, RedisClusterCommands<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>

public interface RedisAdvancedClusterCommands<K,V>
extends RedisClusterCommands<K,V>

Advanced synchronous and thread-safe Redis Cluster API.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
default NodeSelection<K,V>	all() Select all known cluster nodes.
String	clientSetname(K name) Set the current connection name on all known cluster nodes with pipelining.
Long	dbsize() Return the number of keys in the selected database on all cluster masters.
Long	del(K... keys) Delete one or more keys with pipelining.
Long	exists(K... keys) Determine how many keys exist with pipelining.
String	flushall() Remove all keys from all databases on all cluster masters with pipelining.
String	flushdb() Remove all keys from the current database on all cluster masters with pipelining.
RedisClusterCommands<K,V>	getConnection(String nodeId) Retrieve a connection to the specified cluster node using the nodeId.
RedisClusterCommands<K,V>	getConnection(String host, int port) Retrieve a connection to the specified cluster node using host and port.
StatefulRedisClusterConnection<K,V>	getStatefulConnection()
List<K>	keys(K pattern) Find all keys matching the given pattern on all cluster masters.
Long	keys(KeyStreamingChannel<K> channel, K pattern) Find all keys matching the given pattern on all cluster masters.
default NodeSelection<K,V>	masters() Select all masters.
List<KeyValue<K,V>>	mget(K... keys) Get the values of all the given keys with pipelining.
String	mset(Map<K,V> map) Set multiple keys to multiple values with pipelining.
Boolean	msetnx(Map<K,V> map) Set multiple keys to multiple values, only if none of the keys exist with pipelining.
NodeSelection<K,V>	nodes(Predicate<RedisClusterNode> predicate) Select nodes by a predicate and keeps a static selection.
NodeSelection<K,V>	nodes(Predicate<RedisClusterNode> predicate, boolean dynamic) Select nodes by a predicate
V	randomkey() Return a random key from the keyspace on a random master.
NodeSelection<K,V>	readonly(Predicate<RedisClusterNode> predicate) Select slave nodes by a predicate and keeps a static selection.
KeyScanCursor<K>	scan() Incrementally iterate the keys space over the whole Cluster.
StreamScanCursor	scan(KeyStreamingChannel<K> channel) Incrementally iterate the keys space over the whole Cluster.
StreamScanCursor	scan(KeyStreamingChannel<K> channel, ScanArgs scanArgs) Incrementally iterate the keys space over the whole Cluster.
StreamScanCursor	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor) Incrementally iterate the keys space over the whole Cluster.
StreamScanCursor	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate the keys space over the whole Cluster.
KeyScanCursor<K>	scan(ScanArgs scanArgs) Incrementally iterate the keys space over the whole Cluster.
KeyScanCursor<K>	scan(ScanCursor scanCursor) Incrementally iterate the keys space over the whole Cluster.
KeyScanCursor<K>	scan(ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate the keys space over the whole Cluster.
String	scriptFlush() Remove all the scripts from the script cache on all cluster nodes.
String	scriptKill() Kill the script currently in execution on all cluster nodes.
void	shutdown(boolean save) Synchronously save the dataset to disk and then shut down all nodes of the cluster.
default NodeSelection<K,V>	slaves() Select all slaves.
default NodeSelection<K,V>	slaves(Predicate<RedisClusterNode> predicate) Select all slaves.
Long	touch(K... keys) Touch one or more keys with pipelining.
Long	unlink(K... keys) Unlink one or more keys with pipelining.

Methods inherited from interface io.lettuce.core.cluster.api.sync.RedisClusterCommands

asking, auth, clusterAddSlots, clusterBumpepoch, clusterCountFailureReports, clusterCountKeysInSlot, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, clusterGetKeysInSlot, clusterInfo, clusterKeyslot, clusterMeet, clusterMyId, clusterNodes, clusterReplicate, clusterReset, clusterSaveconfig, clusterSetConfigEpoch, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode, clusterSetSlotStable, clusterSlaves, clusterSlots, readOnly, readWrite, setTimeout, setTimeout

Methods inherited from interface io.lettuce.core.api.sync.BaseRedisCommands

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

Methods inherited from interface io.lettuce.core.api.sync.RedisGeoCommands

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

Methods inherited from interface io.lettuce.core.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 io.lettuce.core.api.sync.RedisHLLCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.sync.RedisKeyCommands

dump, expire, expireat, expireat, migrate, migrate, move, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pttl, rename, renamenx, restore, restore, sort, sort, sort, sort, sortStore, ttl, type

Methods inherited from interface io.lettuce.core.api.sync.RedisListCommands

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

Methods inherited from interface io.lettuce.core.api.sync.RedisScriptingCommands

digest, eval, eval, evalsha, evalsha, scriptExists, scriptLoad

Methods inherited from interface io.lettuce.core.api.sync.RedisServerCommands

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

Methods inherited from interface io.lettuce.core.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 io.lettuce.core.api.sync.RedisSortedSetCommands

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.sync.RedisStreamCommands

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

Methods inherited from interface io.lettuce.core.api.sync.RedisStringCommands

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, strlen

Method Detail

getConnection

RedisClusterCommands<K,V> getConnection(String nodeId)

Retrieve a connection to the specified cluster node using the nodeId. Host and port are looked up in the node list. In contrast to the RedisAdvancedClusterCommands, node-connections do not route commands to other cluster nodes

Parameters:

nodeId - the node Id

Returns:

a connection to the requested cluster node

getConnection

RedisClusterCommands<K,V> getConnection(String host,
                                        int port)

Retrieve a connection to the specified cluster node using host and port. In contrast to the RedisAdvancedClusterCommands, node-connections do not route commands to other cluster nodes. Host and port connections are verified by default for cluster membership, see ClusterClientOptions.isValidateClusterNodeMembership().

Parameters:

host - the host

port - the port

Returns:

a connection to the requested cluster node

getStatefulConnection

StatefulRedisClusterConnection<K,V> getStatefulConnection()

Returns:

the underlying connection.

masters

default NodeSelection<K,V> masters()

Select all masters.

Returns:

API with synchronous executed commands on a selection of master cluster nodes.

slaves

default NodeSelection<K,V> slaves()

Select all slaves.

Returns:

API with synchronous executed commands on a selection of slave cluster nodes.

slaves

default NodeSelection<K,V> slaves(Predicate<RedisClusterNode> predicate)

Select all slaves.

Parameters:

predicate - Predicate to filter nodes

Returns:

API with synchronous executed commands on a selection of slave cluster nodes.

all

default NodeSelection<K,V> all()

Select all known cluster nodes.

Returns:

API with synchronous executed commands on a selection of all cluster nodes.

readonly

NodeSelection<K,V> readonly(Predicate<RedisClusterNode> predicate)

Select slave nodes by a predicate and keeps a static selection. Slave connections operate in READONLY mode. The set of nodes within the NodeSelectionSupport does not change when the cluster view changes.

Parameters:

predicate - Predicate to filter nodes

Returns:

API with synchronous executed commands on a selection of cluster nodes matching predicate

nodes

NodeSelection<K,V> nodes(Predicate<RedisClusterNode> predicate)

Select nodes by a predicate and keeps a static selection. The set of nodes within the NodeSelectionSupport does not change when the cluster view changes.

Parameters:

predicate - Predicate to filter nodes

Returns:

API with synchronous executed commands on a selection of cluster nodes matching predicate

nodes

NodeSelection<K,V> nodes(Predicate<RedisClusterNode> predicate,
                         boolean dynamic)

Select nodes by a predicate

Parameters:

predicate - Predicate to filter nodes

dynamic - Defines, whether the set of nodes within the NodeSelectionSupport can change when the cluster view changes.

Returns:

API with synchronous executed commands on a selection of cluster nodes matching predicate

del

Long del(K... keys)

Delete one or more keys with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

del in interface RedisKeyCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyCommands.del(Object[])

unlink

Long unlink(K... keys)

Unlink one or more keys with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

unlink in interface RedisKeyCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyCommands.unlink(Object[])

exists

Long exists(K... keys)

Determine how many keys exist with pipelining. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

exists in interface RedisKeyCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply specifically: Number of existing keys

mget

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 RedisStringCommands<K,V>

Parameters:

keys - the key

Returns:

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

See Also:

RedisStringCommands.mget(Object[])

mset

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 RedisStringCommands<K,V>

Parameters:

map - the map

Returns:

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

See Also:

RedisStringCommands.mset(Map)

msetnx

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 RedisStringCommands<K,V>

Parameters:

map - the null

Returns:

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

See Also:

RedisStringCommands.msetnx(Map)

clientSetname

String clientSetname(K name)

Set the current connection name on all known cluster nodes with pipelining.

Specified by:

clientSetname in interface RedisServerCommands<K,V>

Parameters:

name - the client name

Returns:

simple-string-reply OK if the connection name was successfully set.

See Also:

RedisServerCommands.clientSetname(Object)

flushall

String flushall()

Remove all keys from all databases on all cluster masters with pipelining.

Specified by:

flushall in interface RedisServerCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerCommands.flushall()

flushdb

String flushdb()

Remove all keys from the current database on all cluster masters with pipelining.

Specified by:

flushdb in interface RedisServerCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerCommands.flushdb()

dbsize

Long dbsize()

Return the number of keys in the selected database on all cluster masters.

Specified by:

dbsize in interface RedisServerCommands<K,V>

Returns:

Long integer-reply

See Also:

RedisServerCommands.dbsize()

keys

List<K> keys(K pattern)

Find all keys matching the given pattern on all cluster masters.

Specified by:

keys in interface RedisKeyCommands<K,V>

Parameters:

pattern - the pattern type: patternkey (pattern)

Returns:

List<K> array-reply list of keys matching pattern.

See Also:

RedisKeyCommands.keys(Object)

keys

Long keys(KeyStreamingChannel<K> channel,
          K pattern)

Find all keys matching the given pattern on all cluster masters.

Specified by:

keys in interface RedisKeyCommands<K,V>

Parameters:

channel - the channel

pattern - the pattern

Returns:

Long array-reply list of keys matching pattern.

See Also:

RedisKeyCommands.keys(KeyStreamingChannel, Object)

randomkey

V randomkey()

Return a random key from the keyspace on a random master.

Specified by:

randomkey in interface RedisKeyCommands<K,V>

Returns:

V bulk-string-reply the random key, or null when the database is empty.

See Also:

RedisKeyCommands.randomkey()

scriptFlush

String scriptFlush()

Remove all the scripts from the script cache on all cluster nodes.

Specified by:

scriptFlush in interface RedisScriptingCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisScriptingCommands.scriptFlush()

scriptKill

String scriptKill()

Kill the script currently in execution on all cluster nodes. This call does not fail even if no scripts are running.

Specified by:

scriptKill in interface RedisScriptingCommands<K,V>

Returns:

String simple-string-reply, always OK.

See Also:

RedisScriptingCommands.scriptKill()

shutdown

void shutdown(boolean save)

Synchronously save the dataset to disk and then shut down all nodes of the cluster.

Specified by:

shutdown in interface RedisServerCommands<K,V>

Parameters:

save - true force save operation

See Also:

RedisServerCommands.shutdown(boolean)

scan

KeyScanCursor<K> scan()

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyCommands.scan()

scan

KeyScanCursor<K> scan(ScanArgs scanArgs)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

scanArgs - scan arguments

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyCommands.scan(ScanArgs)

scan

KeyScanCursor<K> scan(ScanCursor scanCursor,
                      ScanArgs scanArgs)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

scanCursor - cursor to resume the scan. It's required to reuse the scanCursor instance from the previous scan() call.

scanArgs - scan arguments

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyCommands.scan(ScanCursor, ScanArgs)

scan

KeyScanCursor<K> scan(ScanCursor scanCursor)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

scanCursor - cursor to resume the scan. It's required to reuse the scanCursor instance from the previous scan() call.

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyCommands.scan(ScanCursor)

scan

StreamScanCursor scan(KeyStreamingChannel<K> channel)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyCommands.scan(KeyStreamingChannel)

scan

StreamScanCursor scan(KeyStreamingChannel<K> channel,
                      ScanArgs scanArgs)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

scanArgs - scan arguments

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyCommands.scan(KeyStreamingChannel, ScanArgs)

scan

StreamScanCursor scan(KeyStreamingChannel<K> channel,
                      ScanCursor scanCursor,
                      ScanArgs scanArgs)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

scanCursor - cursor to resume the scan. It's required to reuse the scanCursor instance from the previous scan() call.

scanArgs - scan arguments

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyCommands.scan(KeyStreamingChannel, ScanCursor, ScanArgs)

scan

StreamScanCursor scan(KeyStreamingChannel<K> channel,
                      ScanCursor scanCursor)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

scanCursor - cursor to resume the scan. It's required to reuse the scanCursor instance from the previous scan() call.

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyCommands.scan(ScanCursor, ScanArgs)

touch

Long touch(K... keys)

Touch one or more keys with pipelining. Touch sets the last accessed time for a key. Non-exsitent keys wont get created. Cross-slot keys will result in multiple calls to the particular cluster nodes.

Specified by:

touch in interface RedisKeyCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply the number of found keys.