Class JedisClusterConnection

java.lang.Object

org.springframework.data.redis.connection.AbstractRedisConnection

org.springframework.data.redis.connection.jedis.JedisConnection

org.springframework.data.redis.connection.jedis.JedisClusterConnection

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

@NullUnmarked
public class JedisClusterConnection
extends JedisConnection
implements RedisClusterConnection

RedisClusterConnection implementation on top of RedisClusterClient.

Uses the native RedisClusterClient api where possible and falls back to direct node communication using Jedis where needed.

Pipelines and transactions are not supported in cluster mode. This class is not Thread-safe and instances should not be shared across threads.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch, Ninad Divadkar, Tao Chen, Chen Guanqun, Pavel Khokhlov, Liming Deng, John Blum, Tihomir Mateev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	JedisClusterConnection.JedisClusterCommandCallback<T>	Jedis specific ClusterCommandExecutor.ClusterCommandCallback.
protected static class	JedisClusterConnection.JedisClusterTopology
static class	JedisClusterConnection.JedisClusterTopologyProvider	Jedis specific implementation of ClusterTopologyProvider.
protected static interface	JedisClusterConnection.JedisMultiKeyClusterCommandCallback<T>	Jedis specific ClusterCommandExecutor.MultiKeyClusterCommandCallback.

Nested classes/interfaces inherited from interface RedisClusterCommands

RedisClusterCommands.AddSlots

Nested classes/interfaces inherited from interface RedisGeoCommands

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

Nested classes/interfaces inherited from interface RedisHashCommands

RedisHashCommands.HashFieldSetOption

Nested classes/interfaces inherited from interface RedisListCommands

RedisListCommands.Direction, RedisListCommands.Position

Nested classes/interfaces inherited from interface RedisServerCommands

RedisServerCommands.FlushOption, RedisServerCommands.MigrateOption, RedisServerCommands.ShutdownOption

Nested classes/interfaces inherited from interface RedisStreamCommands

RedisStreamCommands.MaxLenTrimStrategy, RedisStreamCommands.MinIdTrimStrategy, RedisStreamCommands.StreamDeletionPolicy, RedisStreamCommands.StreamEntryDeletionResult, RedisStreamCommands.TrimOperator, RedisStreamCommands.TrimOptions, RedisStreamCommands.TrimStrategy, RedisStreamCommands.XAddOptions, RedisStreamCommands.XClaimOptions, RedisStreamCommands.XDelOptions, RedisStreamCommands.XPendingOptions, RedisStreamCommands.XTrimOptions

Nested classes/interfaces inherited from interface RedisStringCommands

RedisStringCommands.BitOperation, RedisStringCommands.SetOption

Nested classes/interfaces inherited from interface RedisZSetCommands

RedisZSetCommands.Limit, RedisZSetCommands.Range, RedisZSetCommands.ZAddArgs

Constructor Summary

Constructors

Constructor	Description
JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster)	Deprecated. since 4.1, use JedisClusterConnection(RedisClusterClient) instead.
JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster, @NonNull ClusterCommandExecutor executor)	Deprecated. since 4.1, use JedisClusterConnection([email protected] RedisClusterClient,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterCommandExecutor) instead.
JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster, @NonNull ClusterCommandExecutor executor, @NonNull ClusterTopologyProvider topologyProvider)	Deprecated. since 4.1, use JedisClusterConnection([email protected] RedisClusterClient,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterCommandExecutor,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterTopologyProvider) instead.
JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster)	Create new JedisClusterConnection utilizing native connections via RedisClusterClient based RedisClusterClient.
JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster, @NonNull ClusterCommandExecutor executor)	Create new JedisClusterConnection utilizing native connections via RedisClusterClient running commands across the cluster via given ClusterCommandExecutor.
JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster, @NonNull ClusterCommandExecutor executor, @NonNull ClusterTopologyProvider topologyProvider)	Create new JedisClusterConnection utilizing native connections via RedisClusterClient running commands across the cluster via given ClusterCommandExecutor and using the given ClusterTopologyProvider.

