Module lettuce.core

Package io.lettuce.core.cluster

Class RedisAdvancedClusterAsyncCommandsImpl<K,V>

java.lang.Object

io.lettuce.core.AbstractRedisAsyncCommands<K,V>

io.lettuce.core.cluster.RedisAdvancedClusterAsyncCommandsImpl<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

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

public class RedisAdvancedClusterAsyncCommandsImpl<K,V>
extends AbstractRedisAsyncCommands<K,V>
implements RedisAdvancedClusterAsyncCommands<K,V>

An advanced asynchronous and thread-safe API for a Redis Cluster connection.

Since:

3.3

Author:

Mark Paluch, Jon Chambers

Constructor Summary

Constructors

Constructor	Description
RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnection<K,V> connection, RedisCodec<K,V> codec)	Initialize a new connection.
RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnectionImpl<K,V> connection, RedisCodec<K,V> codec)	Deprecated. since 5.1, use RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnection, RedisCodec).

Method Summary

Modifier and Type	Method	Description
RedisFuture<String>	clientSetname(K name)	Set the current connection name.
RedisFuture<Long>	clusterCountKeysInSlot(int slot)	Returns the number of keys in the specified Redis Cluster hash slot.
RedisFuture<List<K>>	clusterGetKeysInSlot(int slot, int count)	Retrieve the list of keys within the slot.
RedisFuture<Long>	dbsize()	Return the number of keys in the selected database.
RedisFuture<Long>	del(Iterable<K> keys)
RedisFuture<Long>	del(K... keys)	Delete one or more keys.
protected <T> Map<String,CompletableFuture<T>>	executeOnNodes(Function<RedisClusterAsyncCommands<K,V>,RedisFuture<T>> function, Function<RedisClusterNode,Boolean> filter)	Run a command on all available nodes that match filter.
protected <T> Map<String,CompletableFuture<T>>	executeOnUpstream(Function<RedisClusterAsyncCommands<K,V>,RedisFuture<T>> function)	Run a command on all available masters,
RedisFuture<Long>	exists(Iterable<K> keys)
RedisFuture<Long>	exists(K... keys)	Determine how many keys exist.
RedisFuture<String>	flushall()	Remove all keys from all databases.
RedisFuture<String>	flushallAsync()	Remove all keys asynchronously from all databases.
RedisFuture<String>	flushdb()	Remove all keys from the current database.
RedisFuture<Set<V>>	georadius(K key, double longitude, double latitude, double distance, GeoArgs.Unit unit)	Retrieve members selected by distance with the center of longitude and latitude.
RedisFuture<List<GeoWithin<V>>>	georadius(K key, double longitude, double latitude, double distance, GeoArgs.Unit unit, GeoArgs geoArgs)	Retrieve members selected by distance with the center of longitude and latitude.
RedisFuture<Set<V>>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit)	Retrieve members selected by distance with the center of member.
RedisFuture<List<GeoWithin<V>>>	georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoArgs geoArgs)	Retrieve members selected by distance with the center of member.
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.
RedisFuture<List<K>>	keys(K pattern)	Find all keys matching the given pattern.
RedisFuture<Long>	mget(KeyValueStreamingChannel<K,V> channel, Iterable<K> keys)
RedisFuture<Long>	mget(KeyValueStreamingChannel<K,V> channel, K... keys)	Stream over the values of all the given keys.
RedisFuture<List<KeyValue<K,V>>>	mget(Iterable<K> keys)
RedisFuture<List<KeyValue<K,V>>>	mget(K... keys)	Get the values of all the given keys.
RedisFuture<String>	mset(Map<K,V> map)	Set multiple keys to multiple values.
RedisFuture<Boolean>	msetnx(Map<K,V> map)	Set multiple keys to multiple values, only if none of the keys exist.
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
protected AsyncNodeSelection<K,V>	nodes(Predicate<RedisClusterNode> predicate, io.lettuce.core.cluster.ClusterConnectionProvider.Intent intent, boolean dynamic)
RedisFuture<K>	randomkey()	Return a random key from the keyspace.
AsyncNodeSelection<K,V>	readonly(Predicate<RedisClusterNode> predicate)	Select replica nodes by a predicate and keeps a static selection.
RedisFuture<KeyScanCursor<K>>	scan()	Incrementally iterate the keys space.
RedisFuture<StreamScanCursor>	scan(KeyStreamingChannel<K> channel)	Incrementally iterate the keys space.
RedisFuture<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanArgs scanArgs)	Incrementally iterate the keys space.
RedisFuture<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor)	Incrementally iterate the keys space.
RedisFuture<StreamScanCursor>	scan(KeyStreamingChannel<K> channel, ScanCursor scanCursor, ScanArgs scanArgs)	Incrementally iterate the keys space.
RedisFuture<KeyScanCursor<K>>	scan(ScanArgs scanArgs)	Incrementally iterate the keys space.
RedisFuture<KeyScanCursor<K>>	scan(ScanCursor scanCursor)	Incrementally iterate the keys space.
RedisFuture<KeyScanCursor<K>>	scan(ScanCursor scanCursor, ScanArgs scanArgs)	Incrementally iterate the keys space.
RedisFuture<String>	scriptFlush()	Remove all the scripts from the script cache.
RedisFuture<String>	scriptKill()	Kill the script currently in execution.
RedisFuture<String>	scriptLoad(byte[] script)	Load the specified Lua script into the script cache.
void	shutdown(boolean save)	Synchronously save the dataset to disk and then shut down the server.
RedisFuture<Long>	touch(Iterable<K> keys)
RedisFuture<Long>	touch(K... keys)	Touch one or more keys.
RedisFuture<Long>	unlink(Iterable<K> keys)
RedisFuture<Long>	unlink(K... keys)	Unlink one or more keys (non blocking DEL).

