Class JedisConnection

java.lang.Object

org.springframework.data.redis.connection.AbstractRedisConnection

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

All Implemented Interfaces:

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

@NullUnmarked
public class JedisConnection
extends AbstractRedisConnection

RedisConnection implementation on top of Jedis library.

This class is not Thread-safe and instances should not be shared across threads.

Author:

Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont, Jungtaek Lim, Konstantin Shchepanovskyi, David Liu, Milan Agatonovic, Mark Paluch, Ninad Divadkar, Guy Korland, Dengliming, John Blum

See Also:

• Jedis

Nested Class Summary

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.XAddOptions, RedisStreamCommands.XClaimOptions, RedisStreamCommands.XPendingOptions

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

Modifier	Constructor	Description
	JedisConnection(@NonNull Jedis jedis)	Constructs a new JedisConnection.
	JedisConnection(@NonNull Jedis jedis, @Nullable Pool<Jedis> pool, int dbIndex)	Constructs a new JedisConnection backed by a Jedis Pool.
protected	JedisConnection(@NonNull Jedis jedis, @Nullable Pool<Jedis> pool, int dbIndex, @Nullable String clientName)	Constructs a new JedisConnection backed by a Jedis Pool.
protected	JedisConnection(@NonNull Jedis jedis, @Nullable Pool<Jedis> pool, @NonNull JedisClientConfig nodeConfig, @NonNull JedisClientConfig sentinelConfig)	Constructs a new JedisConnection backed by a Jedis Pool.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes or quits the connection.
List<@Nullable Object>	closePipeline()	Executes the commands in the pipeline and returns their result.
RedisCommands	commands()	Get RedisCommands.
protected DataAccessException	convertJedisAccessException(Exception cause)
void	discard()	Discard all commands issued after RedisTxCommands.multi().
byte[]	echo(byte @NonNull [] message)	Returns message via server roundtrip.
List<@Nullable Object>	exec()	Executes all queued commands in a transaction started with RedisTxCommands.multi().
Object	execute(@NonNull String command, byte @NonNull []... args)	Native or raw execution of the given Redis command along with the given arguments.
RedisGeoCommands	geoCommands()	Get RedisGeoCommands.
@NonNull Jedis	getJedis()
protected Jedis	getJedis(@NonNull RedisNode node)
Jedis	getNativeConnection()	Returns the native connection (the underlying library/driver object).
@Nullable Pipeline	getPipeline()
Pipeline	getRequiredPipeline()
Transaction	getRequiredTransaction()
protected JedisSentinelConnection	getSentinelConnection(@NonNull RedisNode sentinel)	Get RedisSentinelCommands connected to given node.
Subscription	getSubscription()	Returns the current subscription for this connection or null if the connection is not subscribed.
@Nullable Transaction	getTransaction()
RedisHashCommands	hashCommands()	Get RedisHashCommands.
RedisHyperLogLogCommands	hyperLogLogCommands()	Get RedisHyperLogLogCommands.
protected boolean	isActive(@NonNull RedisNode node)	Check if node is active by sending ping.
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.
boolean	isSubscribed()	Indicates whether the current connection is subscribed (to at least one channel) or not.
RedisKeyCommands	keyCommands()	Get RedisKeyCommands.
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.
void	pSubscribe(@NonNull MessageListener listener, byte @NonNull [] @NonNull ... patterns)	Subscribes the connection to all channels matching the given patterns.
Long	publish(byte @NonNull [] channel, byte @NonNull [] message)	Publishes the given message to the given channel.
RedisScriptingCommands	scriptingCommands()	Get RedisScriptingCommands.
void	select(int dbIndex)	Select the DB with given positive dbIndex.
RedisServerCommands	serverCommands()	Get RedisServerCommands.
RedisSetCommands	setCommands()	Get RedisSetCommands.
void	setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)	Specifies if pipelined results should be converted to the expected data type.
RedisStreamCommands	streamCommands()	Get RedisStreamCommands.
RedisStringCommands	stringCommands()	Get RedisStringCommands.
void	subscribe(@NonNull MessageListener listener, byte @NonNull [] @NonNull ... channels)	Subscribes the connection to the given channels.
void	unwatch()	Flushes all the previously RedisTxCommands.watch(byte[]...) keys.
void	watch(byte @NonNull [] @NonNull ... keys)	Watch given keys for modifications during transaction started with RedisTxCommands.multi().
RedisZSetCommands	zSetCommands()	Get RedisZSetCommands.