Method Summary

Modifier and Type	Method	Description
List<Object>	closePipeline()	Executes the commands in the pipeline and returns their result.
void	clusterAddSlots(@NonNull RedisClusterNode node, int @NonNull ... slots)	Assign slots to given RedisClusterNode.
void	clusterAddSlots(@NonNull RedisClusterNode node, @NonNull 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(@NonNull RedisClusterNode node, int @NonNull ... slots)	Remove slots from RedisClusterNode.
void	clusterDeleteSlotsInRange(@NonNull RedisClusterNode node, @NonNull RedisClusterNode.SlotRange range)	Removes RedisClusterNode.SlotRange.getSlotsArray() from given RedisClusterNode.
void	clusterForget(@NonNull RedisClusterNode node)	Remove given node from cluster.
ClusterInfo	clusterGetClusterInfo()	Get cluster information.
List<byte[]>	clusterGetKeysInSlot(int slot, @NonNull Integer count)	Get keys served by slot.
Map<RedisClusterNode, Collection<RedisClusterNode>>	clusterGetMasterReplicaMap()	Retrieve information about masters and their connected replicas.
RedisClusterNode	clusterGetNodeForKey(byte @NonNull [] key)	Find the RedisClusterNode serving given key.
RedisClusterNode	clusterGetNodeForSlot(int slot)	Find the RedisClusterNode serving given slot.
Set<RedisClusterNode>	clusterGetNodes()	Retrieve cluster node information such as id, host, port and slots.
Set<RedisClusterNode>	clusterGetReplicas(@NonNull RedisClusterNode master)	Retrieve information about connected replicas for given master node.
Integer	clusterGetSlotForKey(byte @NonNull [] key)	Find the slot for a given key.
void	clusterMeet(@NonNull RedisClusterNode node)	Add given node to cluster.
void	clusterReplicate(@NonNull RedisClusterNode master, @NonNull RedisClusterNode replica)	Assign a replica to given master.
void	clusterSetSlot(@NonNull RedisClusterNode node, int slot, @NonNull RedisClusterCommands.AddSlots mode)
RedisCommands	commands()	Get RedisCommands.
void	discard()	Discard all commands issued after RedisTxCommands.multi().
protected void	doClose()	Performs the actual close operation.
byte[]	echo(byte @NonNull [] message)	Returns message via server roundtrip.
List<Object>	exec()	Executes all queued commands in a transaction started with RedisTxCommands.multi().
Object	execute(@NonNull String command, byte @NonNull [] @NonNull ... args)	Native or raw execution of the given Redis command along with the given arguments.
<T> T	execute(@NonNull String command, byte @NonNull [] key, @NonNull Collection<byte @NonNull []> args)	Execute the given command for the key provided potentially appending args.
<T> List<T>	execute(@NonNull String command, @NonNull Collection<byte @NonNull []> keys, @NonNull Collection<byte @NonNull []> args)	Execute the given command for each key in keys provided appending all args on each invocation.
RedisGeoCommands	geoCommands()	Get RedisGeoCommands.
protected redis.clients.jedis.UnifiedJedis	getCluster()
protected ClusterCommandExecutor	getClusterCommandExecutor()
redis.clients.jedis.UnifiedJedis	getJedis()	Returns the underlying UnifiedJedis instance.
redis.clients.jedis.UnifiedJedis	getNativeConnection()	Returns the native connection (the underlying library/driver object).
RedisSentinelConnection	getSentinelConnection()
protected ClusterTopologyProvider	getTopologyProvider()
RedisHashCommands	hashCommands()	Get RedisHashCommands.
RedisHyperLogLogCommands	hyperLogLogCommands()	Get RedisHyperLogLogCommands.
boolean	isClosed()	Indicates whether the underlying connection is closed or not.
boolean	isPipelined()	Indicates whether the connection is currently pipelined or not.
boolean	isQueueing()	Indicates whether the connection is in "queue"(or "MULTI") mode or not.
RedisKeyCommands	keyCommands()	Get RedisKeyCommands.
Set<byte[]>	keys(RedisClusterNode node, byte[] pattern)
RedisListCommands	listCommands()	Get RedisListCommands.
void	multi()	Mark the start of a transaction block.
void	openPipeline()	Activates the pipeline mode for this connection.
String	ping()	Test connection.
String	ping(@NonNull RedisClusterNode node)
byte[]	randomKey(RedisClusterNode node)
void	rewriteConfig()	Rewrites the redis.conf file.
Cursor<byte[]>	scan(RedisClusterNode node, ScanOptions options)	Use a Cursor to iterate over keys.
RedisScriptingCommands	scriptingCommands()	Get RedisScriptingCommands.
void	select(int dbIndex)	Select the DB with given positive dbIndex.
RedisClusterServerCommands	serverCommands()	Get RedisServerCommands.
RedisSetCommands	setCommands()	Get RedisSetCommands.
RedisStreamCommands	streamCommands()	Get RedisStreamCommands.
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 JedisConnection

close, convertJedisAccessException, getJedis, getPipeline, getRequiredPipeline, getRequiredTransaction, getSentinelConnection, getSubscription, getTransaction, isActive, isSubscribed, pSubscribe, publish, setConvertPipelineAndTxResults, subscribe

Methods inherited from class AbstractRedisConnection

hasRedisSentinelConfigured, setSentinelConfiguration

Methods inherited from class Object

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

Methods inherited from interface DefaultedRedisClusterConnection

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

Methods inherited from interface DefaultedRedisConnection

append, applyHashFieldExpiration, bgReWriteAof, bgSave, bitCount, bitCount, bitField, bitOp, bitPos, bLMove, bLPop, bRPop, bRPopLPush, bZPopMax, bZPopMin, copy, dbSize, decr, decrBy, del, delex, digest, dump, encodingOf, eval, evalSha, evalSha, exists, exists, expire, expire, expireAt, 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, hExpire, hExpire, hExpireAt, hExpireAt, hGet, hGetAll, hGetDel, hGetEx, hIncrBy, hIncrBy, hKeys, hLen, hMGet, hMSet, hPersist, hpExpire, hpExpire, hpExpireAt, hpExpireAt, hpTtl, hRandField, hRandField, hRandFieldWithValues, hRandFieldWithValues, hScan, hSet, hSetEx, hSetNX, hStrLen, hTtl, hTtl, 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, pExpire, pExpireAt, pExpireAt, pfAdd, pfCount, pfMerge, pSetEx, pTtl, pTtl, randomKey, refcount, rename, renameNX, replicaOf, replicaOfNoOne, resetConfigStats, restore, rPop, rPop, rPopLPush, rPush, rPushX, sAdd, save, scan, sCard, scriptExists, scriptFlush, scriptKill, scriptLoad, sDiff, sDiffStore, set, set, setBit, setClientName, setConfig, setEx, setGet, setNX, setRange, shutdown, shutdown, sInter, sInterCard, sInterStore, sIsMember, sMembers, sMIsMember, sMove, sort, sort, sPop, sPop, sRandMember, sRandMember, sRem, sScan, strLen, sUnion, sUnionStore, time, time, touch, ttl, ttl, type, unlink, xAck, xAckDel, xAdd, xClaim, xClaimJustId, xDel, xDelEx, xGroupCreate, xGroupCreate, xGroupDelConsumer, xGroupDestroy, xInfo, xInfoConsumers, xInfoGroups, xLen, xPending, xPending, xRange, xRange, xRead, xRead, xReadGroup, xReadGroup, xRevRange, xRevRange, xTrim, 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 RedisConnection

close

Methods inherited from interface RedisGeoCommands

geoAdd, geoRadiusByMember

Methods inherited from interface RedisHashCommands

applyHashFieldExpiration, hExpire, hpExpire

Methods inherited from interface RedisKeyCommands

applyExpiration, expire, expireAt, pExpire, pExpireAt, restore, scan

Methods inherited from interface RedisListCommands

lPos

Methods inherited from interface RedisPubSubCommands

getSubscription, isSubscribed, pSubscribe, publish, subscribe

Methods inherited from interface RedisStreamCommands

xAck, xAckDel, xAdd, xAdd, xClaim, xDel, xDelEx, xGroupDelConsumer, xPending, xPending, xPending, xPending, xPending, xPending, xPending, xPending

Methods inherited from interface RedisStringCommands

bitPos, set, setGet

Methods inherited from interface 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

JedisClusterConnection

@Deprecated(since="4.1")
public JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster)

