Module lettuce.core

Package io.lettuce.core.cluster.api.async

Interface RedisAdvancedClusterAsyncCommands<K,V>

All Superinterfaces:

BaseRedisAsyncCommands<K,V>, RedisAclAsyncCommands<K,V>, RedisClusterAsyncCommands<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>

All Known Implementing Classes:

RedisAdvancedClusterAsyncCommandsImpl

public interface RedisAdvancedClusterAsyncCommands<K,V>
extends RedisClusterAsyncCommands<K,V>

Advanced asynchronous and thread-safe Redis Cluster API.

Since:

4.0

Author:

Mark Paluch, Jon Chambers

Method Summary

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

Methods inherited from interface io.lettuce.core.api.async.BaseRedisAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisAclAsyncCommands

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

Methods inherited from interface io.lettuce.core.cluster.api.async.RedisClusterAsyncCommands

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.async.RedisGeoAsyncCommands

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.async.RedisHashAsyncCommands

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.async.RedisHLLAsyncCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.async.RedisKeyAsyncCommands

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.async.RedisListAsyncCommands

blmove, blpop, brpop, 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.async.RedisScriptingAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisServerAsyncCommands

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.async.RedisSetAsyncCommands

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.async.RedisSortedSetAsyncCommands

bzpopmax, 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.async.RedisStreamAsyncCommands

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.async.RedisStringAsyncCommands

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

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

Parameters:

nodeId - the node Id

Returns:

a connection to the requested cluster node

getConnection

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

Retrieve a connection to the specified cluster node using host and port. In contrast to the RedisAdvancedClusterAsyncCommands, 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 AsyncNodeSelection<K,V> masters()

Deprecated.

since 6.0 in favor of upstream().

Select all upstream nodes.

Returns:

API with asynchronous executed commands on a selection of upstream cluster nodes.

upstream

default AsyncNodeSelection<K,V> upstream()

Select all upstream nodes.

Returns:

API with asynchronous executed commands on a selection of upstream cluster nodes.

Since:

6.0

slaves

@Deprecated
default AsyncNodeSelection<K,V> slaves()

Deprecated.

since 5.2, use replicas()

Select all replicas.

Returns:

API with asynchronous executed commands on a selection of replica cluster nodes.

slaves

@Deprecated
default AsyncNodeSelection<K,V> slaves(Predicate<RedisClusterNode> predicate)

Deprecated.

use replicas(Predicate)

Select all replicas.

Parameters:

predicate - Predicate to filter nodes

Returns:

API with asynchronous executed commands on a selection of replica cluster nodes.

replicas

default AsyncNodeSelection<K,V> replicas()

Select all replicas.

Returns:

API with asynchronous executed commands on a selection of replica cluster nodes.

Since:

5.2

replicas

default AsyncNodeSelection<K,V> replicas(Predicate<RedisClusterNode> predicate)

Select all replicas.

Parameters:

predicate - Predicate to filter nodes

Returns:

API with asynchronous executed commands on a selection of replica cluster nodes.

Since:

5.2

all

default AsyncNodeSelection<K,V> all()

Select all known cluster nodes.

Returns:

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

readonly

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

Select replica nodes by a predicate and keeps a static selection. Replica 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 asynchronous executed commands on a selection of cluster nodes matching predicate

nodes

AsyncNodeSelection<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 asynchronous executed commands on a selection of cluster nodes matching predicate

nodes

AsyncNodeSelection<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 asynchronous executed commands on a selection of cluster nodes matching predicate

del

RedisFuture<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 RedisClusterAsyncCommands<K,V>

Specified by:

del in interface RedisKeyAsyncCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyAsyncCommands.del(Object[])

unlink

RedisFuture<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 RedisKeyAsyncCommands<K,V>

Parameters:

keys - the keys

Returns:

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

See Also:

RedisKeyAsyncCommands.unlink(Object[])

exists

RedisFuture<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 RedisKeyAsyncCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply specifically: Number of existing keys

mget

RedisFuture<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 RedisClusterAsyncCommands<K,V>

Specified by:

mget in interface RedisStringAsyncCommands<K,V>

Parameters:

keys - the key

Returns:

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

See Also:

RedisStringAsyncCommands.mget(Object[])

mset

RedisFuture<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 RedisClusterAsyncCommands<K,V>

