Package org.springframework.data.redis.connection.lettuce

Class LettuceClusterConnection

java.lang.Object

org.springframework.data.redis.connection.AbstractRedisConnection

org.springframework.data.redis.connection.lettuce.LettuceConnection

org.springframework.data.redis.connection.lettuce.LettuceClusterConnection

All Implemented Interfaces:

AutoCloseable, DefaultedRedisClusterConnection, DefaultedRedisConnection, RedisClusterCommands, RedisClusterCommandsProvider, RedisClusterConnection, RedisClusterServerCommands, RedisCommands, RedisCommandsProvider, RedisConnection, RedisConnectionCommands, RedisGeoCommands, RedisHashCommands, RedisHyperLogLogCommands, RedisKeyCommands, RedisListCommands, RedisPubSubCommands, RedisScriptingCommands, RedisServerCommands, RedisSetCommands, RedisStreamCommands, RedisStringCommands, RedisTxCommands, RedisZSetCommands

public class LettuceClusterConnection
extends LettuceConnection
implements RedisClusterConnection, DefaultedRedisClusterConnection

RedisClusterConnection implementation on top of Lettuce Redis client.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	LettuceClusterConnection.LettuceClusterCommandCallback<T>	Lettuce specific implementation of ClusterCommandExecutor.ClusterCommandCallback.
protected static interface	LettuceClusterConnection.LettuceMultiKeyClusterCommandCallback<T>	Lettuce specific implementation of ClusterCommandExecutor.MultiKeyClusterCommandCallback.

Nested classes/interfaces inherited from class org.springframework.data.redis.connection.lettuce.LettuceConnection

LettuceConnection.PipeliningFlushPolicy, LettuceConnection.PipeliningFlushState

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisClusterCommands

RedisClusterCommands.AddSlots

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

RedisGeoCommands.DistanceUnit, RedisGeoCommands.GeoCommandArgs, RedisGeoCommands.GeoLocation<T>, RedisGeoCommands.GeoRadiusCommandArgs, RedisGeoCommands.GeoSearchCommandArgs, RedisGeoCommands.GeoSearchStoreCommandArgs

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisListCommands

RedisListCommands.Direction, RedisListCommands.Position

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisServerCommands

RedisServerCommands.FlushOption, RedisServerCommands.MigrateOption, RedisServerCommands.ShutdownOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

RedisStreamCommands.XAddOptions, RedisStreamCommands.XClaimOptions, RedisStreamCommands.XPendingOptions

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisStringCommands

RedisStringCommands.BitOperation, RedisStringCommands.SetOption

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

RedisZSetCommands.Limit, RedisZSetCommands.Range, RedisZSetCommands.ZAddArgs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LettuceClusterConnection(io.lettuce.core.cluster.api.StatefulRedisClusterConnection<byte[],byte[]> sharedConnection, LettuceConnectionProvider connectionProvider, ClusterTopologyProvider clusterTopologyProvider, ClusterCommandExecutor executor, Duration timeout)	Creates new LettuceClusterConnection given a shared StatefulRedisClusterConnection and LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.
	LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient)	Creates new LettuceClusterConnection using RedisClusterClient with default timeout and a fresh ClusterCommandExecutor that gets destroyed on close.
	LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient, ClusterCommandExecutor executor)	Creates new LettuceClusterConnection with default timeout using RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.
	LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient, ClusterCommandExecutor executor, Duration timeout)	Creates new LettuceClusterConnection with given command timeout using RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.
	LettuceClusterConnection(LettuceConnectionProvider connectionProvider)	Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.
	LettuceClusterConnection(LettuceConnectionProvider connectionProvider, ClusterCommandExecutor executor)	Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.
	LettuceClusterConnection(LettuceConnectionProvider connectionProvider, ClusterCommandExecutor executor, Duration timeout)	Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes (or quits) the connection.