Deprecated.

since 4.1, use JedisClusterConnection(RedisClusterClient) instead.

Create new JedisClusterConnection utilizing native connections via UnifiedJedis based RedisClusterClient.

Parameters:

cluster - must not be null.

JedisClusterConnection

public JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster)

Create new JedisClusterConnection utilizing native connections via RedisClusterClient based RedisClusterClient.

Parameters:

cluster - must not be null.

Since:

4.1

JedisClusterConnection

public JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster,
 @NonNull ClusterCommandExecutor executor)

Create new JedisClusterConnection utilizing native connections via RedisClusterClient running commands across the cluster via given ClusterCommandExecutor. Uses JedisClusterConnection.JedisClusterTopologyProvider by default.

Parameters:

cluster - must not be null.

executor - must not be null.

Since:

4.1

JedisClusterConnection

public JedisClusterConnection(@NonNull redis.clients.jedis.RedisClusterClient cluster,
 @NonNull ClusterCommandExecutor executor,
 @NonNull ClusterTopologyProvider topologyProvider)

Create new JedisClusterConnection utilizing native connections via RedisClusterClient running commands across the cluster via given ClusterCommandExecutor and using the given ClusterTopologyProvider.

Parameters:

cluster - must not be null.

executor - must not be null.

topologyProvider - must not be null.