Methods inherited from class AbstractRedisConnection

getSentinelConnection, hasRedisSentinelConfigured, setSentinelConfiguration

Methods inherited from class Object

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

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, 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, rewriteConfig, 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, 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 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 RedisStreamCommands

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

Methods inherited from interface RedisStringCommands

bitPos

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

JedisConnection

public JedisConnection(@NonNull Jedis jedis)

Constructs a new JedisConnection.

Parameters:

jedis - Jedis client.

JedisConnection

public JedisConnection(@NonNull Jedis jedis,
 @Nullable Pool<Jedis> pool,
 int dbIndex)

Constructs a new JedisConnection backed by a Jedis Pool.

Parameters:

jedis - Jedis client.

pool - Pool of Redis connections; can be null, if no pool is used.

dbIndex - index of the Redis database to use.

JedisConnection

protected JedisConnection(@NonNull Jedis jedis,
 @Nullable Pool<Jedis> pool,
 int dbIndex,
 @Nullable String clientName)

Constructs a new JedisConnection backed by a Jedis Pool.

Parameters:

jedis - Jedis client.

pool - Pool of Redis connections; can be null, if no pool is used.

dbIndex - index of the Redis database to use.

clientName - name given to this client; can be null.

Since:

1.8

JedisConnection

protected JedisConnection(@NonNull Jedis jedis,
 @Nullable Pool<Jedis> pool,
 @NonNull JedisClientConfig nodeConfig,
 @NonNull JedisClientConfig sentinelConfig)

Constructs a new JedisConnection backed by a Jedis Pool.

Parameters:

jedis - Jedis client.

pool - Pool of Redis connections; can be null, if no pool is used.

nodeConfig - Redis Node configuration

sentinelConfig - Redis Sentinel configuration

Since:

2.5

Method Details

convertJedisAccessException

protected DataAccessException convertJedisAccessException(Exception cause)

commands

public RedisCommands commands()

Description copied from interface: RedisCommandsProvider

Get RedisCommands.

Returns:

never null.

geoCommands

public RedisGeoCommands geoCommands()

Description copied from interface: RedisCommandsProvider

Get RedisGeoCommands.

Returns:

never null.

hashCommands

public RedisHashCommands hashCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHashCommands.

Returns:

never null.

hyperLogLogCommands

public RedisHyperLogLogCommands hyperLogLogCommands()

Description copied from interface: RedisCommandsProvider

Get RedisHyperLogLogCommands.

Returns:

never null.

keyCommands

public RedisKeyCommands keyCommands()

Description copied from interface: RedisCommandsProvider

Get RedisKeyCommands.

Returns:

never null.

listCommands

public RedisListCommands listCommands()

Description copied from interface: RedisCommandsProvider

Get RedisListCommands.

Returns:

never null.

setCommands

public RedisSetCommands setCommands()

Description copied from interface: RedisCommandsProvider

Get RedisSetCommands.

Returns:

never null.

streamCommands

public RedisStreamCommands streamCommands()

Description copied from interface: RedisCommandsProvider

Get RedisStreamCommands.

Returns:

never null.

stringCommands

public RedisStringCommands stringCommands()

Description copied from interface: RedisCommandsProvider

Get RedisStringCommands.

Returns:

never null.

zSetCommands

public RedisZSetCommands zSetCommands()

Description copied from interface: RedisCommandsProvider

Get RedisZSetCommands.

Returns:

never null.

scriptingCommands

public RedisScriptingCommands scriptingCommands()

Description copied from interface: RedisCommandsProvider

Get RedisScriptingCommands.

Returns:

never null.

serverCommands

public RedisServerCommands serverCommands()

Description copied from interface: RedisCommandsProvider

Get RedisServerCommands.

Returns:

never null.

execute

