Module lettuce.core

Package io.lettuce.core.cluster.api.reactive

Interface RedisAdvancedClusterReactiveCommands<K,V>

All Superinterfaces:

BaseRedisReactiveCommands<K,V>, RedisAclReactiveCommands<K,V>, RedisClusterReactiveCommands<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>, RedisStreamReactiveCommands<K,V>, RedisStringReactiveCommands<K,V>

All Known Implementing Classes:

RedisAdvancedClusterReactiveCommandsImpl

public interface RedisAdvancedClusterReactiveCommands<K,V>
extends RedisClusterReactiveCommands<K,V>

Advanced reactive and thread-safe Redis Cluster API.

Since:

5.0

Author:

Mark Paluch, Jon Chambers

Method Summary

Modifier and Type	Method	Description
Mono<String>	clientSetname(K name)	Set the current connection name on all cluster nodes with pipelining.
Mono<Long>	dbsize()	Return the number of keys in the selected database on all cluster masters.
Mono<Long>	del(K... keys)	Delete one or more keys with pipelining.
Mono<Long>	exists(K... keys)	Determine how many keys exist with pipelining.
Mono<String>	flushall()	Remove all keys from all databases on all cluster masters with pipelining.
Mono<String>	flushallAsync()	Remove all keys asynchronously from all databases on all cluster upstream nodes with pipelining.
Mono<String>	flushdb()	Remove all keys from the current database on all cluster masters with pipelining.
RedisClusterReactiveCommands<K,V>	getConnection(String nodeId)	Retrieve a connection to the specified cluster node using the nodeId.
RedisClusterReactiveCommands<K,V>	getConnection(String host, int port)	Retrieve a connection to the specified cluster node using host and port.
StatefulRedisClusterConnection<K,V>	getStatefulConnection()
Mono<Long>	keys(KeyStreamingChannel<K> channel, K pattern)	Find all keys matching the given pattern on all cluster masters.
Flux<K>	keys(K pattern)	Find all keys matching the given pattern on all cluster masters.
Flux<KeyValue<K,V>>	mget(K... keys)	Get the values of all the given keys with pipelining.
Mono<String>	mset(Map<K,V> map)	Set multiple keys to multiple values with pipelining.
Mono<Boolean>	msetnx(Map<K,V> map)	Set multiple keys to multiple values, only if none of the keys exist with pipelining.
Mono<K>	randomkey()	Return a random key from the keyspace on a random master.
Mono<KeyScanCursor<K>>	scan()	Incrementally iterate the keys space over the whole Cluster.
Mono<StreamScanCursor>	scan(KeyStreamingChannel<K> channel)	Incrementally iterate the keys space over the whole Cluster.
Mono<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanArgs scanArgs)	Incrementally iterate the keys space over the whole Cluster.
Mono<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor)	Incrementally iterate the keys space over the whole Cluster.
Mono<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor, ScanArgs scanArgs)	Incrementally iterate the keys space over the whole Cluster.
Mono<KeyScanCursor<K>>	scan(ScanArgs scanArgs)	Incrementally iterate the keys space over the whole Cluster.
Mono<KeyScanCursor<K>>	scan(ScanCursor scanCursor)	Incrementally iterate the keys space over the whole Cluster.
Mono<KeyScanCursor<K>>	scan(ScanCursor scanCursor, ScanArgs scanArgs)	Incrementally iterate the keys space over the whole Cluster.
Mono<String>	scriptFlush()	Remove all the scripts from the script cache on all cluster nodes.
Mono<String>	scriptKill()	Kill the script currently in execution on all cluster nodes.
Mono<String>	scriptLoad(byte[] script)	Load the specified Lua script into the script cache on all cluster nodes.
Mono<String>	scriptLoad(String script)	Load the specified Lua script into the script cache on all cluster nodes.
Mono<Void>	shutdown(boolean save)	Synchronously save the dataset to disk and then shut down all nodes of the cluster.
Mono<Long>	touch(K... keys)	Touch one or more keys with pipelining.
Mono<Long>	unlink(K... keys)	Unlink one or more keys with pipelining.