Since:

4.1

JedisClusterConnection

@Deprecated(since="4.1")
public JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster,
 @NonNull ClusterCommandExecutor executor)

Deprecated.

since 4.1, use JedisClusterConnection([email protected] RedisClusterClient,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterCommandExecutor) instead.

Create new JedisClusterConnection utilizing native connections via JedisCluster running commands across the cluster via given ClusterCommandExecutor. Uses JedisClusterConnection.JedisClusterTopologyProvider by default.

Parameters:

cluster - must not be null.

executor - must not be null.

JedisClusterConnection

@Deprecated(since="4.1")
public JedisClusterConnection(@NonNull redis.clients.jedis.JedisCluster cluster,
 @NonNull ClusterCommandExecutor executor,
 @NonNull ClusterTopologyProvider topologyProvider)

Deprecated.

since 4.1, use JedisClusterConnection([email protected] RedisClusterClient,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterCommandExecutor,org.springframework.data.redis.connection.@org.jspecify.annotations.NonNull ClusterTopologyProvider) instead.

Create new JedisClusterConnection utilizing native connections via JedisCluster running commands across the cluster via given ClusterCommandExecutor and using the given ClusterTopologyProvider.

Parameters:

cluster - must not be null.

executor - must not be null.

topologyProvider - must not be null.

Since:

2.2

Method Details

execute

public Object execute(@NonNull String command,
 byte @NonNull [] @NonNull ... args)

Description copied from interface: RedisCommands

Native or raw execution of the given Redis command along with the given arguments.

The command is executed as is, with as little interpretation as possible - it is up to the caller to take care of any processing of arguments or the result.

Specified by:

execute in interface RedisCommands

Overrides:

execute in class JedisConnection

Parameters:

command - Redis command to execute; must not be null.

args - optional array of command arguments; may be empty;

Returns:

the execution result; may be null.

execute