public Object execute(@NonNull String command,
 byte @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.

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.

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 AbstractRedisConnection

Throws:

DataAccessException - if the RedisConnection could not be closed.

getNativeConnection

public Jedis getNativeConnection()

Description copied from interface: RedisConnection

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

Returns:

underlying, native object

isClosed

public boolean isClosed()

Description copied from interface: RedisConnection

Indicates whether the underlying connection is closed or not.

Returns:

true if the connection is closed, false otherwise.

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.

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.

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.

See Also:

• RedisTxCommands.multi()

closePipeline

public List<@Nullable Object> closePipeline()

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.

Returns:

the result of the executed commands.

echo

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

Description copied from interface: RedisConnectionCommands

Returns message via server roundtrip.

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.

Returns:

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

See Also:

• Redis Documentation: PING

discard

public void discard()

Description copied from interface: RedisTxCommands

Discard all commands issued after RedisTxCommands.multi().

See Also:

• Redis Documentation: DISCARD

exec

public List<@Nullable 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.

Returns:

List of replies for each executed command.

See Also:

• Redis Documentation: EXEC

getPipeline

public @Nullable Pipeline getPipeline()

getRequiredPipeline

public Pipeline getRequiredPipeline()

getTransaction

public @Nullable Transaction getTransaction()

getRequiredTransaction

public Transaction getRequiredTransaction()

getJedis

public @NonNull Jedis getJedis()

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

See Also:

• Redis Documentation: MULTI

select

public void select(int dbIndex)

Description copied from interface: RedisConnectionCommands

Select the DB with given positive dbIndex.

Parameters:

dbIndex - the database index.

See Also:

• Redis Documentation: SELECT

unwatch

public void unwatch()

Description copied from interface: RedisTxCommands

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

See Also:

• Redis Documentation: UNWATCH

watch

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

Description copied from interface: RedisTxCommands

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

Parameters:

keys - must not be null.

See Also:

• Redis Documentation: WATCH

publish

public Long publish(byte @NonNull [] channel,
 byte @NonNull [] message)

Description copied from interface: RedisPubSubCommands

Publishes the given message to the given channel.

Parameters:

channel - the channel to publish to. Must not be null.

message - message to publish. Must not be null.

Returns:

the number of clients that received the message or null when used in pipeline / transaction.

See Also:

• Redis Documentation: PUBLISH

getSubscription

public Subscription getSubscription()

Description copied from interface: RedisPubSubCommands

Returns the current subscription for this connection or null if the connection is not subscribed.

Returns:

the current subscription, null if none is available.

isSubscribed

public boolean isSubscribed()

Description copied from interface: RedisPubSubCommands

Indicates whether the current connection is subscribed (to at least one channel) or not.

Returns:

true if the connection is subscribed, false otherwise

pSubscribe

public void pSubscribe(@NonNull MessageListener listener,
 byte @NonNull [] @NonNull ... patterns)

Description copied from interface: RedisPubSubCommands

Subscribes the connection to all channels matching the given patterns. Once subscribed, a connection enters listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is unsubscribed.

Note that this operation is blocking and the current thread starts waiting for new messages immediately.

Parameters:

listener - message listener, must not be null.

patterns - channel name patterns, must not be null.

See Also:

• Redis Documentation: PSUBSCRIBE

subscribe

public void subscribe(@NonNull MessageListener listener,
 byte @NonNull [] @NonNull ... channels)

Description copied from interface: RedisPubSubCommands

Subscribes the connection to the given channels. Once subscribed, a connection enters listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is unsubscribed.

Note that this operation is blocking and the current thread starts waiting for new messages immediately.

Parameters:

listener - message listener, must not be null.

channels - channel names, must not be null.

See Also:

• Redis Documentation: SUBSCRIBE

setConvertPipelineAndTxResults

public void setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults)

Specifies if pipelined results should be converted to the expected data type. If false, results of closePipeline() and exec() will be of the type returned by the Jedis driver

Parameters:

convertPipelineAndTxResults - Whether or not to convert pipeline and tx results

isActive

protected boolean isActive(@NonNull RedisNode node)

Description copied from class: AbstractRedisConnection

Check if node is active by sending ping.

Overrides:

isActive in class AbstractRedisConnection

Parameters:

node -

Returns:

getSentinelConnection

protected JedisSentinelConnection getSentinelConnection(@NonNull RedisNode sentinel)

Description copied from class: AbstractRedisConnection

Get RedisSentinelCommands connected to given node.

Overrides:

getSentinelConnection in class AbstractRedisConnection

Parameters:

sentinel -

Returns:

getJedis

protected Jedis getJedis(@NonNull RedisNode node)