Methods inherited from class io.lettuce.core.AbstractRedisAsyncCommands

aclCat, aclCat, aclDeluser, aclGenpass, aclGenpass, aclGetuser, aclList, aclLoad, aclLog, aclLog, aclLogReset, aclSave, aclSetuser, aclUsers, aclWhoami, append, asking, auth, auth, auth, auth, bgrewriteaof, bgsave, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, bitpos, blmove, blpop, brpop, brpoplpush, bzpopmax, bzpopmin, clientCaching, clientGetname, clientGetredir, clientId, clientKill, clientKill, clientList, clientPause, clientTracking, clientUnblock, clusterAddSlots, clusterBumpepoch, clusterCountFailureReports, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, clusterInfo, clusterKeyslot, clusterMeet, clusterMyId, clusterNodes, clusterReplicate, clusterReset, clusterSaveconfig, clusterSetConfigEpoch, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode, clusterSetSlotStable, clusterSlaves, clusterSlots, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, copy, copy, debugCrashAndRecover, debugHtstats, debugObject, debugOom, debugReload, debugRestart, debugSdslen, debugSegfault, decr, decrby, digest, digest, discard, dispatch, dispatch, dispatch, dispatch, dispatch, dump, echo, eval, eval, eval, eval, evalsha, evalsha, exec, expire, expire, expireat, expireat, expireat, flushall, flushCommands, flushdb, flushdbAsync, geoadd, geoadd, geoadd, geoadd, geoadd, geoadd, geodist, geohash, geopos, georadius, georadius_ro, georadius_ro, georadiusbymember, georadiusbymember_ro, georadiusbymember_ro, geosearch, geosearch, geosearchstore, get, getbit, getConnection, getdel, getex, getrange, getset, 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, incr, incrby, incrbyfloat, info, info, isOpen, lastsave, lindex, linsert, llen, lmove, lpop, lpop, lpos, lpos, lpos, lpos, lpush, lpushx, lrange, lrange, lrem, lset, ltrim, memoryUsage, migrate, migrate, move, multi, objectEncoding, objectFreq, objectIdletime, objectRefcount, persist, pexpire, pexpire, pexpireat, pexpireat, pexpireat, pfadd, pfcount, pfmerge, ping, psetex, pttl, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, readOnly, readWrite, rename, renamenx, reset, restore, restore, role, rpop, rpop, rpoplpush, rpush, rpushx, sadd, save, scard, scriptExists, scriptFlush, scriptLoad, sdiff, sdiff, sdiffstore, select, set, set, setAutoFlushCommands, setbit, setex, setGet, setGet, setnx, setrange, setTimeout, sinter, sinter, sinterstore, sismember, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, smembers, smembers, smismember, smove, sort, sort, sort, sort, sortStore, spop, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, stralgoLcs, strlen, sunion, sunion, sunionstore, swapdb, time, ttl, type, unwatch, waitForReplication, watch, 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, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.RedisAdvancedClusterAsyncCommands