public <T> T execute(@NonNull String command,
 byte @NonNull [] key,
 @NonNull Collection<byte @NonNull []> args)

Description copied from interface: RedisClusterConnection

Execute the given command for the key provided potentially appending args.
This method, other than RedisCommands.execute(String, byte[]...), dispatches the command to the key serving master node.

// SET foo bar EX 10 NX
execute("SET", "foo".getBytes(), asBinaryList("bar", "EX", 10, "NX"))

Specified by:

execute in interface RedisClusterConnection

Parameters:

command - must not be null.

key - must not be null.

args - must not be null.

Returns:

command result as delivered by the underlying Redis driver. Can be null.

execute

public <T> List<T> execute(@NonNull String command,
 @NonNull Collection<byte @NonNull []> keys,
 @NonNull Collection<byte @NonNull []> args)

Execute the given command for each key in keys provided appending all args on each invocation.
This method, other than execute(String, byte[]...), dispatches the command to the key serving master node and appends the key as first command argument to the command. keys are not required to share the same slot for single-key commands. Multi-key commands carrying their keys in args still require to share the same slot as the key.

// SET foo bar EX 10 NX
execute("SET", "foo".getBytes(), asBinaryList("bar", "EX", 10, "NX"))

Parameters:

command - must not be null.

keys - must not be null.

args - must not be null.

Returns:

command result as delivered by the underlying Redis driver. Can be null.

Since:

2.1

commands

public RedisCommands commands()

Description copied from interface: RedisCommandsProvider

Get RedisCommands.

Specified by:

commands in interface RedisCommandsProvider

Overrides:

commands in class JedisConnection

Returns:

never null.

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 JedisConnection

Returns:

never null.

hashCommands

public RedisHashCommands hashCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHashCommands.

Specified by:

hashCommands in interface RedisCommandsProvider

Overrides:

hashCommands in class JedisConnection

Returns:

never null.

hyperLogLogCommands

public RedisHyperLogLogCommands hyperLogLogCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHyperLogLogCommands.

Specified by:

hyperLogLogCommands in interface RedisCommandsProvider

Overrides:

hyperLogLogCommands in class JedisConnection

Returns:

never null.

keyCommands

public RedisKeyCommands keyCommands()

Description copied from interface: RedisCommandsProvider

Get RedisKeyCommands.

Specified by:

keyCommands in interface RedisCommandsProvider

Overrides:

keyCommands in class JedisConnection

Returns:

never null.

listCommands

public RedisListCommands listCommands()

Description copied from interface: RedisCommandsProvider

Get RedisListCommands.

Specified by:

listCommands in interface RedisCommandsProvider

Overrides:

listCommands in class JedisConnection

Returns:

never null.

setCommands

public RedisSetCommands setCommands()

Description copied from interface: RedisCommandsProvider

Get RedisSetCommands.

Specified by:

setCommands in interface RedisCommandsProvider

Overrides:

setCommands in class JedisConnection

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 JedisConnection

Returns:

never null.

streamCommands

public RedisStreamCommands streamCommands()

Description copied from interface: RedisCommandsProvider

Get RedisStreamCommands.

Specified by:

streamCommands in interface RedisCommandsProvider

Overrides:

streamCommands in class JedisConnection

Returns:

never null.

stringCommands

public RedisStringCommands stringCommands()

Description copied from interface: RedisCommandsProvider

Get RedisStringCommands.

Specified by:

stringCommands in interface RedisCommandsProvider

Overrides:

stringCommands in class JedisConnection

Returns:

never null.

zSetCommands

public RedisZSetCommands zSetCommands()

Description copied from interface: RedisCommandsProvider

Get RedisZSetCommands.

Specified by:

zSetCommands in interface RedisCommandsProvider

Overrides:

zSetCommands in class JedisConnection

Returns:

never null.

scriptingCommands

public RedisScriptingCommands scriptingCommands()

Description copied from interface: RedisCommandsProvider

Get RedisScriptingCommands.

Specified by:

