Package io.lettuce.core

The Redis client package containing RedisClient for Redis Standalone and Redis Sentinel operations.

Interface Summary

Interface	Description
CompositeArgument	Interface for composite command argument objects.
ConnectionFuture<T>	A ConnectionFuture represents the result of an asynchronous connection initialization.
ConnectionId	Connection identifier.
ConnectionPoint	Interface for a connection point described with a host and port or socket.
GeoSearch.GeoPredicate	Geo predicate specifying a search scope.
GeoSearch.GeoRef<K>	Geo reference specifying a search starting point.
ReadFrom.Nodes	Descriptor of nodes that are available for the current read operation.
RedisChannelWriter	Writer for a channel.
RedisConnectionStateListener	Simple interface for Redis connection state monitoring.
RedisCredentials	Provides credentials to access a secured Redis service.
RedisCredentialsProvider	Interface for loading RedisCredentials that are used for authentication.
RedisCredentialsProvider.ImmediateRedisCredentialsProvider	Extension to RedisCredentialsProvider that resolves credentials immediately without the need to defer the credential resolution.
RedisFuture<V>	A RedisFuture represents the result of an asynchronous computation, extending CompletionStage.
SslOptions.Resource	Supplier for a InputStream representing a resource.
TransactionResult	Value interface for a MULTI transaction result.

Class Summary