all, masters, replicas, replicas, scriptLoad, slaves, slaves, upstream

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

asking, auth, auth, clusterAddSlots, clusterBumpepoch, clusterCountFailureReports, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, 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, 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, psetex, set, set, setbit, setex, setGet, setGet, setnx, setrange, stralgoLcs, strlen

Constructor Details

RedisAdvancedClusterAsyncCommandsImpl

@Deprecated
public RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnectionImpl<K,V> connection,
RedisCodec<K,V> codec)

Deprecated.

since 5.1, use RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnection, RedisCodec).

Initialize a new connection.

Parameters:

connection - the stateful connection

codec - Codec used to encode/decode keys and values.

RedisAdvancedClusterAsyncCommandsImpl

public RedisAdvancedClusterAsyncCommandsImpl(StatefulRedisClusterConnection<K,V> connection,
RedisCodec<K,V> codec)

Initialize a new connection.

Parameters:

connection - the stateful connection

codec - Codec used to encode/decode keys and values.

Method Details

clientSetname

public RedisFuture<String> clientSetname(K name)

Description copied from interface: RedisServerAsyncCommands

Set the current connection name.

Specified by:

clientSetname in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

clientSetname in interface RedisServerAsyncCommands<K,V>

Overrides:

clientSetname in class AbstractRedisAsyncCommands<K,V>

Parameters:

name - the client name.

Returns:

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

See Also:

RedisServerAsyncCommands.clientSetname(Object)

clusterCountKeysInSlot

public RedisFuture<Long> clusterCountKeysInSlot(int slot)

Description copied from interface: RedisClusterAsyncCommands

Returns the number of keys in the specified Redis Cluster hash slot.

Specified by:

clusterCountKeysInSlot in interface RedisClusterAsyncCommands<K,V>

Overrides:

clusterCountKeysInSlot in class AbstractRedisAsyncCommands<K,V>

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.

clusterGetKeysInSlot

public RedisFuture<List<K>> clusterGetKeysInSlot(int slot,
int count)

Description copied from interface: RedisClusterAsyncCommands

Retrieve the list of keys within the slot.

Specified by:

clusterGetKeysInSlot in interface RedisClusterAsyncCommands<K,V>

Overrides:

clusterGetKeysInSlot in class AbstractRedisAsyncCommands<K,V>

Parameters:

slot - the slot

count - maximal number of keys

Returns:

List<K> array-reply list of keys

dbsize

public RedisFuture<Long> dbsize()

Description copied from interface: RedisServerAsyncCommands

Return the number of keys in the selected database.

Specified by:

dbsize in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

dbsize in interface RedisServerAsyncCommands<K,V>

Overrides:

dbsize in class AbstractRedisAsyncCommands<K,V>

Returns:

Long integer-reply.

See Also:

RedisServerAsyncCommands.dbsize()

del

public RedisFuture<Long> del(K... keys)

Description copied from interface: RedisKeyAsyncCommands

Delete one or more keys.

Specified by:

del in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

del in interface RedisClusterAsyncCommands<K,V>

Specified by:

del in interface RedisKeyAsyncCommands<K,V>

Overrides:

del in class AbstractRedisAsyncCommands<K,V>

Parameters:

keys - the keys.

Returns:

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

See Also:

RedisKeyAsyncCommands.del(Object[])

del

public RedisFuture<Long> del(Iterable<K> keys)

Overrides:

del in class AbstractRedisAsyncCommands<K,V>

exists

public RedisFuture<Long> exists(K... keys)

Description copied from interface: RedisKeyAsyncCommands

Determine how many keys exist.

Specified by:

exists in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

exists in interface RedisKeyAsyncCommands<K,V>

Overrides:

exists in class AbstractRedisAsyncCommands<K,V>

Parameters:

keys - the keys.

Returns:

Long integer-reply specifically: Number of existing keys.

exists

public RedisFuture<Long> exists(Iterable<K> keys)

Overrides:

exists in class AbstractRedisAsyncCommands<K,V>

flushall

public RedisFuture<String> flushall()

Description copied from interface: RedisServerAsyncCommands

Remove all keys from all databases.

Specified by:

flushall in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

flushall in interface RedisServerAsyncCommands<K,V>

Overrides:

flushall in class AbstractRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

See Also:

