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:

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

public class LettuceClusterConnection
extends LettuceConnection
implements DefaultedRedisClusterConnection

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 interface org.springframework.data.redis.connection.RedisClusterCommands

RedisClusterCommands.AddSlots

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

RedisListCommands.Position

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

RedisZSetCommands.Aggregate, RedisZSetCommands.Limit, RedisZSetCommands.Range, RedisZSetCommands.Tuple

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

RedisGeoCommands.DistanceUnit, RedisGeoCommands.GeoLocation<T>, RedisGeoCommands.GeoRadiusCommandArgs

Constructor Summary

Constructors

Constructor and Description
LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient) Creates new LettuceClusterConnection using RedisClusterClient.
LettuceClusterConnection(io.lettuce.core.cluster.RedisClusterClient clusterClient, ClusterCommandExecutor executor) Creates new LettuceClusterConnection using RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.

Method Summary

Modifier and Type	Method and 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.
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>>	clusterGetMasterSlaveMap() Retrieve information about masters and their connected slaves.
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>	clusterGetSlaves(RedisClusterNode master) Retrieve information about connected slaves 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 slave) Assign a slave to given master.
void	clusterSetSlot(RedisClusterNode node, int slot, RedisClusterCommands.AddSlots mode)
protected io.lettuce.core.api.StatefulConnection<byte[],byte[]>	doGetAsyncDedicatedConnection()
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)
void	select(int dbIndex) Select the DB with given positive dbIndex.
RedisClusterServerCommands	serverCommands() Get RedisServerCommands.
RedisSetCommands	setCommands() Get RedisSetCommands.
RedisStringCommands	stringCommands() Get RedisStringCommands.
protected io.lettuce.core.pubsub.StatefulRedisPubSubConnection<byte[],byte[]>	switchToPubSub() LettuceConnection.close() the current connection and open a new pub/sub connection to the Redis server.
void	unwatch() Flushes all the previously #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, convertLettuceAccessException, discard, echo, exec, execute, execute, getAsyncDedicatedConnection, getConnection, getNativeConnection, getSentinelConnection, getSubscription, isActive, isClosed, isPipelined, isQueueing, isSubscribed, openPipeline, pSubscribe, publish, scriptingCommands, setConvertPipelineAndTxResults, subscribe

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, flushDb, getClientList, getConfig, info, info, lastSave, resetConfigStats, save, setConfig, shutdown, time

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

append, bgReWriteAof, bgSave, bgWriteAof, bitCount, bitCount, bitOp, bLPop, bRPop, bRPopLPush, dbSize, decr, decrBy, del, dump, eval, evalSha, evalSha, exists, expire, expireAt, flushAll, flushDb, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRemove, get, getBit, getClientList, getClientName, getConfig, getRange, getSet, hDel, hExists, hGet, hGetAll, hIncrBy, hIncrBy, hKeys, hLen, hMGet, hMSet, hScan, hSet, hSetNX, hVals, incr, incrBy, incrBy, info, info, keys, killClient, lastSave, lIndex, lInsert, lLen, lPop, lPush, lPushX, lRange, lRem, lSet, lTrim, mGet, migrate, migrate, move, mSet, mSetNX, persist, pExpire, pExpireAt, pfAdd, pfCount, pfMerge, pSetEx, pTtl, pTtl, randomKey, rename, renameNX, resetConfigStats, restore, 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, slaveOf, slaveOfNoOne, sMembers, sMove, sort, sort, sPop, sRandMember, sRandMember, sRem, sScan, strLen, sUnion, sUnionStore, time, ttl, ttl, type, zAdd, zAdd, zCard, zCount, zCount, zIncrBy, zInterStore, zInterStore, zRange, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeWithScores, zRank, zRem, zRemRange, zRemRangeByScore, zRemRangeByScore, zRevRange, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeWithScores, zRevRank, zScan, zScore, zUnionStore, zUnionStore

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

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

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

execute

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

zRangeByLex, zRangeByLex, zRangeByScore, zRangeByScore, zRangeByScore, zRangeByScoreWithScores, zRangeByScoreWithScores, zRangeByScoreWithScores, zRevRangeByScore, zRevRangeByScore, zRevRangeByScore, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores, zRevRangeByScoreWithScores

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

discard, exec

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

getSubscription, isSubscribed, pSubscribe, publish, subscribe

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

echo

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

geoAdd, geoRadiusByMember

Constructor Detail

LettuceClusterConnection

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

Creates new LettuceClusterConnection using RedisClusterClient.

Parameters:

clusterClient - must not be null.

LettuceClusterConnection

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

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

Parameters:

clusterClient - must not be null.

executor - must not be null.

Method Detail