Methods inherited from interface io.lettuce.core.api.reactive.BaseRedisReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisAclReactiveCommands

aclCat, aclCat, aclDeluser, aclGenpass, aclGenpass, aclGetuser, aclList, aclLoad, aclLog, aclLog, aclLogReset, aclSave, aclSetuser, aclUsers, aclWhoami

Methods inherited from interface io.lettuce.core.cluster.api.reactive.RedisClusterReactiveCommands

asking, auth, 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

Methods inherited from interface io.lettuce.core.api.reactive.RedisGeoReactiveCommands

geoadd, geoadd, geoadd, geoadd, geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember, geosearch, geosearch, geosearchstore

Methods inherited from interface io.lettuce.core.api.reactive.RedisHashReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisHLLReactiveCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.reactive.RedisKeyReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisListReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisScriptingReactiveCommands

digest, digest, eval, eval, eval, eval, evalsha, evalsha, scriptExists, scriptFlush

Methods inherited from interface io.lettuce.core.api.reactive.RedisServerReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisSetReactiveCommands

sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sinterstore, sismember, smembers, smembers, smismember, 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.reactive.RedisSortedSetReactiveCommands

bzpopmax, bzpopmax, bzpopmin, bzpopmin, zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zdiff, zdiffstore, zdiffWithScores, zincrby, zinter, zinter, zinterstore, zinterstore, zinterWithScores, zinterWithScores, zlexcount, zlexcount, 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, zrangestorebylex, zrangestorebyscore, 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, zrevrangestorebylex, zrevrangestorebyscore, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunion, zunion, zunionstore, zunionstore, zunionWithScores, zunionWithScores

Methods inherited from interface io.lettuce.core.api.reactive.RedisStreamReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisStringReactiveCommands

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

Method Details

getConnection

RedisClusterReactiveCommands<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 RedisAdvancedClusterReactiveCommands, node-connections do not route commands to other cluster nodes

Parameters:

nodeId - the node Id

Returns:

a connection to the requested cluster node

getConnection

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

Retrieve a connection to the specified cluster node using host and port. In contrast to the RedisAdvancedClusterReactiveCommands, 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.

del

Mono<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 RedisClusterReactiveCommands<K,V>

Specified by:

del in interface RedisKeyReactiveCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyReactiveCommands.del(Object[])

unlink

Mono<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 RedisKeyReactiveCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyReactiveCommands.unlink(Object[])

exists

Mono<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 RedisKeyReactiveCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply specifically: Number of existing keys

mget

Flux<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 RedisClusterReactiveCommands<K,V>

Specified by:

mget in interface RedisStringReactiveCommands<K,V>

Parameters:

keys - the key

Returns:

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

See Also:

RedisStringReactiveCommands.mget(Object[])

mset

Mono<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 RedisClusterReactiveCommands<K,V>

Specified by:

mset in interface RedisStringReactiveCommands<K,V>

Parameters:

map - the map

Returns:

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

See Also:

RedisStringReactiveCommands.mset(Map)

msetnx

Mono<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 RedisClusterReactiveCommands<K,V>

Specified by:

msetnx in interface RedisStringReactiveCommands<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:

RedisStringReactiveCommands.msetnx(Map)

clientSetname

Mono<String> clientSetname(K name)

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

Specified by:

clientSetname in interface RedisServerReactiveCommands<K,V>

Parameters:

name - the client name

Returns:

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

See Also:

RedisServerReactiveCommands.clientSetname(Object)

flushall

Mono<String> flushall()

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

Specified by:

flushall in interface RedisServerReactiveCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerReactiveCommands.flushall()

flushallAsync

Mono<String> flushallAsync()

Remove all keys asynchronously from all databases on all cluster upstream nodes with pipelining.