void	clusterAddSlots(RedisClusterNode node, int... slots)	Assign slots to given RedisClusterNode.
void	clusterAddSlots(RedisClusterNode node, RedisClusterNode.SlotRange range)	Assign RedisClusterNode.SlotRange.getSlotsArray() to given RedisClusterNode.
RedisClusterCommands	clusterCommands()	Get RedisGeoCommands.
Long	clusterCountKeysInSlot(int slot)	Count the number of keys assigned to one slot.
void	clusterDeleteSlots(RedisClusterNode node, int... slots)	Remove slots from RedisClusterNode.
void	clusterDeleteSlotsInRange(RedisClusterNode node, RedisClusterNode.SlotRange range)	Removes RedisClusterNode.SlotRange.getSlotsArray() from given RedisClusterNode.
void	clusterForget(RedisClusterNode node)	Remove given node from cluster.
ClusterInfo	clusterGetClusterInfo()	Get cluster information.
List<byte[]>	clusterGetKeysInSlot(int slot, Integer count)	Get keys served by slot.
Map<RedisClusterNode,Collection<RedisClusterNode>>	clusterGetMasterReplicaMap()	Retrieve information about masters and their connected replicas.
RedisClusterNode	clusterGetNodeForKey(byte[] key)	Find the RedisClusterNode serving given key.
RedisClusterNode	clusterGetNodeForSlot(int slot)	Find the RedisClusterNode serving given slot.
List<RedisClusterNode>	clusterGetNodes()	Retrieve cluster node information such as id, host, port and slots.
Set<RedisClusterNode>	clusterGetReplicas(RedisClusterNode master)	Retrieve information about connected replicas for given master node.
Integer	clusterGetSlotForKey(byte[] key)	Find the slot for a given key.
void	clusterMeet(RedisClusterNode node)	Add given node to cluster.
void	clusterReplicate(RedisClusterNode master, RedisClusterNode replica)	Assign a replica to given master.
void	clusterSetSlot(RedisClusterNode node, int slot, RedisClusterCommands.AddSlots mode)
RedisGeoCommands	geoCommands()	Get RedisGeoCommands.
ClusterCommandExecutor	getClusterCommandExecutor()
RedisHashCommands	hashCommands()	Get RedisHashCommands.
RedisHyperLogLogCommands	hyperLogLogCommands()	Get RedisHyperLogLogCommands.
RedisKeyCommands	keyCommands()	Get RedisKeyCommands.
Set<byte[]>	keys(RedisClusterNode node, byte[] pattern)
RedisListCommands	listCommands()	Get RedisListCommands.
void	multi()	Mark the start of a transaction block.
String	ping()	Test connection.
String	ping(RedisClusterNode node)
byte[]	randomKey(RedisClusterNode node)
Cursor<byte[]>	scan(RedisClusterNode node, ScanOptions options)	Use a Cursor to iterate over keys.
void	select(int dbIndex)	Select the DB with given positive dbIndex.
RedisClusterServerCommands	serverCommands()	Get RedisServerCommands.
RedisSetCommands	setCommands()	Get RedisSetCommands.
RedisStringCommands	stringCommands()	Get RedisStringCommands.
void	unwatch()	Flushes all the previously RedisTxCommands.watch(byte[]...) keys.
void	watch(byte[]... keys)	Watch given keys for modifications during transaction started with RedisTxCommands.multi().
RedisZSetCommands	zSetCommands()	Get RedisZSetCommands.

Methods inherited from class org.springframework.data.redis.connection.lettuce.LettuceConnection

closePipeline, commands, convertLettuceAccessException, discard, doCreateSubscription, doGetAsyncDedicatedConnection, echo, exec, execute, execute, getAsyncDedicatedConnection, getConnection, getNativeConnection, getSentinelConnection, getSubscription, isActive, isClosed, isPipelined, isQueueing, isSubscribed, openPipeline, pSubscribe, publish, scriptingCommands, setConvertPipelineAndTxResults, setPipeliningFlushPolicy, streamCommands, subscribe, switchToPubSub

Methods inherited from class org.springframework.data.redis.connection.AbstractRedisConnection

getSentinelConnection, hasRedisSentinelConfigured, setSentinelConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.DefaultedRedisClusterConnection

bgReWriteAof, bgSave, dbSize, flushAll, flushAll, flushDb, flushDb, getClientList, getConfig, info, info, lastSave, resetConfigStats, rewriteConfig, save, setConfig, shutdown, time, time

Methods inherited from interface org.springframework.data.redis.connection.DefaultedRedisConnection