geoCommands

public RedisGeoCommands geoCommands()

Description copied from interface: RedisConnection

Get RedisGeoCommands.

Specified by:

geoCommands in interface RedisConnection

Overrides:

geoCommands in class LettuceConnection

Returns:

never null.

hashCommands

public RedisHashCommands hashCommands()

Description copied from interface: RedisConnection

Get RedisHashCommands.

Specified by:

hashCommands in interface RedisConnection

Overrides:

hashCommands in class LettuceConnection

Returns:

never null.

hyperLogLogCommands

public RedisHyperLogLogCommands hyperLogLogCommands()

Description copied from interface: RedisConnection

Get RedisHyperLogLogCommands.

Specified by:

hyperLogLogCommands in interface RedisConnection

Overrides:

hyperLogLogCommands in class LettuceConnection

Returns:

never null.

keyCommands

public RedisKeyCommands keyCommands()

Description copied from interface: RedisConnection

Get RedisKeyCommands.

Specified by:

keyCommands in interface RedisConnection

Overrides:

keyCommands in class LettuceConnection

Returns:

never null.

listCommands

public RedisListCommands listCommands()

Description copied from interface: RedisConnection

Get RedisListCommands.

Specified by:

listCommands in interface RedisConnection

Overrides:

listCommands in class LettuceConnection

Returns:

never null.

stringCommands

public RedisStringCommands stringCommands()

Description copied from interface: RedisConnection

Get RedisStringCommands.

Specified by:

stringCommands in interface RedisConnection

Overrides:

stringCommands in class LettuceConnection

Returns:

never null.

setCommands

public RedisSetCommands setCommands()

Description copied from interface: RedisConnection

Get RedisSetCommands.

Specified by:

setCommands in interface RedisConnection

Overrides:

setCommands in class LettuceConnection

Returns:

never null.

zSetCommands

public RedisZSetCommands zSetCommands()

Description copied from interface: RedisConnection

Get RedisZSetCommands.

Specified by:

zSetCommands in interface RedisConnection

Overrides:

zSetCommands in class LettuceConnection

Returns:

never null.

serverCommands

public RedisClusterServerCommands serverCommands()

Description copied from interface: RedisConnection

Get RedisServerCommands.

Specified by:

serverCommands in interface RedisClusterConnection

Specified by:

serverCommands in interface RedisConnection

Overrides:

serverCommands in class LettuceConnection

Returns:

never null.

clusterGetSlaves

public Set<RedisClusterNode> clusterGetSlaves(RedisClusterNode master)

Description copied from interface: RedisClusterCommands

Retrieve information about connected slaves for given master node.

Specified by:

clusterGetSlaves in interface RedisClusterCommands

Parameters:

master - must not be null.

Returns:

never null.

See Also:

Redis Documentation: CLUSTER SLAVES

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

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

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

clusterReplicate

public void clusterReplicate(RedisClusterNode master,
                             RedisClusterNode slave)

Description copied from interface: RedisClusterCommands

Assign a slave to given master.

Specified by:

clusterReplicate in interface RedisClusterCommands

Parameters:

master - must not be null.

slave - must not be null.

See Also:

Redis Documentation: CLUSTER REPLICATE

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.

See Also:

Redis Documentation: PING

ping

public String ping(RedisClusterNode node)

Specified by:

ping in interface RedisClusterConnection

Parameters:

node - must not be null.

Returns:

See Also:

RedisConnectionCommands.ping()

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:

See Also:

RedisKeyCommands.keys(byte[])

randomKey

public byte[] randomKey(RedisClusterNode node)

Specified by:

randomKey in interface RedisClusterConnection

Parameters:

node - must not be null.

Returns:

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

doGetAsyncDedicatedConnection

protected io.lettuce.core.api.StatefulConnection<byte[],byte[]> doGetAsyncDedicatedConnection()

Overrides:

doGetAsyncDedicatedConnection in class LettuceConnection

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

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 #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

clusterGetMasterSlaveMap

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

Description copied from interface: RedisClusterCommands

Retrieve information about masters and their connected slaves.

Specified by:

clusterGetMasterSlaveMap in interface RedisClusterCommands

Returns:

never null.

See Also:

Redis Documentation: CLUSTER SLAVES

switchToPubSub

protected io.lettuce.core.pubsub.StatefulRedisPubSubConnection<byte[],byte[]> switchToPubSub()

Description copied from class: LettuceConnection

LettuceConnection.close() the current connection and open a new pub/sub connection to the Redis server.

Overrides:

switchToPubSub in class LettuceConnection

Returns:

never null.

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 RedisConnection

Overrides:

close in class LettuceConnection

Throws:

DataAccessException