Specified by:

flushallAsync in interface RedisServerReactiveCommands<K,V>

Returns:

String simple-string-reply

Since:

6.0

See Also:

RedisServerReactiveCommands.flushallAsync()

flushdb

Mono<String> flushdb()

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

Specified by:

flushdb in interface RedisServerReactiveCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerReactiveCommands.flushdb()

dbsize

Mono<Long> dbsize()

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

Specified by:

dbsize in interface RedisServerReactiveCommands<K,V>

Returns:

Long integer-reply

See Also:

RedisServerReactiveCommands.dbsize()

keys

Flux<K> keys(K pattern)

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

Specified by:

keys in interface RedisKeyReactiveCommands<K,V>

Parameters:

pattern - the pattern type: patternkey (pattern)

Returns:

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

See Also:

RedisKeyReactiveCommands.keys(Object)

keys

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

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

Specified by:

keys in interface RedisKeyReactiveCommands<K,V>

Parameters:

channel - the channel

pattern - the pattern

Returns:

Long array-reply list of keys matching pattern.

See Also:

RedisKeyReactiveCommands.keys(KeyStreamingChannel, Object)

randomkey

Mono<K> randomkey()

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

Specified by:

randomkey in interface RedisKeyReactiveCommands<K,V>

Returns:

K bulk-string-reply the random key, or a Mono that completes empty when the database is empty.

See Also:

RedisKeyReactiveCommands.randomkey()

scriptFlush

Mono<String> scriptFlush()

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

Specified by:

scriptFlush in interface RedisScriptingReactiveCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisScriptingReactiveCommands.scriptFlush()

scriptKill

Mono<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 RedisScriptingReactiveCommands<K,V>

Returns:

String simple-string-reply, always OK.

See Also:

RedisScriptingReactiveCommands.scriptKill()

scriptLoad

Mono<String> scriptLoad(String script)

Load the specified Lua script into the script cache on all cluster nodes.

Specified by:

scriptLoad in interface RedisScriptingReactiveCommands<K,V>

Parameters:

script - script content

Returns:

String bulk-string-reply This command returns the SHA1 digest of the script added into the script cache.

Since:

6.0

scriptLoad

Mono<String> scriptLoad(byte[] script)

Load the specified Lua script into the script cache on all cluster nodes.

Specified by:

scriptLoad in interface RedisScriptingReactiveCommands<K,V>

Parameters:

script - script content

Returns:

String bulk-string-reply This command returns the SHA1 digest of the script added into the script cache.

Since:

6.0

shutdown

Mono<Void> shutdown(boolean save)

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

Specified by:

shutdown in interface RedisServerReactiveCommands<K,V>

Parameters:

save - true force save operation

See Also:

RedisServerReactiveCommands.shutdown(boolean)

scan

Mono<KeyScanCursor<K>> scan()

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<K,V>

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyReactiveCommands.scan(ScanArgs)

scan

Mono<KeyScanCursor<K>> scan(ScanArgs scanArgs)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<K,V>

Parameters:

scanArgs - scan arguments

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyReactiveCommands.scan(ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<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:

RedisKeyReactiveCommands.scan(ScanCursor, ScanArgs)

scan

Mono<KeyScanCursor<K>> scan(ScanCursor scanCursor)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<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:

RedisKeyReactiveCommands.scan(ScanCursor)

scan

Mono<StreamScanCursor> scan(KeyStreamingChannel<K> channel)

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyReactiveCommands.scan(KeyStreamingChannel)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

scanArgs - scan arguments

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyReactiveCommands.scan(KeyStreamingChannel, ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<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:

RedisKeyReactiveCommands.scan(KeyStreamingChannel, ScanCursor, ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyReactiveCommands<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:

RedisKeyReactiveCommands.scan(ScanCursor, ScanArgs)

touch

Mono<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 RedisKeyReactiveCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply the number of found keys.