append, bgReWriteAof, bgSave, bitCount, bitCount, bitField, bitOp, bitPos, bLMove, bLPop, bRPop, bRPopLPush, bZPopMax, bZPopMin, copy, dbSize, decr, decrBy, del, dump, encodingOf, eval, evalSha, evalSha, exists, exists, expire, expireAt, flushAll, flushAll, flushDb, flushDb, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRemove, geoSearch, geoSearchStore, get, getBit, getClientList, getClientName, getConfig, getDel, getEx, getRange, getSet, hDel, hExists, hGet, hGetAll, hIncrBy, hIncrBy, hKeys, hLen, hMGet, hMSet, hRandField, hRandField, hRandFieldWithValues, hRandFieldWithValues, hScan, hSet, hSetNX, hStrLen, hVals, idletime, incr, incrBy, incrBy, info, info, keys, killClient, lastSave, lIndex, lInsert, lLen, lMove, lPop, lPop, lPos, lPush, lPushX, lRange, lRem, lSet, lTrim, mGet, migrate, migrate, move, mSet, mSetNX, persist, pExpire, pExpireAt, pfAdd, pfCount, pfMerge, pSetEx, pTtl, pTtl, randomKey, refcount, rename, renameNX, replicaOf, replicaOfNoOne, resetConfigStats, restore, rewriteConfig, rPop, rPop, rPopLPush, rPush, rPushX, sAdd, save, scan, sCard, scriptExists, scriptFlush, scriptKill, scriptLoad, sDiff, sDiffStore, set, set, setBit, setClientName, setConfig, setEx, setNX, setRange, shutdown, shutdown, sInter, sInterStore, sIsMember, sMembers, sMIsMember, sMove, sort, sort, sPop, sPop, sRandMember, sRandMember, sRem, sScan, strLen, sUnion, sUnionStore, time, time, touch, ttl, ttl, type, unlink, xAck, xAdd, xClaim, xClaimJustId, xDel, xGroupCreate, xGroupCreate, xGroupDelConsumer, xGroupDestroy, xInfo, xInfoConsumers, xInfoGroups, xLen, xPending, xPending, xRange, xRange, xRead, xRead, xReadGroup, xReadGroup, xRevRange, xRevRange, xTrim, xTrim, zAdd, zAdd, zCard, zCount, zCount, zDiff, zDiffStore, zDiffWithScores, zIncrBy, zInter, zInterStore, zInterStore, zInterStore, zInterWithScores, zInterWithScores, zInterWithScores, zLexCount, zMScore, zPopMax, zPopMax, zPopMin, zPopMin, zRandMember, zRandMember, zRandMemberWithScore, zRandMemberWithScore, zRange, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRangeWithScores, zRank, zRem, zRemRange, zRemRangeByLex, zRemRangeByScore, zRemRangeByScore, zRevRange, zRevRangeByLex, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeWithScores, zRevRank, zScan, zScore, zUnion, zUnionStore, zUnionStore, zUnionStore, zUnionWithScores, zUnionWithScores, zUnionWithScores

Methods inherited from interface org.springframework.data.redis.connection.RedisClusterConnection

execute

Methods inherited from interface org.springframework.data.redis.connection.RedisCommands

execute

Methods inherited from interface org.springframework.data.redis.connection.RedisCommandsProvider

commands, scriptingCommands, streamCommands

Methods inherited from interface org.springframework.data.redis.connection.RedisConnection

closePipeline, getNativeConnection, getSentinelConnection, isClosed, isPipelined, isQueueing, openPipeline

Methods inherited from interface org.springframework.data.redis.connection.RedisConnectionCommands

echo

Methods inherited from interface org.springframework.data.redis.connection.RedisGeoCommands

geoAdd, geoRadiusByMember

Methods inherited from interface org.springframework.data.redis.connection.RedisKeyCommands

restore, scan

Methods inherited from interface org.springframework.data.redis.connection.RedisListCommands

lPos

Methods inherited from interface org.springframework.data.redis.connection.RedisPubSubCommands

getSubscription, isSubscribed, pSubscribe, publish, subscribe

Methods inherited from interface org.springframework.data.redis.connection.RedisStreamCommands

xAck, xAdd, xAdd, xClaim, xDel, xGroupDelConsumer, xPending, xPending, xPending, xPending, xPending

Methods inherited from interface org.springframework.data.redis.connection.RedisStringCommands

bitPos

Methods inherited from interface org.springframework.data.redis.connection.RedisTxCommands

discard, exec

Methods inherited from interface org.springframework.data.redis.connection.RedisZSetCommands

zAdd, zAdd, zRangeByLex, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeStoreByLex, zRangeStoreByScore, zRangeStoreRevByLex, zRangeStoreRevByScore, zRevRangeByLex, zRevRangeByLex, zRevRangeByScore, zRevRangeByScore, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores

Constructor Details

LettuceClusterConnection

public LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient)