RedisServerAsyncCommands.flushall()

flushallAsync

public RedisFuture<String> flushallAsync()

Description copied from interface: RedisServerAsyncCommands

Remove all keys asynchronously from all databases.

Specified by:

flushallAsync in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

flushallAsync in interface RedisServerAsyncCommands<K,V>

Overrides:

flushallAsync in class AbstractRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

See Also:

RedisServerAsyncCommands.flushallAsync()

flushdb

public RedisFuture<String> flushdb()

Description copied from interface: RedisServerAsyncCommands

Remove all keys from the current database.

Specified by:

flushdb in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

flushdb in interface RedisServerAsyncCommands<K,V>

Overrides:

flushdb in class AbstractRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

See Also:

RedisServerAsyncCommands.flushdb()

georadius

public RedisFuture<Set<V>> georadius(K key,
double longitude,
double latitude,
double distance,
GeoArgs.Unit unit)

Description copied from interface: RedisGeoAsyncCommands

Retrieve members selected by distance with the center of longitude and latitude.

Specified by:

georadius in interface RedisGeoAsyncCommands<K,V>

Overrides:

georadius in class AbstractRedisAsyncCommands<K,V>

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

distance - radius distance.

unit - distance unit.

Returns:

bulk reply.

georadius

public RedisFuture<List<GeoWithin<V>>> georadius(K key,
double longitude,
double latitude,
double distance,
GeoArgs.Unit unit,
GeoArgs geoArgs)

Description copied from interface: RedisGeoAsyncCommands

Retrieve members selected by distance with the center of longitude and latitude.

Specified by:

georadius in interface RedisGeoAsyncCommands<K,V>

Overrides:

georadius in class AbstractRedisAsyncCommands<K,V>

Parameters:

key - the key of the geo set.

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

distance - radius distance.

unit - distance unit.

geoArgs - args to control the result.

Returns:

nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs.

georadiusbymember

public RedisFuture<Set<V>> georadiusbymember(K key,
V member,
double distance,
GeoArgs.Unit unit)

Description copied from interface: RedisGeoAsyncCommands

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.

Specified by:

georadiusbymember in interface RedisGeoAsyncCommands<K,V>

Overrides:

georadiusbymember in class AbstractRedisAsyncCommands<K,V>

Parameters:

key - the key of the geo set.

member - reference member.

distance - radius distance.

unit - distance unit.

Returns:

set of members.

georadiusbymember

public RedisFuture<List<GeoWithin<V>>> georadiusbymember(K key,
V member,
double distance,
GeoArgs.Unit unit,
GeoArgs geoArgs)

Description copied from interface: RedisGeoAsyncCommands

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.

Specified by:

georadiusbymember in interface RedisGeoAsyncCommands<K,V>

Overrides:

georadiusbymember in class AbstractRedisAsyncCommands<K,V>

Parameters:

key - the key of the geo set.

member - reference member.

distance - radius distance.

unit - distance unit.

geoArgs - args to control the result.

Returns:

nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs.

keys

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

Description copied from interface: RedisKeyAsyncCommands

Find all keys matching the given pattern.

Specified by:

keys in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

keys in interface RedisKeyAsyncCommands<K,V>

Overrides:

keys in class AbstractRedisAsyncCommands<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

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

Description copied from interface: RedisKeyAsyncCommands

Find all keys matching the given pattern.

Specified by:

keys in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

keys in interface RedisKeyAsyncCommands<K,V>

Overrides:

keys in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - the channel.

pattern - the pattern.

Returns:

Long array-reply list of keys matching pattern.

See Also:

RedisKeyAsyncCommands.keys(KeyStreamingChannel, Object)

mget

public RedisFuture<List<KeyValue<K,V>>> mget(K... keys)

Description copied from interface: RedisStringAsyncCommands

Get the values of all the given keys.

Specified by:

mget in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

mget in interface RedisClusterAsyncCommands<K,V>

Specified by:

mget in interface RedisStringAsyncCommands<K,V>

Overrides:

mget in class AbstractRedisAsyncCommands<K,V>

Parameters:

keys - the key.

Returns:

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

See Also:

RedisStringAsyncCommands.mget(Object[])

mget

public RedisFuture<List<KeyValue<K,V>>> mget(Iterable<K> keys)

Overrides:

mget in class AbstractRedisAsyncCommands<K,V>

mget