Class	Description
AbstractRedisAsyncCommands<K,V>	An asynchronous and thread-safe API for a Redis connection.
AbstractRedisClient	Base Redis client.
AbstractRedisReactiveCommands<K,V>	A reactive and thread-safe API for a Redis connection.
AclSetuserArgs	Argument list builder for the Redis ACL SETUSER command.
AclSetuserArgs.Builder	Builder entry points for AclSetuserArgs.
BitFieldArgs	Argument list builder for the Redis BITFIELD command.
BitFieldArgs.BitFieldType	Represents a bit field type with details about signed/unsigned and the number of bits.
BitFieldArgs.Builder	Builder entry points for BitFieldArgs.
BitFieldArgs.Offset	Represents a bit field offset.
ClientListArgs	Argument list builder for the Redis CLIENT LIST command.
ClientListArgs.Builder	Builder entry points for ClientListArgs.
ClientOptions	Client Options to control the behavior of RedisClient.
ClientOptions.Builder	Builder for ClientOptions.
CommandListenerWriter	Writer for command listeners.
CommandListenerWriter.CommandListenerMulticaster	Wraps multiple command listeners into one multicaster.
ConnectionBuilder	Connection builder for connections.
ConnectionEvents	Close Events Facility.
ConnectionEvents.Reconnect	Internal event when a reconnect is initiated.
ConnectionEvents.Reset	Internal event when a channel is closed.
ConnectionState	Internal connection state representing the negotiated ProtocolVersion and other options for connection initialization and connection state restoration.
Consumer<K>	Value object representing a Stream consumer within a consumer group.
CopyArgs	Argument list builder for the Redis COPY command.
CopyArgs.Builder	Builder entry points for CopyArgs.
EpollProvider	Deprecated. Use EpollProvider instead.
ExpireArgs	Argument list builder for the Redis EXPIRE commands (PEXPIRE, EXPIREAT, PEXPIREAT).
ExpireArgs.Builder	Builder entry points for ExpireArgs.
GeoAddArgs	Argument list builder for the Redis GEOADD command starting from Redis 6.2.
GeoAddArgs.Builder	Builder entry points for ScanArgs.
GeoArgs	Argument list builder for the Redis GEORADIUS and GEORADIUSBYMEMBER commands.
GeoArgs.Builder	Builder entry points for GeoArgs.
GeoCoordinates	A tuple consisting of numerical geo data points to describe geo coordinates (longitude/latitude coordinates according to WGS84).
GeoRadiusStoreArgs<K>	Argument list builder for the Redis GEORADIUS command to store GEORADIUS results or GEORADIUS distances in a sorted set.
GeoRadiusStoreArgs.Builder	Builder entry points for GeoRadiusStoreArgs.
GeoSearch	Utility to create GeoSearch.GeoPredicate and GeoSearch.GeoRef objects to be used with GEOSEARCH.
GeoValue<V>	A Geo value extension to Value.
GeoWithin<V>	Geo element within a certain radius.
GetExArgs	Argument list builder for the Redis GETEX command starting from Redis 6.2.
GetExArgs.Builder	Builder entry points for GetExArgs.
KeyScanArgs	Argument list builder for the Redis SCAN command.
KeyScanArgs.Builder
KeyScanCursor<K>	Cursor providing a list of keys.
KeyValue<K,V>	A key-value container extension to Value.
KillArgs	Argument list builder for the Redis CLIENT KILL command.
KillArgs.Builder	Builder entry points for KillArgs.
KqueueProvider	Deprecated. since 6.0, use KqueueProvider instead.
LettuceFutures	Utility to LettuceFutures.awaitAll(long, TimeUnit, Future[]) futures until they are done and to synchronize future execution using LettuceFutures.awaitOrCancel(RedisFuture, long, TimeUnit).
LettuceVersion	Class that exposes the Lettuce version.
Limit	Value object for a slice of data (offset/count).
LMoveArgs	Argument list builder for the Redis BLMOVE and LMOVE commands.
LMoveArgs.Builder	Builder entry points for LMoveArgs.
LMPopArgs	Argument list builder for the Redis BLMPOP and LPOP commands.
LMPopArgs.Builder	Builder entry points for LMPopArgs.
LPosArgs	Argument list builder for the Redis LPOS command.
LPosArgs.Builder	Builder entry points for LPosArgs.
MapScanCursor<K,V>	Scan cursor for maps.
MigrateArgs<K>	Argument list builder for the Redis MIGRATE command.
MigrateArgs.Builder	Builder entry points for MigrateArgs.
OrderingReadFromAccessor	Accessor for ReadFrom ordering.
Range<T>	Range defines lower and upper boundaries to retrieve items from a sorted set.
Range.Boundary<T>
ReadFrom	Defines from which Redis nodes data is read.
RedisAsyncCommandsImpl<K,V>	An asynchronous and thread-safe API for a Redis connection.
RedisChannelHandler<K,V>	Abstract base for every Redis connection.
RedisClient	A scalable and thread-safe Redis client supporting synchronous, asynchronous and reactive execution models.
RedisConnectionStateAdapter	Convenience adapter with an empty implementation of all RedisConnectionStateListener callback methods.
RedisReactiveCommandsImpl<K,V>	A reactive and thread-safe API for a Redis Sentinel connection.
RedisURI	Redis URI.
RedisURI.Builder	Builder for Redis URI.
RestoreArgs	Argument list builder for the Redis RESTORE command.
RestoreArgs.Builder	Builder entry points for XAddArgs.
ScanArgs	Argument list builder for the Redis scan commands (SCAN, HSCAN, SSCAN, ZSCAN).
ScanArgs.Builder	Builder entry points for ScanArgs.
ScanCursor	Generic Cursor data structure.
ScanIterator<T>	Scan command support exposed through Iterator.
ScanStream	Scan command support exposed through Flux.
ScoredValue<V>	A scored-value extension to Value.
ScoredValueScanCursor<V>	Cursor providing a list of ScoredValue
SetArgs	Argument list builder for the Redis SET command starting from Redis 2.6.12.
SetArgs.Builder	Builder entry points for SetArgs.
ShutdownArgs	Argument list builder for the Redis SHUTDOWN command.
ShutdownArgs.Builder	Builder entry points for ShutdownArgs.
SocketOptions	Options to configure low-level socket options for the connections kept to Redis servers.
SocketOptions.Builder	Builder for SocketOptions.
SocketOptions.KeepAliveOptions	Extended Keep-Alive options (idle, interval, count).
SocketOptions.KeepAliveOptions.Builder	Builder for SocketOptions.KeepAliveOptions.
SocketOptions.TcpUserTimeoutOptions	TCP_USER_TIMEOUT comes from RFC5482 , configuring this parameter can allow the user TCP to initiate a reconnection to solve this problem when the network is abnormal.
SocketOptions.TcpUserTimeoutOptions.Builder	Builder class for SocketOptions.TcpUserTimeoutOptions.
SortArgs	Argument list builder for the Redis SORT command.
SortArgs.Builder	Builder entry points for SortArgs.
SslConnectionBuilder	Connection builder for SSL connections.
SslOptions	Options to configure SSL options for the connections kept to Redis servers.
SslOptions.Builder	Builder for SslOptions.
StatefulRedisConnectionImpl<K,V>	A thread-safe connection to a Redis server.
StaticCredentialsProvider	Static implementation of RedisCredentialsProvider.
StrAlgoArgs	Argument list builder for the Redis STRALGO command.
StrAlgoArgs.Builder	Builder entry points for StrAlgoArgs.
StreamMessage<K,V>	A stream message and its id.
StreamScanCursor	Cursor result using the Streaming API.
StringMatchResult	Result for STRALGO command.
StringMatchResult.MatchedPosition	Match position in each string.
StringMatchResult.Position	Position range.
TimeoutOptions	Options for command timeouts.
TimeoutOptions.Builder	Builder for TimeoutOptions.
TimeoutOptions.TimeoutSource	Source for the actual timeout to expire a particular RedisCommand.
TrackingArgs	Argument list builder for the Redis CLIENT TRACKING command.
TrackingArgs.Builder	Builder entry points for TrackingArgs.
Value<V>	A value container object which may or may not contain a non-null value.
ValueScanCursor<V>	Cursor providing a list of values.
XAddArgs	Argument list builder for the Redis XADD command.
XAddArgs.Builder	Builder entry points for XAddArgs.
XAutoClaimArgs<K>	Argument list builder for the Redis XAUTOCLAIM command.
XAutoClaimArgs.Builder	Builder entry points for XAutoClaimArgs.
XClaimArgs	Argument list builder for the Redis XCLAIM command.
XClaimArgs.Builder	Builder entry points for XAddArgs.
XGroupCreateArgs	Argument list builder for the Redis XGROUP CREATE command.
XGroupCreateArgs.Builder	Builder entry points for XGroupCreateArgs.
XPendingArgs<K>	Argument list builder for the Redis XPENDING command.
XPendingArgs.Builder	Builder entry points for XPendingArgs.
XReadArgs	Argument list builder for the Redis XREAD and XREADGROUP commands.
XReadArgs.Builder	Builder entry points for XReadArgs.
XReadArgs.StreamOffset<K>	Value object representing a Stream with its offset.
XTrimArgs	Argument list builder for the Redis XTRIM command.
XTrimArgs.Builder	Builder entry points for XTrimArgs.
ZAddArgs	Argument list builder for the improved Redis ZADD command starting from Redis 3.0.2.
ZAddArgs.Builder	Builder entry points for ScanArgs.
ZAggregateArgs	Argument list builder for the Redis ZUNION, ZUNIONSTORE, ZINTER and ZINTERSTORE commands.
ZAggregateArgs.Builder	Builder entry points for ScanArgs.
ZPopArgs	Argument list builder for the ZMPOP ZMPOP and BZMPOP command starting.
ZPopArgs.Builder	Builder entry points for ScanArgs.
ZStoreArgs	Argument list builder for the Redis ZUNIONSTORE and ZINTERSTORE commands.
ZStoreArgs.Builder	Builder entry points for ScanArgs.