Creates new LettuceClusterConnection using RedisClusterClient with default timeout and a fresh ClusterCommandExecutor that gets destroyed on close.

Parameters:

clusterClient - must not be null.

LettuceClusterConnection

public LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient,
 ClusterCommandExecutor executor)

Creates new LettuceClusterConnection with default timeout using RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.

Parameters:

clusterClient - must not be null.

executor - must not be null.

LettuceClusterConnection

public LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient,
 ClusterCommandExecutor executor,
 Duration timeout)

Creates new LettuceClusterConnection with given command timeout using RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.

Parameters:

clusterClient - must not be null.

timeout - must not be null.

executor - must not be null.

Since:

2.0

LettuceClusterConnection

public LettuceClusterConnection(LettuceConnectionProvider connectionProvider)

Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.

Parameters:

connectionProvider - must not be null.

Since:

2.0

LettuceClusterConnection

public LettuceClusterConnection(LettuceConnectionProvider connectionProvider,
 ClusterCommandExecutor executor)

Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.

Parameters:

connectionProvider - must not be null.

executor - must not be null.

Since:

2.0

LettuceClusterConnection

public LettuceClusterConnection(LettuceConnectionProvider connectionProvider,
 ClusterCommandExecutor executor,
 Duration timeout)

Creates new LettuceClusterConnection using LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.

Parameters:

connectionProvider - must not be null.

executor - must not be null.

timeout - must not be null.

Since:

2.0

LettuceClusterConnection

protected LettuceClusterConnection(@Nullable
 io.lettuce.core.cluster.api.StatefulRedisClusterConnection<byte[],byte[]> sharedConnection,
 LettuceConnectionProvider connectionProvider,
 ClusterTopologyProvider clusterTopologyProvider,
 ClusterCommandExecutor executor,
 Duration timeout)

Creates new LettuceClusterConnection given a shared StatefulRedisClusterConnection and LettuceConnectionProvider running commands across the cluster via given ClusterCommandExecutor.

Parameters:

sharedConnection - may be null if no shared connection used.

connectionProvider - must not be null.

clusterTopologyProvider - must not be null.

executor - must not be null.

timeout - must not be null.

Since:

2.1

Method Details

clusterCommands

public RedisClusterCommands clusterCommands()

Description copied from interface: RedisClusterCommandsProvider

Get RedisGeoCommands.

Specified by:

clusterCommands in interface RedisClusterCommandsProvider

Returns:

never null.

geoCommands

public RedisGeoCommands geoCommands()

Description copied from interface: RedisCommandsProvider

Get RedisGeoCommands.

Specified by:

geoCommands in interface RedisCommandsProvider

Overrides:

geoCommands in class LettuceConnection

Returns:

never null.

hashCommands

public RedisHashCommands hashCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHashCommands.

Specified by:

hashCommands in interface RedisCommandsProvider

Overrides:

hashCommands in class LettuceConnection

Returns:

never null.

hyperLogLogCommands

public RedisHyperLogLogCommands hyperLogLogCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHyperLogLogCommands.

Specified by:

hyperLogLogCommands in interface RedisCommandsProvider

Overrides:

hyperLogLogCommands in class LettuceConnection

Returns:

never null.

keyCommands

public RedisKeyCommands keyCommands()

Description copied from interface: RedisCommandsProvider

Get RedisKeyCommands.

Specified by:

keyCommands in interface RedisCommandsProvider

Overrides:

keyCommands in class LettuceConnection

Returns:

never null.

listCommands

public RedisListCommands listCommands()

Description copied from interface: RedisCommandsProvider

Get RedisListCommands.

Specified by:

listCommands in interface RedisCommandsProvider

Overrides:

listCommands in class LettuceConnection

Returns:

never null.

setCommands

public RedisSetCommands setCommands()

Description copied from interface: RedisCommandsProvider

Get RedisSetCommands.

Specified by:

setCommands in interface RedisCommandsProvider

Overrides:

setCommands in class LettuceConnection

Returns:

never null.

serverCommands

public RedisClusterServerCommands serverCommands()

Description copied from interface: RedisCommandsProvider

Get RedisServerCommands.

Specified by:

serverCommands in interface RedisClusterCommandsProvider

Specified by:

serverCommands in interface RedisCommandsProvider

Overrides:

serverCommands in class LettuceConnection

Returns:

never null.

stringCommands

public RedisStringCommands stringCommands()

Description copied from interface: RedisCommandsProvider

