Package org.springframework.data.redis.connection

@NonNullApi @NonNullFields package org.springframework.data.redis.connection

Connection package providing low-level abstractions for interacting with the various Redis 'drivers'/libraries.

Performs exception translation between the underlying library exceptions to Spring's DAO hierarchy.

Related Packages

Package	Description
org.springframework.data.redis	Root package for integrating Redis with Spring concepts.
org.springframework.data.redis.connection.convert	Redis specific converters used for sending data and parsing responses.
org.springframework.data.redis.connection.jedis	Connection package for Jedis library.
org.springframework.data.redis.connection.lettuce	Connection package for Lettuce Redis client.
org.springframework.data.redis.connection.stream	Data structures and interfaces to interact with Redis Streams.
org.springframework.data.redis.connection.util	Internal utility package for encoding/decoding Strings to byte[] (using Base64) library.
org.springframework.data.redis.connection.zset

Class	Description
AbstractRedisConnection
BitFieldSubCommands	The actual BITFIELD command representation holding several BitFieldSubCommands.BitFieldSubCommands to execute.
BitFieldSubCommands.AbstractBitFieldSubCommand
BitFieldSubCommands.BitFieldGet	The GET sub command used with BitFieldSubCommands.
BitFieldSubCommands.BitFieldGetBuilder
BitFieldSubCommands.BitFieldIncrBy	The INCRBY sub command used with BitFieldSubCommands.
BitFieldSubCommands.BitFieldIncrBy.Overflow
BitFieldSubCommands.BitFieldSet	The SET sub command used with BitFieldSubCommands.
BitFieldSubCommands.BitFieldSetBuilder
BitFieldSubCommands.BitFieldSubCommand	Sub command to be used as part of BitFieldSubCommands.
BitFieldSubCommands.BitFieldType	The actual Redis bitfield type representation for signed and unsigned integers used with BitFieldSubCommands.BitFieldSubCommand.
BitFieldSubCommands.Offset	Offset used inside a BitFieldSubCommands.BitFieldSubCommand.
ClusterCommandExecutionFailureException	Exception thrown when at least one call to a clustered redis environment fails.
ClusterCommandExecutor	ClusterCommandExecutor takes care of running commands across the known cluster nodes.
ClusterCommandExecutor.ClusterCommandCallback<T,S>	Callback interface for Redis 'low level' code using the cluster client directly.
ClusterCommandExecutor.MultiKeyClusterCommandCallback<T,S>	Callback interface for Redis 'low level' code using the cluster client to execute multi key commands.
ClusterCommandExecutor.MultiNodeResult<T>	ClusterCommandExecutor.MultiNodeResult holds all ClusterCommandExecutor.NodeResult of a command executed on multiple RedisClusterNode.
ClusterCommandExecutor.NodeResult<T>	ClusterCommandExecutor.NodeResult encapsulates the actual value returned by a ClusterCommandExecutor.ClusterCommandCallback on a given RedisClusterNode.
ClusterInfo	ClusterInfo gives access to cluster information such as cluster_state and cluster_slots_assigned provided by the CLUSTER INFO command.
ClusterInfo.Info
ClusterNodeResourceProvider	ClusterNodeResourceProvider provides access to low level client api to directly execute operations against a Redis instance.
ClusterSlotHashUtil	Utility class encapsulating functionality commonly used for cluster slot hashing.
ClusterTopology	ClusterTopology holds snapshot like information about RedisClusterNodes.
ClusterTopologyProvider	ClusterTopologyProvider manages the current cluster topology and makes sure to refresh cluster information.
ConnectionUtils	Utilities for examining a RedisConnection
DataType	Enumeration of the Redis data types.
DecoratedRedisConnection	Specifies that the connection decorates another RedisConnection.
DefaultedRedisClusterConnection	Deprecated.
DefaultedRedisConnection	Deprecated.
DefaultMessage	Default message implementation.
DefaultSortParameters	Default implementation for SortParameters.
DefaultStringRedisConnection	Default implementation of StringRedisConnection.
DefaultStringTuple	Default implementation for StringRedisConnection.StringTuple interface.
FutureResult<T>	The result of an asynchronous operation
Limit
Message	Class encapsulating a Redis message body and its properties.
MessageListener	Listener of messages published in Redis.
NamedNode
PoolException	Exception thrown when there are issues with a resource pool
ReactiveClusterCommands	Interface for the cluster commands supported by Redis executed using reactive infrastructure.
ReactiveClusterCommands.AddSlots
ReactiveClusterGeoCommands
ReactiveClusterHashCommands
ReactiveClusterHyperLogLogCommands
ReactiveClusterKeyCommands
ReactiveClusterListCommands
ReactiveClusterNumberCommands
ReactiveClusterScriptingCommands
ReactiveClusterServerCommands	Redis Server commands executed in cluster environment using reactive infrastructure.
ReactiveClusterSetCommands
ReactiveClusterStreamCommands
ReactiveClusterStringCommands
ReactiveClusterZSetCommands
ReactiveGeoCommands	Redis Geo commands executed using reactive infrastructure.
ReactiveGeoCommands.GeoAddCommand	GEOADD command parameters.
ReactiveGeoCommands.GeoDistCommand	GEODIST command parameters.
ReactiveGeoCommands.GeoHashCommand	GEOHASH command parameters.
ReactiveGeoCommands.GeoPosCommand	GEOPOS command parameters.
ReactiveGeoCommands.GeoRadiusByMemberCommand	GEORADIUSBYMEMBER command parameters.
ReactiveGeoCommands.GeoRadiusCommand	GEORADIUS command parameters.
ReactiveGeoCommands.GeoSearchCommand	GEOSEARCH command parameters.
ReactiveGeoCommands.GeoSearchStoreCommand	GEOSEARCHSTORE command parameters.
ReactiveHashCommands	Redis Hash commands executed using reactive infrastructure.
ReactiveHashCommands.HDelCommand
ReactiveHashCommands.HExistsCommand	HEXISTS ReactiveRedisConnection.Command.
ReactiveHashCommands.HGetCommand	HGET ReactiveRedisConnection.Command.
ReactiveHashCommands.HRandFieldCommand	HRANDFIELD ReactiveRedisConnection.Command.
ReactiveHashCommands.HSetCommand	HSET ReactiveRedisConnection.Command.
ReactiveHashCommands.HStrLenCommand
ReactiveHyperLogLogCommands	Redis HyperLogLog commands executed using reactive infrastructure.
ReactiveHyperLogLogCommands.PfAddCommand	PFADD command parameters.
ReactiveHyperLogLogCommands.PfCountCommand	PFCOUNT command parameters.
ReactiveHyperLogLogCommands.PfMergeCommand	PFMERGE command parameters.
ReactiveKeyCommands	Redis Key commands executed using reactive infrastructure.
ReactiveKeyCommands.CopyCommand	MOVE command parameters.
ReactiveKeyCommands.ExpireAtCommand	EXPIREAT/PEXPIREAT command parameters.
ReactiveKeyCommands.ExpireCommand	EXPIRE/PEXPIRE command parameters.
ReactiveKeyCommands.MoveCommand	MOVE command parameters.
ReactiveKeyCommands.RenameCommand	RENAME command parameters.
ReactiveListCommands	Redis List commands executed using reactive infrastructure.
ReactiveListCommands.BLMoveCommand	BLMOVE command parameters.
ReactiveListCommands.BPopCommand
ReactiveListCommands.BRPopLPushCommand	BRPOPLPUSH command parameters.
ReactiveListCommands.Direction
ReactiveListCommands.LIndexCommand	LINDEX command parameters.
ReactiveListCommands.LInsertCommand	LINSERT command parameters.
ReactiveListCommands.LMoveCommand	LMOVE command parameters.
ReactiveListCommands.LPosCommand	LPOS command parameters.
ReactiveListCommands.LRemCommand	LREM command parameters.
ReactiveListCommands.LSetCommand	LSET command parameters.
ReactiveListCommands.PopCommand	LPOP/RPOP command parameters.
ReactiveListCommands.PopResponse	Result for ReactiveListCommands.PopCommand/ReactiveListCommands.BPopCommand.
ReactiveListCommands.PopResult	Result for ReactiveListCommands.PopCommand/ReactiveListCommands.BPopCommand.
ReactiveListCommands.PushCommand	LPUSH/RPUSH command parameters.
ReactiveListCommands.RPopLPushCommand	RPOPLPUSH command parameters.
ReactiveNumberCommands	Redis numeric commands executed using reactive infrastructure.
ReactiveNumberCommands.DecrByCommand<T extends Number>	DECRBY command parameters.
ReactiveNumberCommands.HIncrByCommand<T extends Number>	HINCRBY command parameters.
ReactiveNumberCommands.IncrByCommand<T extends Number>	INCRBY command parameters.
ReactivePubSubCommands	Redis Pub/Sub commands executed using reactive infrastructure.
ReactiveRedisClusterConnection
ReactiveRedisConnection	Redis connection using reactive infrastructure declaring entry points for reactive command execution.
ReactiveRedisConnection.AbsentByteBufferResponse<I>	ReactiveRedisConnection.CommandResponse implementation for ByteBuffer responses for absent keys.
ReactiveRedisConnection.BooleanResponse<I>	ReactiveRedisConnection.CommandResponse implementation for Boolean responses.
ReactiveRedisConnection.ByteBufferResponse<I>	ReactiveRedisConnection.CommandResponse implementation for ByteBuffer responses.
ReactiveRedisConnection.Command	Base interface for Redis commands executed with a reactive infrastructure.
ReactiveRedisConnection.CommandResponse<I,O>	Base class for command responses.
ReactiveRedisConnection.KeyCommand	ReactiveRedisConnection.Command for key-bound operations.
ReactiveRedisConnection.KeyScanCommand	ReactiveRedisConnection.Command for key-bound scan operations like SCAN, HSCAN, SSCAN and ZSCAN.
ReactiveRedisConnection.MultiValueResponse<I,O>	ReactiveRedisConnection.CommandResponse implementation for List responses.
ReactiveRedisConnection.NumericResponse<I,O extends Number>	ReactiveRedisConnection.CommandResponse implementation for numeric responses.
ReactiveRedisConnection.RangeCommand
ReactiveRedisConnectionFactory	Thread-safe factory of reactive Redis connections.
ReactiveScriptingCommands	Redis Scripting commands executed using reactive infrastructure.
ReactiveServerCommands	Redis Server commands executed using reactive infrastructure.
ReactiveSetCommands	Redis Set commands executed using reactive infrastructure.
ReactiveSetCommands.SAddCommand	SADD command parameters.
ReactiveSetCommands.SDiffCommand	SDIFF command parameters.
ReactiveSetCommands.SDiffStoreCommand	SDIFFSTORE command parameters.
ReactiveSetCommands.SInterCommand	SINTER command parameters.
ReactiveSetCommands.SInterStoreCommand	SINTERSTORE command parameters.
ReactiveSetCommands.SIsMemberCommand	SISMEMBER command parameters.
ReactiveSetCommands.SMIsMemberCommand	SMISMEMBER command parameters.
ReactiveSetCommands.SMoveCommand	SMOVE command parameters.
ReactiveSetCommands.SPopCommand	SPOP command parameters.
ReactiveSetCommands.SRandMembersCommand	SRANDMEMBER command parameters.
ReactiveSetCommands.SRemCommand	SREM command parameters.
ReactiveSetCommands.SUnionCommand	SUNION command parameters.
ReactiveSetCommands.SUnionStoreCommand	SUNIONSTORE command parameters.
ReactiveStreamCommands	Stream-specific Redis commands executed using reactive infrastructure.
ReactiveStreamCommands.AcknowledgeCommand	XACK command parameters.
ReactiveStreamCommands.AddStreamRecord	XADD command parameters.
ReactiveStreamCommands.DeleteCommand	XDEL command parameters.
ReactiveStreamCommands.GroupCommand
ReactiveStreamCommands.GroupCommand.GroupCommandAction
ReactiveStreamCommands.PendingRecordsCommand	Value Object holding parameters for obtaining pending messages.
ReactiveStreamCommands.RangeCommand	XRANGE/XREVRANGE command parameters.
ReactiveStreamCommands.ReadCommand	XRANGE/XREVRANGE command parameters.
ReactiveStreamCommands.TrimCommand	XTRIM command parameters.
ReactiveStreamCommands.XClaimCommand	XCLAIM command parameters.
ReactiveStreamCommands.XInfoCommand
ReactiveStringCommands	Redis String commands executed using reactive infrastructure.
ReactiveStringCommands.AppendCommand	APPEND command parameters.
ReactiveStringCommands.BitCountCommand	BITCOUNT command parameters.
ReactiveStringCommands.BitFieldCommand	BITFIELD command parameters.
ReactiveStringCommands.BitOpCommand	BITOP command parameters.
ReactiveStringCommands.BitPosCommand
ReactiveStringCommands.GetBitCommand	GETBIT command parameters.
ReactiveStringCommands.GetExCommand	ReactiveRedisConnection.Command for GETEX.
ReactiveStringCommands.MSetCommand	MSET command parameters.
ReactiveStringCommands.SetBitCommand	SETBIT command parameters.
ReactiveStringCommands.SetCommand	SET command parameters.
ReactiveStringCommands.SetRangeCommand	SETRANGE command parameters.
ReactiveSubscription	Subscription for Redis channels using reactive infrastructure.
ReactiveSubscription.ChannelMessage<C,M>	Value object for a Redis channel message.
ReactiveSubscription.Message<C,M>	ReactiveSubscription.Message represents a Redis channel message within Redis pub/sub.
ReactiveSubscription.PatternMessage<P,C,M>	Value object for a Redis channel message received from a pattern subscription.
ReactiveZSetCommands	Redis Sorted Set commands executed using reactive infrastructure.
ReactiveZSetCommands.BZPopCommand	BZPOPMIN/BZPOPMAX command parameters.
ReactiveZSetCommands.PopDirection
ReactiveZSetCommands.ZAddCommand	ZADD command parameters.
ReactiveZSetCommands.ZAggregateCommand	ZINTER/ZUNION command parameters.
ReactiveZSetCommands.ZAggregateStoreCommand	ZINTERSTORE/ZUNIONSTORE command parameters.
ReactiveZSetCommands.ZCountCommand	ZCOUNT command parameters.
ReactiveZSetCommands.ZDiffCommand	ZDIFF command parameters.
ReactiveZSetCommands.ZDiffStoreCommand	ZDIFFSTORE command parameters.
ReactiveZSetCommands.ZIncrByCommand	ZINCRBY command parameters.
ReactiveZSetCommands.ZInterStoreCommand	ZINTERSTORE command parameters.
ReactiveZSetCommands.ZLexCountCommand	ZLEXCOUNT command parameters.
ReactiveZSetCommands.ZMScoreCommand	ZMSCORE command parameters.
ReactiveZSetCommands.ZPopCommand	ZPOPMIN/ZPOPMAX command parameters.
ReactiveZSetCommands.ZRandMemberCommand	ZRANDMEMBER command parameters.
ReactiveZSetCommands.ZRangeByLexCommand	ZRANGEBYLEX/ZREVRANGEBYLEX command parameters.
ReactiveZSetCommands.ZRangeByScoreCommand	ZRANGEBYSCORE/ZREVRANGEBYSCORE.
ReactiveZSetCommands.ZRangeCommand	ZRANGE/ZREVRANGE command parameters.
ReactiveZSetCommands.ZRangeStoreCommand	ZRANGESTORE command parameters.
ReactiveZSetCommands.ZRangeStoreCommand.RangeMode
ReactiveZSetCommands.ZRankCommand	ZRANK/ZREVRANK command parameters.
ReactiveZSetCommands.ZRemCommand	ZREM command parameters.
ReactiveZSetCommands.ZRemRangeByLexCommand	ZREMRANGEBYLEX command parameters.
ReactiveZSetCommands.ZRemRangeByRankCommand	ZREMRANGEBYRANK command parameters.
ReactiveZSetCommands.ZRemRangeByScoreCommand	ZREMRANGEBYSCORE command parameters.
ReactiveZSetCommands.ZScoreCommand	ZSCORE command parameters.
ReactiveZSetCommands.ZUnionStoreCommand	ZUNIONSTORE command parameters.
RedisClusterCommands	Interface for the cluster commands supported by Redis.
RedisClusterCommands.AddSlots
RedisClusterCommandsProvider	Provides access to RedisClusterCommands and the segregated command interfaces.
RedisClusterConfiguration	Configuration class used to set up a RedisConnection via RedisConnectionFactory for connecting to Redis Cluster.
RedisClusterConnection	RedisClusterConnection allows sending commands to dedicated nodes within the cluster.
RedisClusterNode	Representation of a Redis server within the cluster.
RedisClusterNode.Flag
RedisClusterNode.LinkState
RedisClusterNode.RedisClusterNodeBuilder	Builder for creating new RedisClusterNode.
RedisClusterNode.SlotRange
RedisClusterServerCommands
RedisCommands	Interface defining the commands supported by Redis.
RedisCommandsProvider	Provides access to RedisCommands and the segregated command interfaces.
RedisConfiguration	Marker interface for configuration classes related to Redis connection setup.
RedisConfiguration.ClusterConfiguration	Configuration interface suitable for Redis cluster environments.
RedisConfiguration.DomainSocketConfiguration	Configuration interface suitable for single node redis connections using local unix domain socket.
RedisConfiguration.SentinelConfiguration	Configuration interface suitable for Redis Sentinel environments.
RedisConfiguration.StaticMasterReplicaConfiguration	Configuration interface suitable for Redis master/replica environments with fixed hosts.
RedisConfiguration.WithAuthentication	RedisConfiguration part suitable for configurations that may use authentication when connecting.
RedisConfiguration.WithDatabaseIndex	RedisConfiguration part suitable for configurations that use a specific database.
RedisConfiguration.WithDomainSocket	RedisConfiguration part suitable for configurations that use native domain sockets for connecting.
RedisConfiguration.WithHostAndPort	RedisConfiguration part suitable for configurations that use host/port combinations for connecting.
RedisConfiguration.WithPassword	RedisConfiguration part suitable for configurations that may use authentication when connecting.
RedisConnection	A connection to a Redis server.
RedisConnectionCommands	Connection-specific commands supported by Redis.
RedisConnectionFactory	Thread-safe factory of Redis connections.
RedisGeoCommands	Geo-specific Redis commands.
RedisGeoCommands.DistanceUnit	Metrics supported by Redis.
RedisGeoCommands.GeoCommandArgs	Arguments to be used with RedisGeoCommands.
RedisGeoCommands.GeoCommandArgs.GeoCommandFlag	A flag to be used.
RedisGeoCommands.GeoLocation<T>	RedisGeoCommands.GeoLocation representing a Point associated with a name.
RedisGeoCommands.GeoRadiusCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.
RedisGeoCommands.GeoRadiusCommandArgs.Flag
RedisGeoCommands.GeoSearchCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.
RedisGeoCommands.GeoSearchStoreCommandArgs	Additional arguments (like count/sort/...) to be used with RedisGeoCommands.
RedisHashCommands	Hash-specific commands supported by Redis.
RedisHyperLogLogCommands	HyperLogLog specific commands supported by Redis.
RedisInvalidSubscriptionException	Exception thrown when subscribing to an expired/dead Subscription.
RedisKeyCommands	Key-specific commands supported by Redis.
RedisListCommands	List-specific commands supported by Redis.
RedisListCommands.Direction	List move direction.
RedisListCommands.Position	List insertion position.
RedisNode
RedisNode.NodeType
RedisNode.RedisNodeBuilder	Builder for creating new RedisNode.
RedisPassword	Value object which may or may not contain a Redis password.
RedisPipelineException	Exception thrown when executing/closing a pipeline that contains one or multiple invalid/incorrect statements.
RedisPubSubCommands	PubSub-specific Redis commands.
RedisScriptingCommands	Scripting commands.
RedisSentinelCommands	Redis Sentinel-specific commands.
RedisSentinelConfiguration	Configuration class used to set up a RedisConnection with RedisConnectionFactory for connecting to Redis Sentinel(s).
RedisSentinelConnection
RedisServer
RedisServer.INFO
RedisServerCommands	Server-specific commands supported by Redis.
RedisServerCommands.FlushOption
RedisServerCommands.MigrateOption
RedisServerCommands.ShutdownOption
RedisSetCommands	Set-specific commands supported by Redis.
RedisSocketConfiguration	Configuration class used for setting up RedisConnection via RedisConnectionFactory connecting to single Redis using a local unix domain socket.
RedisStandaloneConfiguration	Configuration class used to set up a RedisConnection with RedisConnectionFactory for connecting to a single node Redis instance.
RedisStaticMasterReplicaConfiguration	Configuration class used for setting up RedisConnection via RedisConnectionFactory using the provided Master / Replica configuration to nodes know to not change address.
RedisStreamCommands	Stream-specific Redis commands.
RedisStreamCommands.XAddOptions	Additional options applicable for XADD command.
RedisStreamCommands.XClaimOptions
RedisStreamCommands.XClaimOptions.XClaimOptionsBuilder
RedisStreamCommands.XPendingOptions	Value Object holding parameters for obtaining pending messages.
RedisStringCommands	String/Value-specific commands supported by Redis.
RedisStringCommands.BitOperation
RedisStringCommands.SetOption	SET command arguments for NX, XX.
RedisSubscribedConnectionException	Exception thrown when issuing commands on a connection that is subscribed and waiting for events.
RedisTxCommands	Transaction/Batch specific commands supported by Redis.
RedisZSetCommands	ZSet(SortedSet)-specific commands supported by Redis.
RedisZSetCommands.Limit	Deprecated. since 3.0, use Limit instead.
RedisZSetCommands.Range	Deprecated. since 3.0, use Range or RedisZSetCommands.Range.toRange() instead.
RedisZSetCommands.Range.Boundary
RedisZSetCommands.ZAddArgs	ZADD specific arguments.
RedisZSetCommands.ZAddArgs.Flag
ReturnType	Represents a data type returned from Redis, currently used to denote the expected return type of Redis scripting commands
SortParameters	Entity containing the parameters for the SORT operation.
SortParameters.Order	Sorting order.
SortParameters.Range	Utility class wrapping the 'LIMIT' setting.
StringRedisConnection	Convenience extension of RedisConnection that accepts and returns Strings instead of byte arrays.
StringRedisConnection.StringTuple	String-friendly ZSet tuple.
Subscription	Subscription for Redis channels.
SubscriptionListener	Listener for subscription notifications.
ValueEncoding	ValueEncoding is used for the Redis internal data representation used in order to store the value associated with a key.
ValueEncoding.RedisValueEncoding	Default ValueEncoding implementation of encodings used in Redis.