scriptingCommands in interface RedisCommandsProvider

Overrides:

scriptingCommands in class JedisConnection

Returns:

never null.

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

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 JedisConnection

See Also:

• Redis Documentation: MULTI

exec

public List<Object> exec()

Description copied from interface: RedisTxCommands

Executes all queued commands in a transaction started with RedisTxCommands.multi().
If used along with RedisTxCommands.watch(byte[]...) the operation will fail if any of watched keys has been modified.

Specified by:

exec in interface RedisTxCommands

Overrides:

exec in class JedisConnection

Returns:

List of replies for each executed command.

See Also:

• Redis Documentation: EXEC

discard

public void discard()

Description copied from interface: RedisTxCommands

Discard all commands issued after RedisTxCommands.multi().

Specified by:

discard in interface RedisTxCommands

Overrides:

discard in class JedisConnection

See Also:

• Redis Documentation: DISCARD

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 JedisConnection

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 JedisConnection

See Also:

• Redis Documentation: UNWATCH

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 JedisConnection

Parameters:

dbIndex - the database index.

See Also:

• Redis Documentation: SELECT

echo

public byte[] echo(byte @NonNull [] message)

Description copied from interface: RedisConnectionCommands

Returns message via server roundtrip.

Specified by:

echo in interface RedisConnectionCommands

Overrides:

echo in class JedisConnection

Parameters:

message - the message to echo.

Returns:

the message or null when used in pipeline / transaction.

See Also:

• Redis Documentation: ECHO

ping

public String ping()

Description copied from interface: RedisConnectionCommands

Test connection.

Specified by:

ping in interface RedisConnectionCommands

Overrides:

ping in class JedisConnection

Returns:

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

See Also:

• Redis Documentation: PING

ping