Get RedisStringCommands.

Specified by:

stringCommands in interface RedisCommandsProvider

Overrides:

stringCommands in class LettuceConnection

Returns:

never null.

zSetCommands

public RedisZSetCommands zSetCommands()

Description copied from interface: RedisCommandsProvider

Get RedisZSetCommands.

Specified by:

zSetCommands in interface RedisCommandsProvider

Overrides:

zSetCommands in class LettuceConnection

Returns:

never null.

ping

public String ping()

Description copied from interface: RedisConnectionCommands

Test connection.

Specified by:

ping in interface RedisConnectionCommands

Overrides:

ping in class LettuceConnection

Returns:

Server response message - usually PONG. null when used in pipeline / transaction.

See Also:

• Redis Documentation: PING

ping

public String ping(RedisClusterNode node)

Specified by:

ping in interface RedisClusterConnection

Parameters:

node - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• RedisConnectionCommands.ping()

clusterGetNodes

public List<RedisClusterNode> clusterGetNodes()

Description copied from interface: RedisClusterCommands

Retrieve cluster node information such as id, host, port and slots.

Specified by:

clusterGetNodes in interface RedisClusterCommands

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER NODES

clusterGetReplicas

public Set<RedisClusterNode> clusterGetReplicas(RedisClusterNode master)

Description copied from interface: RedisClusterCommands

Retrieve information about connected replicas for given master node.

Specified by:

clusterGetReplicas in interface RedisClusterCommands

Parameters:

master - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetMasterReplicaMap

public Map<RedisClusterNode,Collection<RedisClusterNode>> clusterGetMasterReplicaMap()

Description copied from interface: RedisClusterCommands

Retrieve information about masters and their connected replicas.

Specified by:

clusterGetMasterReplicaMap in interface RedisClusterCommands

Returns:

never null.

See Also:

• Redis Documentation: CLUSTER REPLICAS

clusterGetSlotForKey

public Integer clusterGetSlotForKey(byte[] key)

Description copied from interface: RedisClusterCommands

Find the slot for a given key.

Specified by:

clusterGetSlotForKey in interface RedisClusterCommands

Parameters:

key - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER KEYSLOT

clusterGetNodeForSlot

public RedisClusterNode clusterGetNodeForSlot(int slot)

Description copied from interface: RedisClusterCommands

Find the RedisClusterNode serving given slot.

Specified by:

clusterGetNodeForSlot in interface RedisClusterCommands

Returns:

clusterGetNodeForKey

public RedisClusterNode clusterGetNodeForKey(byte[] key)

Description copied from interface: RedisClusterCommands

Find the RedisClusterNode serving given key.

Specified by:

clusterGetNodeForKey in interface RedisClusterCommands

Parameters:

key - must not be null.

Returns:

clusterGetClusterInfo

public ClusterInfo clusterGetClusterInfo()

Description copied from interface: RedisClusterCommands

Get cluster information.

Specified by:

clusterGetClusterInfo in interface RedisClusterCommands

Returns:

See Also:

• Redis Documentation: CLUSTER INFO

clusterAddSlots

public void clusterAddSlots(RedisClusterNode node,
 int... slots)

Description copied from interface: RedisClusterCommands

Assign slots to given RedisClusterNode.

Specified by:

clusterAddSlots in interface RedisClusterCommands

Parameters:

node - must not be null.

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterAddSlots

public void clusterAddSlots(RedisClusterNode node,
 RedisClusterNode.SlotRange range)

Description copied from interface: RedisClusterCommands

Assign RedisClusterNode.SlotRange.getSlotsArray() to given RedisClusterNode.

Specified by:

clusterAddSlots in interface RedisClusterCommands

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterCountKeysInSlot

public Long clusterCountKeysInSlot(int slot)

Description copied from interface: RedisClusterCommands

Count the number of keys assigned to one slot.

Specified by:

clusterCountKeysInSlot in interface RedisClusterCommands

Returns:

See Also:

• Redis Documentation: CLUSTER COUNTKEYSINSLOT

clusterDeleteSlots

public void clusterDeleteSlots(RedisClusterNode node,
 int... slots)

Description copied from interface: RedisClusterCommands

Remove slots from RedisClusterNode.

Specified by:

clusterDeleteSlots in interface RedisClusterCommands

Parameters:

node - must not be null.

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

public void clusterDeleteSlotsInRange(RedisClusterNode node,
 RedisClusterNode.SlotRange range)

