| 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.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.async |
Redis Cluster API for asynchronous executed commands.
|
| io.lettuce.core.cluster.api.sync |
Redis Cluster API for synchronous executed commands.
|
| io.lettuce.core.dynamic |
Core package for Redis Command Interface support through
RedisCommandFactory. |
| io.lettuce.core.dynamic.batch |
Batching with Redis Command interfaces.
|
| io.lettuce.core.event.command |
Command-related events.
|
| io.lettuce.core.internal |
Contains internal API.
|
| io.lettuce.core.metrics |
Collectors for client metrics.
|
| 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.sentinel |
Redis Sentinel connection classes.
|
| io.lettuce.core.tracing |
Integration of Brave and Micrometer Tracing for Lettuce Observability.
|
| Modifier and Type | Method and Description |
|---|---|
protected <T> RedisCommand<K,V,T> |
RedisChannelHandler.dispatch(RedisCommand<K,V,T> cmd) |
<T> RedisCommand<K,V,T> |
StatefulRedisConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
protected <T> RedisCommand<K,V,T> |
StatefulRedisConnectionImpl.preProcessCommand(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
CommandListenerWriter.write(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
RedisChannelWriter.write(RedisCommand<K,V,T> command)
Write a command on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
protected Collection<RedisCommand<K,V,?>> |
RedisChannelHandler.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
Collection<RedisCommand<K,V,?>> |
StatefulRedisConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
<K,V> Collection<RedisCommand<K,V,?>> |
CommandListenerWriter.write(Collection<? extends RedisCommand<K,V,?>> redisCommands) |
<K,V> Collection<RedisCommand<K,V,?>> |
RedisChannelWriter.write(Collection<? extends RedisCommand<K,V,?>> commands)
Write multiple commands on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
Mono<String> |
AbstractRedisReactiveCommands.aclDryRun(String username,
RedisCommand<K,V,?> command) |
RedisFuture<String> |
AbstractRedisAsyncCommands.aclDryRun(String username,
RedisCommand<K,V,?> command) |
protected <T> RedisCommand<K,V,T> |
RedisChannelHandler.dispatch(RedisCommand<K,V,T> cmd) |
<T> AsyncCommand<K,V,T> |
AbstractRedisAsyncCommands.dispatch(RedisCommand<K,V,T> cmd) |
<T> RedisCommand<K,V,T> |
StatefulRedisConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
abstract long |
TimeoutOptions.TimeoutSource.getTimeout(RedisCommand<?,?,?> command)
Obtains the timeout for a
RedisCommand. |
protected <T> RedisCommand<K,V,T> |
StatefulRedisConnectionImpl.preProcessCommand(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
CommandListenerWriter.write(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
RedisChannelWriter.write(RedisCommand<K,V,T> command)
Write a command on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
<T,R> Flux<R> |
AbstractRedisReactiveCommands.createDissolvingFlux(Supplier<RedisCommand<K,V,T>> commandSupplier) |
<T> Flux<T> |
AbstractRedisReactiveCommands.createFlux(Supplier<RedisCommand<K,V,T>> commandSupplier) |
<T> Mono<T> |
AbstractRedisReactiveCommands.createMono(Supplier<RedisCommand<K,V,T>> commandSupplier) |
protected Collection<RedisCommand<K,V,?>> |
RedisChannelHandler.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
Collection<RedisCommand<K,V,?>> |
StatefulRedisConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
<K,V> Collection<RedisCommand<K,V,?>> |
CommandListenerWriter.write(Collection<? extends RedisCommand<K,V,?>> redisCommands) |
<K,V> Collection<RedisCommand<K,V,?>> |
RedisChannelWriter.write(Collection<? extends RedisCommand<K,V,?>> commands)
Write multiple commands on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulConnection.dispatch(RedisCommand<K,V,T> command)
Dispatch a command.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulConnection.dispatch(Collection<? extends RedisCommand<K,V,?>> commands)
Dispatch multiple command in a single write on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulConnection.dispatch(RedisCommand<K,V,T> command)
Dispatch a command.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulConnection.dispatch(Collection<? extends RedisCommand<K,V,?>> commands)
Dispatch multiple command in a single write on the channel.
|
| Modifier and Type | Method and Description |
|---|---|
RedisFuture<String> |
RedisAclAsyncCommands.aclDryRun(String username,
RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.
|
| Modifier and Type | Method and Description |
|---|---|
Mono<String> |
RedisAclReactiveCommands.aclDryRun(String username,
RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.
|
| Modifier and Type | Method and Description |
|---|---|
String |
RedisAclCommands.aclDryRun(String username,
RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.
|
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulRedisClusterConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulRedisClusterConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulRedisClusterConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulRedisClusterConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
| Modifier and Type | Method and Description |
|---|---|
AsyncExecutions<String> |
NodeSelectionAclAsyncCommands.aclDryRun(String username,
RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.
|
| Modifier and Type | Method and Description |
|---|---|
Executions<String> |
NodeSelectionAclCommands.aclDryRun(String username,
RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.
|
| Modifier and Type | Method and Description |
|---|---|
io.lettuce.core.dynamic.BatchTasks |
Batcher.batch(RedisCommand<Object,Object,Object> command,
CommandBatching batching)
Add command to the
Batcher. |
| Modifier and Type | Method and Description |
|---|---|
List<RedisCommand<?,?,?>> |
BatchException.getFailedCommands() |
| Constructor and Description |
|---|
BatchException(List<RedisCommand<?,?,?>> failedCommands)
Create a new
BatchException. |
| Modifier and Type | Method and Description |
|---|---|
RedisCommand<Object,Object,Object> |
CommandBaseEvent.getCommand() |
| Constructor and Description |
|---|
CommandBaseEvent(RedisCommand<Object,Object,Object> command,
Map<String,Object> context) |
CommandFailedEvent(RedisCommand<Object,Object,Object> command,
Map<String,Object> context,
Throwable cause) |
CommandStartedEvent(RedisCommand<Object,Object,Object> command,
long startedAt) |
CommandSucceededEvent(RedisCommand<Object,Object,Object> command,
Map<String,Object> context,
long started,
long completed) |
| Modifier and Type | Method and Description |
|---|---|
long |
TimeoutProvider.getTimeoutNs(RedisCommand<?,?,?> command)
Returns the timeout in
TimeUnit.NANOSECONDS for RedisCommand. |
| Modifier and Type | Method and Description |
|---|---|
Predicate<RedisCommand<?,?,?>> |
MicrometerOptions.getMetricsFilter() |
| Modifier and Type | Method and Description |
|---|---|
void |
MicrometerCommandLatencyRecorder.recordCommandLatency(SocketAddress local,
SocketAddress remote,
RedisCommand<?,?,?> redisCommand,
long firstResponseLatency,
long completionLatency) |
default void |
CommandLatencyRecorder.recordCommandLatency(SocketAddress local,
SocketAddress remote,
RedisCommand<?,?,?> command,
long firstResponseLatency,
long completionLatency)
Record the command latency per
connectionPoint and commandType. |
| Modifier and Type | Method and Description |
|---|---|
MicrometerOptions.Builder |
MicrometerOptions.Builder.metricsFilter(Predicate<RedisCommand<?,?,?>> filter)
Configures a filter
Predicate to filter which commands should be reported to Micrometer. |
| Modifier and Type | Method and Description |
|---|---|
void |
MultiOutput.add(RedisCommand<K,V,?> cmd) |
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncCommand<K,V,T>
An asynchronous redis command and its result.
|
class |
Command<K,V,T>
|
class |
CommandWrapper<K,V,T>
Wrapper for a command.
|
class |
TracedCommand<K,V,T>
Redis command that is aware of an associated
TraceContext. |
class |
TransactionalCommand<K,V,T>
A wrapper for commands within a MULTI transaction.
|
| Modifier and Type | Field and Description |
|---|---|
protected RedisCommand<K,V,T> |
CommandWrapper.command |
| Modifier and Type | Method and Description |
|---|---|
protected <C extends RedisCommand<?,?,T>,T> |
DefaultEndpoint.writeToBuffer(C command) |
| Modifier and Type | Method and Description |
|---|---|
RedisCommand<K,V,T> |
CommandWrapper.getDelegate() |
RedisCommand<K,V,T> |
AsyncCommand.getDelegate() |
RedisCommand<K,V,T> |
DecoratedCommand.getDelegate()
The underlying command.
|
static <K,V,T> RedisCommand<K,V,T> |
CommandWrapper.unwrap(RedisCommand<K,V,T> wrapped)
Unwrap a wrapped command.
|
<K,V,T> RedisCommand<K,V,T> |
CommandExpiryWriter.write(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
DefaultEndpoint.write(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
protected List<RedisCommand<?,?,?>> |
DefaultEndpoint.drainCommands() |
Collection<RedisCommand<?,?,?>> |
CommandHandler.drainQueue() |
Queue<RedisCommand<?,?,?>> |
CommandHandler.getStack() |
<K,V> Collection<RedisCommand<K,V,?>> |
CommandExpiryWriter.write(Collection<? extends RedisCommand<K,V,?>> redisCommands) |
<K,V> Collection<RedisCommand<K,V,?>> |
DefaultEndpoint.write(Collection<? extends RedisCommand<K,V,?>> commands) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
CommandHandler.afterDecode(ChannelHandlerContext ctx,
RedisCommand<?,?,?> command)
Hook method called after command completion.
|
protected boolean |
CommandHandler.canComplete(RedisCommand<?,?,?> command)
Decoding hook: Can the command be completed.
|
protected void |
CommandHandler.complete(RedisCommand<?,?,?> command)
Decoding hook: Complete a command.
|
protected boolean |
CommandHandler.decode(ByteBuf buffer,
RedisCommand<?,?,?> command,
CommandOutput<?,?,?> output) |
protected CommandOutput<?,?,?> |
CommandHandler.getCommandOutput(RedisCommand<?,?,?> command)
Decoding hook: Retrieve
CommandOutput for RedisCommand decoding. |
boolean |
ReadOnlyCommands.ReadOnlyPredicate.isReadOnly(RedisCommand<?,?,?> command)
Evaluates this predicate on the given
RedisCommand. |
static <K,V,T> RedisCommand<K,V,T> |
CommandWrapper.unwrap(RedisCommand<K,V,T> wrapped)
Unwrap a wrapped command.
|
static <R,K,V,T> R |
CommandWrapper.unwrap(RedisCommand<K,V,T> wrapped,
Class<R> iface)
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not
exposed by the proxy.
|
<K,V,T> RedisCommand<K,V,T> |
CommandExpiryWriter.write(RedisCommand<K,V,T> command) |
<K,V,T> RedisCommand<K,V,T> |
DefaultEndpoint.write(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
<K,V> Collection<RedisCommand<K,V,?>> |
CommandExpiryWriter.write(Collection<? extends RedisCommand<K,V,?>> redisCommands) |
<K,V> Collection<RedisCommand<K,V,?>> |
DefaultEndpoint.write(Collection<? extends RedisCommand<K,V,?>> commands) |
| Constructor and Description |
|---|
AsyncCommand(RedisCommand<K,V,T> command) |
AsyncCommand(RedisCommand<K,V,T> command,
int count) |
CommandWrapper(RedisCommand<K,V,T> command) |
TracedCommand(RedisCommand<K,V,T> command,
TraceContext traceContext) |
TransactionalCommand(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
<K1,V1,T> RedisCommand<K1,V1,T> |
PubSubEndpoint.write(RedisCommand<K1,V1,T> command) |
| Modifier and Type | Method and Description |
|---|---|
<K1,V1> Collection<RedisCommand<K1,V1,?>> |
PubSubEndpoint.write(Collection<? extends RedisCommand<K1,V1,?>> redisCommands) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
PubSubCommandHandler.afterDecode(ChannelHandlerContext ctx,
RedisCommand<?,?,?> command) |
protected boolean |
PubSubCommandHandler.canComplete(RedisCommand<?,?,?> command) |
protected void |
PubSubCommandHandler.complete(RedisCommand<?,?,?> command) |
protected CommandOutput<?,?,?> |
PubSubCommandHandler.getCommandOutput(RedisCommand<?,?,?> command) |
protected void |
PubSubEndpoint.rejectCommand(RedisCommand<?,?,?> command) |
<K1,V1,T> RedisCommand<K1,V1,T> |
PubSubEndpoint.write(RedisCommand<K1,V1,T> command) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
PubSubEndpoint.containsViolatingCommands(Collection<? extends RedisCommand<?,?,?>> redisCommands) |
protected void |
PubSubEndpoint.rejectCommands(Collection<? extends RedisCommand<?,?,?>> redisCommands) |
<K1,V1> Collection<RedisCommand<K1,V1,?>> |
PubSubEndpoint.write(Collection<? extends RedisCommand<K1,V1,?>> redisCommands) |
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulRedisSentinelConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulRedisSentinelConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
| Modifier and Type | Method and Description |
|---|---|
<T> RedisCommand<K,V,T> |
StatefulRedisSentinelConnectionImpl.dispatch(RedisCommand<K,V,T> command) |
<T> AsyncCommand<K,V,T> |
RedisSentinelAsyncCommandsImpl.dispatch(RedisCommand<K,V,T> cmd) |
| Modifier and Type | Method and Description |
|---|---|
Collection<RedisCommand<K,V,?>> |
StatefulRedisSentinelConnectionImpl.dispatch(Collection<? extends RedisCommand<K,V,?>> commands) |
| Modifier and Type | Method and Description |
|---|---|
RedisCommand<?,?,?> |
LettuceObservationContext.getRequiredCommand()
Returns the required
RedisCommand or throws IllegalStateException if no command is associated with the
context. |
| Modifier and Type | Method and Description |
|---|---|
void |
LettuceObservationContext.setCommand(RedisCommand<?,?,?> command)
Set the
RedisCommand. |
abstract Tracer.Span |
Tracer.Span.start(RedisCommand<?,?,?> command)
Starts the span with.
|
| Modifier and Type | Method and Description |
|---|---|
BraveTracing.Builder |
BraveTracing.Builder.spanCustomizer(BiConsumer<RedisCommand<Object,Object,Object>,brave.Span> spanCustomizer)
|
Copyright © 2025 lettuce.io. All rights reserved.