public RedisFuture<Long> mget(KeyValueStreamingChannel<K,V> channel,
K... keys)

Description copied from interface: RedisStringAsyncCommands

Stream over the values of all the given keys.

Specified by:

mget in interface RedisStringAsyncCommands<K,V>

Overrides:

mget in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - the channel.

keys - the keys.

Returns:

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

mget

public RedisFuture<Long> mget(KeyValueStreamingChannel<K,V> channel,
Iterable<K> keys)

Overrides:

mget in class AbstractRedisAsyncCommands<K,V>

mset

public RedisFuture<String> mset(Map<K,V> map)

Description copied from interface: RedisStringAsyncCommands

Set multiple keys to multiple values.

Specified by:

mset in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

mset in interface RedisClusterAsyncCommands<K,V>

Specified by:

mset in interface RedisStringAsyncCommands<K,V>

Overrides:

mset in class AbstractRedisAsyncCommands<K,V>

Parameters:

map - the null.

Returns:

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

See Also:

RedisStringAsyncCommands.mset(Map)

msetnx

public RedisFuture<Boolean> msetnx(Map<K,V> map)

Description copied from interface: RedisStringAsyncCommands

Set multiple keys to multiple values, only if none of the keys exist.

Specified by:

msetnx in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

msetnx in interface RedisClusterAsyncCommands<K,V>

Specified by:

msetnx in interface RedisStringAsyncCommands<K,V>

Overrides:

msetnx in class AbstractRedisAsyncCommands<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)

randomkey

public RedisFuture<K> randomkey()

Description copied from interface: RedisKeyAsyncCommands

Return a random key from the keyspace.

Specified by:

randomkey in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

randomkey in interface RedisKeyAsyncCommands<K,V>

Overrides:

randomkey in class AbstractRedisAsyncCommands<K,V>

Returns:

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

See Also:

RedisKeyAsyncCommands.randomkey()

scriptFlush

public RedisFuture<String> scriptFlush()

Description copied from interface: RedisScriptingAsyncCommands

Remove all the scripts from the script cache.

Specified by:

scriptFlush in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scriptFlush in interface RedisScriptingAsyncCommands<K,V>

Overrides:

scriptFlush in class AbstractRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

See Also:

RedisScriptingAsyncCommands.scriptFlush()

scriptKill

public RedisFuture<String> scriptKill()

Description copied from interface: RedisScriptingAsyncCommands

Kill the script currently in execution.

Specified by:

scriptKill in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scriptKill in interface RedisScriptingAsyncCommands<K,V>

Overrides:

scriptKill in class AbstractRedisAsyncCommands<K,V>

Returns:

String simple-string-reply.

See Also:

RedisScriptingAsyncCommands.scriptKill()

scriptLoad

public RedisFuture<String> scriptLoad(byte[] script)

Description copied from interface: RedisScriptingAsyncCommands

Load the specified Lua script into the script cache.

Specified by:

scriptLoad in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scriptLoad in interface RedisScriptingAsyncCommands<K,V>

Overrides:

scriptLoad in class AbstractRedisAsyncCommands<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.

shutdown

public void shutdown(boolean save)

Description copied from interface: RedisServerAsyncCommands

Synchronously save the dataset to disk and then shut down the server.

Specified by:

shutdown in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

shutdown in interface RedisServerAsyncCommands<K,V>

Overrides:

shutdown in class AbstractRedisAsyncCommands<K,V>

Parameters:

save - true force save operation.

See Also:

RedisServerAsyncCommands.shutdown(boolean)

touch

public RedisFuture<Long> touch(K... keys)

Description copied from interface: RedisKeyAsyncCommands

Touch one or more keys. Touch sets the last accessed time for a key. Non-exsitent keys wont get created.

Specified by:

touch in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

touch in interface RedisKeyAsyncCommands<K,V>

Overrides:

touch in class AbstractRedisAsyncCommands<K,V>

Parameters:

keys - the keys.

Returns:

Long integer-reply the number of found keys.

touch

public RedisFuture<Long> touch(Iterable<K> keys)

Overrides:

touch in class AbstractRedisAsyncCommands<K,V>

unlink

public RedisFuture<Long> unlink(K... keys)

Description copied from interface: RedisKeyAsyncCommands

Unlink one or more keys (non blocking DEL).

Specified by:

unlink in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

unlink in interface RedisKeyAsyncCommands<K,V>