Enum Summary

Enum	Description
AclCategory	Enum object describing Redis ACL categories.
BitFieldArgs.OverflowType	Represents the overflow types for the OVERFLOW subcommand argument.
ClientOptions.DisconnectedBehavior	Behavior of connections in disconnected state.
FlushMode	Enum object describing flushing mode.
FunctionRestoreMode	Restore mode for FUNCTION RESTORE.
GeoArgs.Sort	Sort order.
GeoArgs.Unit	Supported geo unit.
ScriptOutputType	A Lua script returns one of the following types: ScriptOutputType.BOOLEAN boolean ScriptOutputType.INTEGER 64-bit integer ScriptOutputType.STATUS status string ScriptOutputType.VALUE value ScriptOutputType.MULTI of these types ScriptOutputType.OBJECT result object defined by the RESP3 response Redis to Lua conversion table.
SslVerifyMode	Enumeration of SSL/TLS verification modes.
StrAlgoArgs.By
UnblockType	Unblock type for CLIENT UNBLOCK command.

Exception Summary

Exception	Description
RedisBusyException	Exception that gets thrown when Redis is busy executing a Lua script with a BUSY error response.
RedisCommandExecutionException	Exception for errors states reported by Redis.
RedisCommandInterruptedException	Exception thrown when the thread executing a redis command is interrupted.
RedisCommandTimeoutException	Exception thrown when the command waiting timeout is exceeded.
RedisConnectionException	Exception for connection failures.
RedisException	Exception thrown when Redis returns an error message, or when the client fails for any reason.
RedisLoadingException	Exception that gets thrown when Redis is loading a dataset into memory and replying with a LOADING error response.
RedisNoScriptException	Exception that gets thrown when Redis indicates absence of a Lua script referenced by its SHA1 digest with a NOSCRIPT error response.
RedisReadOnlyException	Exception that gets thrown when Redis replies with a READONLY error response.