Description copied from interface: RedisClusterCommands

Removes RedisClusterNode.SlotRange.getSlotsArray() from given RedisClusterNode.

Specified by:

clusterDeleteSlotsInRange in interface RedisClusterCommands

Parameters:

node - must not be null.

range - must not be null.

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterForget

public void clusterForget(RedisClusterNode node)

Description copied from interface: RedisClusterCommands

Remove given node from cluster.

Specified by:

clusterForget in interface RedisClusterCommands

Parameters:

node - must not be null.

See Also:

• Redis Documentation: CLUSTER FORGET

clusterMeet

public void clusterMeet(RedisClusterNode node)

Description copied from interface: RedisClusterCommands

Add given node to cluster.

Specified by:

clusterMeet in interface RedisClusterCommands

Parameters:

node - must contain host and RedisNode.getPort() and must not be null.

See Also:

• Redis Documentation: CLUSTER MEET

clusterSetSlot

public void clusterSetSlot(RedisClusterNode node,
 int slot,
 RedisClusterCommands.AddSlots mode)

Specified by:

clusterSetSlot in interface RedisClusterCommands

Parameters:

node - must not be null.

mode - must not benull.

See Also:

• Redis Documentation: CLUSTER SETSLOT

clusterGetKeysInSlot

public List<byte[]> clusterGetKeysInSlot(int slot,
 Integer count)

Description copied from interface: RedisClusterCommands

Get keys served by slot.

Specified by:

clusterGetKeysInSlot in interface RedisClusterCommands

count - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER GETKEYSINSLOT

clusterReplicate

public void clusterReplicate(RedisClusterNode master,
 RedisClusterNode replica)

Description copied from interface: RedisClusterCommands

Assign a replica to given master.

Specified by:

clusterReplicate in interface RedisClusterCommands

Parameters:

master - must not be null.

replica - must not be null.

See Also:

• Redis Documentation: CLUSTER REPLICATE

keys

public Set<byte[]> keys(RedisClusterNode node,
 byte[] pattern)

Specified by:

keys in interface RedisClusterConnection

Parameters:

node - must not be null.

pattern - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

• RedisKeyCommands.keys(byte[])

scan

public Cursor<byte[]> scan(RedisClusterNode node,
 ScanOptions options)

Description copied from interface: RedisClusterConnection

Use a Cursor to iterate over keys.

Specified by:

scan in interface RedisClusterConnection

Parameters:

node - must not be null.

options - must not be null.

Returns:

never null.

See Also:

• Redis Documentation: SCAN

randomKey

public byte[] randomKey(RedisClusterNode node)

Specified by:

randomKey in interface RedisClusterConnection

Parameters:

node - must not be null.

Returns:

null when no keys stored at node or when used in pipeline / transaction.

See Also:

• RedisKeyCommands.randomKey()

select

public void select(int dbIndex)

Description copied from interface: RedisConnectionCommands

Select the DB with given positive dbIndex.

Specified by:

select in interface RedisConnectionCommands

Overrides:

select in class LettuceConnection

Parameters:

dbIndex - the database index.

See Also:

• Redis Documentation: SELECT

watch

public void watch(byte[]... keys)

Description copied from interface: RedisTxCommands

Watch given keys for modifications during transaction started with RedisTxCommands.multi().

Specified by:

watch in interface RedisTxCommands

Overrides:

watch in class LettuceConnection

Parameters:

keys - must not be null.

See Also:

• Redis Documentation: WATCH

unwatch

public void unwatch()

Description copied from interface: RedisTxCommands

Flushes all the previously RedisTxCommands.watch(byte[]...) keys.

Specified by:

unwatch in interface RedisTxCommands

Overrides:

unwatch in class LettuceConnection

See Also:

• Redis Documentation: UNWATCH

multi

public void multi()

Description copied from interface: RedisTxCommands

Mark the start of a transaction block.
Commands will be queued and can then be executed by calling RedisTxCommands.exec() or rolled back using RedisTxCommands.discard()

Specified by:

multi in interface RedisTxCommands

Overrides:

multi in class LettuceConnection

See Also:

• Redis Documentation: MULTI

getClusterCommandExecutor

public ClusterCommandExecutor getClusterCommandExecutor()

close

public void close()
           throws DataAccessException

Description copied from interface: RedisConnection

Closes (or quits) the connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RedisConnection

Overrides:

close in class LettuceConnection

Throws:

DataAccessException