Lettuce 6.2.7.BUILD-SNAPSHOT API
Lettuce is a scalable thread-safe Java
RedisClient providing
synchronous,
asynchronous and
reactive APIs for Redis Standalone, PubSub,
Redis Sentinel and Redis Cluster.
Multiple threads may share one connection if they avoid blocking and transactional
operations such as BLPOP and
MULTI/EXEC.
Multiple open connections are efficiently managed by the excellent
netty NIO framework.
Each redis command is implemented by one or more methods with names identical to the lowercase
redis command name. Complex commands with multiple modifiers that change the result type include
the CamelCased modifier as part of the command name, e.g.
zrangebyscore and
zrangebyscoreWithScores.
Redis connections are designed to be long-lived, and if the connection is lost will reconnect
until close() is called. Pending commands that have not timed out will be (re)sent after
successful reconnection.
All connections inherit a default timeout from their RedisClient
and will throw a RedisException when non-blocking commands fail
to return a result before the timeout expires. The timeout defaults to 60 seconds and
may be changed via AbstractRedisClient.setDefaultTimeout(java.time.Duration) or for
each individual connection.
| Package | Description |
|---|---|
| io.lettuce.core |
The Redis client package containing
RedisClient for Redis Standalone and Redis Sentinel operations. |
| io.lettuce.core.api |
Standalone Redis connection API.
|
| io.lettuce.core.api.async |
Standalone Redis API for asynchronous executed commands.
|
| io.lettuce.core.api.push |
Interfaces to consume push messages.
|
| io.lettuce.core.api.reactive |
Standalone Redis API for reactive command execution.
|
| io.lettuce.core.api.sync |
Standalone Redis API for synchronous executed commands.
|
| io.lettuce.core.cluster |
Client for Redis Cluster, see
RedisClusterClient. |
| io.lettuce.core.cluster.api |
Redis Cluster connection API.
|
| io.lettuce.core.cluster.api.async |
Redis Cluster API for asynchronous executed commands.
|
| io.lettuce.core.cluster.api.push |
Interfaces to consume push messages using Redis Cluster.
|
| io.lettuce.core.cluster.api.reactive |
Redis Cluster API for reactive command execution.
|
| io.lettuce.core.cluster.api.sync |
Redis Cluster API for synchronous executed commands.
|
| io.lettuce.core.cluster.event |
Cluster event types.
|
| io.lettuce.core.cluster.models.partitions |
Model and parser for the
CLUSTER NODES and CLUSTER SLAVES output. |
| io.lettuce.core.cluster.models.slots |
Model and parser for the
CLUSTER SLOTS output. |
| io.lettuce.core.cluster.pubsub |
Redis Cluster Pub/Sub support.
|
| io.lettuce.core.cluster.pubsub.api.async |
Redis Cluster Pub/Sub API for asynchronous executed commands.
|
| io.lettuce.core.cluster.pubsub.api.reactive |
Redis Cluster Pub/Sub API for reactive command execution.
|
| io.lettuce.core.cluster.pubsub.api.sync |
Redis Cluster Pub/Sub API for synchronous executed commands.
|
| io.lettuce.core.cluster.topology |
Support for cluster topology refresh.
|
| io.lettuce.core.codec |
Codecs for key/value type conversion.
|
| io.lettuce.core.dynamic |
Core package for Redis Command Interface support through
RedisCommandFactory. |
| io.lettuce.core.dynamic.annotation |
Central domain abstractions to be used in combination with Redis Command interfaces.
|
| io.lettuce.core.dynamic.batch |
Batching with Redis Command interfaces.
|
| io.lettuce.core.dynamic.codec |
RedisCodec resolution support. |
| io.lettuce.core.dynamic.domain |
Core annotations to be used with Redis Command interfaces.
|
| io.lettuce.core.dynamic.intercept |
Invocation proxy support.
|
| io.lettuce.core.dynamic.output |
CommandOutput resolution support. |
| io.lettuce.core.dynamic.parameter |
Parameter access and descriptors.
|
| io.lettuce.core.dynamic.segment |
Support for
CommandSegments and segment parsing. |
| io.lettuce.core.dynamic.support |
Support classes imported from the Spring Framework.
|
| io.lettuce.core.event |
Event publishing and subscription.
|
| io.lettuce.core.event.cluster |
Redis Cluster events.
|
| io.lettuce.core.event.command |
Command-related events.
|
| io.lettuce.core.event.connection |
Connection-related events.
|
| io.lettuce.core.event.jfr |
Event publishing specifically for Java Flight Recorder events.
|
| io.lettuce.core.event.metrics |
Metric events and publishing.
|
| io.lettuce.core.internal |
Contains internal API.
|
| io.lettuce.core.masterreplica |
Client support for Redis Master/Replica setups.
|
| io.lettuce.core.masterslave |
Client support for Redis Master/Slave setups.
|
| io.lettuce.core.metrics |
Collectors for client metrics.
|
| io.lettuce.core.models.command |
Model and parser to for the
COMMAND and COMMAND INFO output. |
| io.lettuce.core.models.role |
Model and parser for the
ROLE output. |
| io.lettuce.core.models.stream |
Model and parser for the Stream-related command output such as XPENDING.
|
| io.lettuce.core.output |
Implementation of different output protocols including the Streaming API.
|
| io.lettuce.core.protocol |
Redis protocol layer abstraction.
|
| io.lettuce.core.pubsub |
Pub/Sub connection classes.
|
| io.lettuce.core.pubsub.api.async |
Pub/Sub Redis API for asynchronous executed commands.
|
| io.lettuce.core.pubsub.api.reactive |
Pub/Sub Redis API for reactive command execution.
|
| io.lettuce.core.pubsub.api.sync |
Pub/Sub Redis API for synchronous executed commands.
|
| io.lettuce.core.resource |
Client resource infrastructure providers.
|
| io.lettuce.core.sentinel |
Redis Sentinel connection classes.
|
| io.lettuce.core.sentinel.api |
Redis Sentinel connection API.
|
| io.lettuce.core.sentinel.api.async |
Redis Sentinel API for asynchronous executed commands.
|
| io.lettuce.core.sentinel.api.reactive |
Redis Sentinel API for reactive command execution.
|
| io.lettuce.core.sentinel.api.sync |
Redis Sentinel API for synchronous executed commands.
|
| io.lettuce.core.support |
Supportive classes such as
RedisClientCdiBean for CDI support, connection pooling, and
client-side caching. |
| io.lettuce.core.support.caching | |
| io.lettuce.core.tracing |