public String ping(@NonNull 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()

clusterSetSlot

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

Specified by:

clusterSetSlot in interface RedisClusterCommands

Parameters:

node - must not be null.

slot -

mode - must not benull.

See Also:

• Redis Documentation: CLUSTER SETSLOT

clusterGetKeysInSlot

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

Description copied from interface: RedisClusterCommands

Get keys served by slot.

Specified by:

clusterGetKeysInSlot in interface RedisClusterCommands

Parameters:

slot -

count - must not be null.

Returns:

See Also:

• Redis Documentation: CLUSTER GETKEYSINSLOT

clusterAddSlots

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

Description copied from interface: RedisClusterCommands

Assign slots to given RedisClusterNode.

Specified by:

clusterAddSlots in interface RedisClusterCommands

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER ADDSLOTS

clusterAddSlots

public void clusterAddSlots(@NonNull RedisClusterNode node,
 @NonNull 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

Parameters:

slot -

Returns:

See Also:

• Redis Documentation: CLUSTER COUNTKEYSINSLOT

clusterDeleteSlots

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

Description copied from interface: RedisClusterCommands

Remove slots from RedisClusterNode.

Specified by:

clusterDeleteSlots in interface RedisClusterCommands

Parameters:

node - must not be null.

slots -

See Also:

• Redis Documentation: CLUSTER DELSLOTS

clusterDeleteSlotsInRange

public void clusterDeleteSlotsInRange(@NonNull RedisClusterNode node,
 @NonNull 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(@NonNull 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(@NonNull 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

clusterReplicate

public void clusterReplicate(@NonNull RedisClusterNode master,
 @NonNull 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

clusterGetSlotForKey

public Integer clusterGetSlotForKey(byte @NonNull [] 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

clusterGetNodeForKey

public RedisClusterNode clusterGetNodeForKey(byte @NonNull [] 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:

clusterGetNodeForSlot

public RedisClusterNode clusterGetNodeForSlot(int slot)

Description copied from interface: RedisClusterCommands

Find the RedisClusterNode serving given slot.

Specified by:

clusterGetNodeForSlot in interface RedisClusterCommands

Parameters:

slot -

Returns:

clusterGetNodes

public Set<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(@NonNull 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

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

doClose

protected void doClose()

Description copied from class: JedisConnection

Performs the actual close operation. Can be overridden by subclasses to customize close behavior.

Overrides:

doClose in class JedisConnection

isClosed

public boolean isClosed()

Description copied from interface: RedisConnection

Indicates whether the underlying connection is closed or not.

Specified by:

isClosed in interface RedisConnection

Overrides:

isClosed in class JedisConnection

Returns:

true if the connection is closed, false otherwise.

getNativeConnection

public redis.clients.jedis.UnifiedJedis getNativeConnection()

Description copied from interface: RedisConnection

Returns the native connection (the underlying library/driver object).

Specified by:

getNativeConnection in interface RedisConnection

Overrides:

getNativeConnection in class JedisConnection

Returns:

underlying, native object

isQueueing

public boolean isQueueing()

Description copied from interface: RedisConnection

Indicates whether the connection is in "queue"(or "MULTI") mode or not. When queueing, all commands are postponed until EXEC or DISCARD commands are issued. Since in queueing no results are returned, the connection will return NULL on all operations that interact with the data.

Specified by:

isQueueing in interface RedisConnection

Overrides:

isQueueing in class JedisConnection

Returns:

true if the connection is in queue/MULTI mode, false otherwise

isPipelined

public boolean isPipelined()

Description copied from interface: RedisConnection

Indicates whether the connection is currently pipelined or not.

Specified by:

isPipelined in interface RedisConnection

Overrides:

isPipelined in class JedisConnection

Returns:

true if the connection is pipelined, false otherwise

See Also:

• RedisConnection.openPipeline()
• RedisConnection.isQueueing()

openPipeline

public void openPipeline()

Description copied from interface: RedisConnection

Activates the pipeline mode for this connection. When pipelined, all commands return null (the reply is read at the end through RedisConnection.closePipeline(). Calling this method when the connection is already pipelined has no effect. Pipelining is used for issuing commands without requesting the response right away but rather at the end of the batch. While somewhat similar to MULTI, pipelining does not guarantee atomicity - it only tries to improve performance when issuing a lot of commands (such as in batching scenarios).

Note:

Consider doing some performance testing before using this feature since in many cases the performance benefits are minimal yet the impact on usage are not.

Specified by:

openPipeline in interface RedisConnection

Overrides:

openPipeline in class JedisConnection

See Also:

• RedisTxCommands.multi()

closePipeline

public List<Object> closePipeline()
                           throws RedisPipelineException

Description copied from interface: RedisConnection

Executes the commands in the pipeline and returns their result. If the connection is not pipelined, an empty collection is returned.

Specified by:

closePipeline in interface RedisConnection

Overrides:

closePipeline in class JedisConnection

Returns:

the result of the executed commands.

Throws:

RedisPipelineException - if the pipeline contains any incorrect/invalid statements

getSentinelConnection

public RedisSentinelConnection getSentinelConnection()

Specified by:

getSentinelConnection in interface RedisConnection

Overrides:

getSentinelConnection in class AbstractRedisConnection

Returns:

the RedisSentinelConnection when using Redis Sentinel.

rewriteConfig

public void rewriteConfig()

Description copied from interface: RedisServerCommands

Rewrites the redis.conf file.

Specified by:

rewriteConfig in interface DefaultedRedisConnection

Specified by:

rewriteConfig in interface RedisServerCommands

See Also:

• Redis Documentation: CONFIG REWRITE

getCluster

protected redis.clients.jedis.UnifiedJedis getCluster()

getJedis

public redis.clients.jedis.UnifiedJedis getJedis()

Description copied from class: JedisConnection

Returns the underlying UnifiedJedis instance.

Overrides:

getJedis in class JedisConnection

Returns:

the UnifiedJedis instance

getClusterCommandExecutor

protected ClusterCommandExecutor getClusterCommandExecutor()

getTopologyProvider

protected ClusterTopologyProvider getTopologyProvider()