Specified by:

mset in interface RedisStringAsyncCommands<K,V>

Parameters:

map - the map

Returns:

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

See Also:

RedisStringAsyncCommands.mset(Map)

msetnx

RedisFuture<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 RedisClusterAsyncCommands<K,V>

Specified by:

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

RedisStringAsyncCommands.msetnx(Map)

clientSetname

RedisFuture<String> clientSetname(K name)

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

Specified by:

clientSetname in interface RedisServerAsyncCommands<K,V>

Parameters:

name - the client name

Returns:

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

See Also:

RedisServerAsyncCommands.clientSetname(Object)

flushall

RedisFuture<String> flushall()

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

Specified by:

flushall in interface RedisServerAsyncCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerAsyncCommands.flushall()

flushallAsync

RedisFuture<String> flushallAsync()

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

Specified by:

flushallAsync in interface RedisServerAsyncCommands<K,V>

Returns:

String simple-string-reply

Since:

6.0

See Also:

RedisServerAsyncCommands.flushallAsync()

flushdb

RedisFuture<String> flushdb()

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

Specified by:

flushdb in interface RedisServerAsyncCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisServerAsyncCommands.flushdb()

dbsize

RedisFuture<Long> dbsize()

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

Specified by:

dbsize in interface RedisServerAsyncCommands<K,V>

Returns:

Long integer-reply

See Also:

RedisServerAsyncCommands.dbsize()

keys

RedisFuture<List<K>> keys(K pattern)

Find all keys matching the given pattern on all cluster upstream nodes.

Specified by:

keys in interface RedisKeyAsyncCommands<K,V>

Parameters:

pattern - the pattern type: patternkey (pattern)

Returns:

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

See Also:

RedisKeyAsyncCommands.keys(Object)

keys

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

Find all keys matching the given pattern on all cluster upstream nodes.

Specified by:

keys in interface RedisKeyAsyncCommands<K,V>

Parameters:

channel - the channel

pattern - the pattern

Returns:

Long array-reply list of keys matching pattern.

See Also:

RedisKeyAsyncCommands.keys(KeyStreamingChannel, Object)

randomkey

RedisFuture<K> randomkey()

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

Specified by:

randomkey in interface RedisKeyAsyncCommands<K,V>

Returns:

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

See Also:

RedisKeyAsyncCommands.randomkey()

scriptFlush

RedisFuture<String> scriptFlush()

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

Specified by:

scriptFlush in interface RedisScriptingAsyncCommands<K,V>

Returns:

String simple-string-reply

See Also:

RedisScriptingAsyncCommands.scriptFlush()

scriptKill

RedisFuture<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 RedisScriptingAsyncCommands<K,V>

Returns:

String simple-string-reply, always OK.

See Also:

RedisScriptingAsyncCommands.scriptKill()

scriptLoad

RedisFuture<String> scriptLoad(String script)

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

Specified by:

scriptLoad in interface RedisScriptingAsyncCommands<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

RedisFuture<String> scriptLoad(byte[] script)

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

Specified by:

scriptLoad in interface RedisScriptingAsyncCommands<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

void shutdown(boolean save)

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

Specified by:

shutdown in interface RedisServerAsyncCommands<K,V>

Parameters:

save - true force save operation

See Also:

RedisServerAsyncCommands.shutdown(boolean)

scan

RedisFuture<KeyScanCursor<K>> scan()

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyAsyncCommands.scan()

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Parameters:

scanArgs - scan arguments

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyAsyncCommands.scan(ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

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

RedisKeyAsyncCommands.scan(ScanCursor, ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

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

RedisKeyAsyncCommands.scan(ScanCursor)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyAsyncCommands.scan(KeyStreamingChannel)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key

scanArgs - scan arguments

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyAsyncCommands.scan(KeyStreamingChannel, ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

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

RedisKeyAsyncCommands.scan(KeyStreamingChannel, ScanCursor, ScanArgs)

scan

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

Incrementally iterate the keys space over the whole Cluster.

Specified by:

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

RedisKeyAsyncCommands.scan(ScanCursor, ScanArgs)

touch

RedisFuture<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 RedisKeyAsyncCommands<K,V>

Parameters:

keys - the keys

Returns:

Long integer-reply the number of found keys.