Overrides:

unlink in class AbstractRedisAsyncCommands<K,V>

Parameters:

keys - the keys.

Returns:

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

See Also:

RedisKeyAsyncCommands.unlink(Object[])

unlink

public RedisFuture<Long> unlink(Iterable<K> keys)

Overrides:

unlink in class AbstractRedisAsyncCommands<K,V>

getConnection

public RedisClusterAsyncCommands<K,V> getConnection(String nodeId)

Description copied from interface: RedisAdvancedClusterAsyncCommands

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

Specified by:

getConnection in interface RedisAdvancedClusterAsyncCommands<K,V>

Parameters:

nodeId - the node Id

Returns:

a connection to the requested cluster node

getConnection

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

Description copied from interface: RedisAdvancedClusterAsyncCommands

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().

Specified by:

getConnection in interface RedisAdvancedClusterAsyncCommands<K,V>

Parameters:

host - the host

port - the port

Returns:

a connection to the requested cluster node

getStatefulConnection

public StatefulRedisClusterConnection<K,V> getStatefulConnection()

Specified by:

getStatefulConnection in interface RedisAdvancedClusterAsyncCommands<K,V>

Returns:

the underlying connection.

nodes

public AsyncNodeSelection<K,V> nodes(Predicate<RedisClusterNode> predicate)

Description copied from interface: RedisAdvancedClusterAsyncCommands

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.

Specified by:

nodes in interface RedisAdvancedClusterAsyncCommands<K,V>

Parameters:

predicate - Predicate to filter nodes

Returns:

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

readonly

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

Description copied from interface: RedisAdvancedClusterAsyncCommands

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.

Specified by:

readonly in interface RedisAdvancedClusterAsyncCommands<K,V>

Parameters:

predicate - Predicate to filter nodes

Returns:

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

nodes

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

Description copied from interface: RedisAdvancedClusterAsyncCommands

Select nodes by a predicate

Specified by:

nodes in interface RedisAdvancedClusterAsyncCommands<K,V>

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

nodes

protected AsyncNodeSelection<K,V> nodes(Predicate<RedisClusterNode> predicate,
io.lettuce.core.cluster.ClusterConnectionProvider.Intent intent,
boolean dynamic)

scan

public RedisFuture<KeyScanCursor<K>> scan()

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyAsyncCommands.scan()

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space. Use KeyScanArgs to specify SCAN-specific arguments.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

scanArgs - scan arguments.

Returns:

KeyScanCursor<K> scan cursor.

See Also:

KeyScanArgs

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space. Use KeyScanArgs to specify SCAN-specific arguments.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

KeyScanCursor<K> scan cursor.

See Also:

KeyScanArgs

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

KeyScanCursor<K> scan cursor.

See Also:

RedisKeyAsyncCommands.scan(ScanCursor)

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key.

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyAsyncCommands.scan(KeyStreamingChannel)

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space. Use KeyScanArgs to specify SCAN-specific arguments.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

See Also:

KeyScanArgs

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space. Use KeyScanArgs to specify SCAN-specific arguments.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

See Also:

KeyScanArgs

scan

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

Description copied from interface: RedisKeyAsyncCommands

Incrementally iterate the keys space.

Specified by:

scan in interface RedisAdvancedClusterAsyncCommands<K,V>

Specified by:

scan in interface RedisKeyAsyncCommands<K,V>

Overrides:

scan in class AbstractRedisAsyncCommands<K,V>

Parameters:

channel - streaming channel that receives a call for every key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

StreamScanCursor scan cursor.

See Also:

RedisKeyAsyncCommands.scan(ScanCursor, ScanArgs)

executeOnUpstream

protected <T> Map<String,CompletableFuture<T>> executeOnUpstream(Function<RedisClusterAsyncCommands<K,V>,RedisFuture<T>> function)

Run a command on all available masters,

Type Parameters:

T - result type

Parameters:

function - function producing the command

Returns:

map of a key (counter) and commands.

executeOnNodes

protected <T> Map<String,CompletableFuture<T>> executeOnNodes(Function<RedisClusterAsyncCommands<K,V>,RedisFuture<T>> function,
Function<RedisClusterNode,Boolean> filter)

Run a command on all available nodes that match filter.

Type Parameters:

T - result type

Parameters:

function - function producing the command

filter - filter function for the node selection

Returns:

map of a key (counter) and commands.