| Package | Description |
|---|---|
| io.lettuce.core |
The Redis client package containing
RedisClient for Redis Standalone and Redis Sentinel operations. |
| io.lettuce.core.cluster |
Client for Redis Cluster, see
RedisClusterClient. |
| 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.topology |
Support for cluster topology refresh.
|
| io.lettuce.core.failover | |
| io.lettuce.core.failover.api | |
| io.lettuce.core.failover.health | |
| 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.models.role |
Model and parser for the
ROLE output. |
| io.lettuce.core.resource |
Client resource infrastructure providers.
|
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
RedisURI.Builder.build()
Builds a new
RedisURI. |
static RedisURI |
RedisURI.create(String uri)
Create a Redis URI from an URI string.
|
static RedisURI |
RedisURI.create(String host,
int port)
Create a Redis URI from host and port.
|
static RedisURI |
RedisURI.create(URI uri)
Create a Redis URI from an URI string:
The uri must follow conventions of
URI |
RedisURI |
ConnectionBuilder.getRedisURI() |
| Modifier and Type | Method and Description |
|---|---|
List<RedisURI> |
RedisURI.getSentinels() |
| Modifier and Type | Method and Description |
|---|---|
void |
ConnectionState.apply(RedisURI redisURI)
Applies settings from
RedisURI. |
void |
ConnectionBuilder.apply(RedisURI redisURI)
Apply settings from
RedisURI |
void |
RedisURI.applyAuthentication(RedisURI source)
Apply authentication from another
RedisURI. |
void |
RedisURI.applySsl(RedisURI source)
Apply authentication from another
RedisURI. |
static RedisURI.Builder |
RedisURI.builder(RedisURI source)
Create a new
RedisURI.Builder that is initialized from a plain RedisURI. |
<K,V> StatefulRedisConnection<K,V> |
RedisClient.connect(RedisCodec<K,V> codec,
RedisURI redisURI)
|
StatefulRedisConnection<String,String> |
RedisClient.connect(RedisURI redisURI)
Open a new connection to a Redis server using the supplied
RedisURI that treats keys and values as UTF-8 strings. |
<K,V> ConnectionFuture<StatefulRedisConnection<K,V>> |
RedisClient.connectAsync(RedisCodec<K,V> codec,
RedisURI redisURI)
|
protected void |
AbstractRedisClient.connectionBuilder(Mono<SocketAddress> socketAddressSupplier,
ConnectionBuilder connectionBuilder,
ConnectionEvents connectionEvents,
RedisURI redisURI)
Populate connection builder with necessary resources.
|
protected void |
AbstractRedisClient.connectionBuilder(Mono<SocketAddress> socketAddressSupplier,
ConnectionBuilder connectionBuilder,
RedisURI redisURI)
Populate connection builder with necessary resources.
|
<K,V> StatefulRedisPubSubConnection<K,V> |
RedisClient.connectPubSub(RedisCodec<K,V> codec,
RedisURI redisURI)
|
StatefulRedisPubSubConnection<String,String> |
RedisClient.connectPubSub(RedisURI redisURI)
Open a new pub/sub connection to a Redis server using the supplied
RedisURI that treats keys and values as UTF-8
strings. |
<K,V> ConnectionFuture<StatefulRedisPubSubConnection<K,V>> |
RedisClient.connectPubSubAsync(RedisCodec<K,V> codec,
RedisURI redisURI)
|
<K,V> StatefulRedisSentinelConnection<K,V> |
RedisClient.connectSentinel(RedisCodec<K,V> codec,
RedisURI redisURI)
|
StatefulRedisSentinelConnection<String,String> |
RedisClient.connectSentinel(RedisURI redisURI)
Open a connection to a Redis Sentinel using the supplied
RedisURI that treats keys and values as UTF-8 strings. |
<K,V> CompletableFuture<StatefulRedisSentinelConnection<K,V>> |
RedisClient.connectSentinelAsync(RedisCodec<K,V> codec,
RedisURI redisURI)
|
static RedisClient |
RedisClient.create(ClientResources clientResources,
RedisURI redisURI)
Create a new client that connects to the supplied
uri with shared ClientResources. |
static RedisClient |
RedisClient.create(RedisURI redisURI)
Create a new client that connects to the supplied
uri with default ClientResources. |
protected Mono<SocketAddress> |
RedisClient.getSocketAddress(RedisURI redisURI)
|
SslConnectionBuilder |
SslConnectionBuilder.ssl(RedisURI redisURI) |
RedisURI.Builder |
RedisURI.Builder.withAuthentication(RedisURI source)
Apply authentication from another
RedisURI. |
RedisURI.Builder |
RedisURI.Builder.withSentinel(RedisURI redisURI)
Add a withSentinel RedisURI to the existing builder.
|
RedisURI.Builder |
RedisURI.Builder.withSsl(RedisURI source)
Apply authentication from another
RedisURI. |
| Constructor and Description |
|---|
RedisClient(ClientResources clientResources,
RedisURI redisURI) |
| Modifier and Type | Method and Description |
|---|---|
protected RedisURI |
RedisClusterClient.getFirstUri()
Returns the first
RedisURI configured with this RedisClusterClient instance. |
| Modifier and Type | Method and Description |
|---|---|
protected Iterable<RedisURI> |
RedisClusterClient.getInitialUris()
|
protected Iterable<RedisURI> |
RedisClusterClient.getTopologyRefreshSource()
Returns the seed
RedisURI for the topology refreshing. |
static List<RedisURI> |
RedisClusterURIUtil.toRedisURIs(URI uri)
|
| Modifier and Type | Method and Description |
|---|---|
static RedisClusterClient |
RedisClusterClient.create(ClientResources clientResources,
RedisURI redisURI)
Create a new client that connects to the supplied
uri with shared ClientResources. |
static RedisClusterClient |
RedisClusterClient.create(RedisURI redisURI)
Create a new client that connects to the supplied
uri with default ClientResources. |
| Modifier and Type | Method and Description |
|---|---|
static RedisClusterClient |
RedisClusterClient.create(ClientResources clientResources,
Iterable<RedisURI> redisURIs)
Create a new client that connects to the supplied
uri with shared ClientResources. |
static RedisClusterClient |
RedisClusterClient.create(Iterable<RedisURI> redisURIs)
Create a new client that connects to the supplied
uri with default ClientResources. |
protected Partitions |
RedisClusterClient.determinePartitions(Partitions current,
Map<RedisURI,Partitions> topologyViews)
Determines a
topology view based on the current and the obtain topology views. |
protected static <T> CompletableFuture<T> |
RedisClusterClient.transformAsyncConnectionException(CompletionStage<T> future,
Iterable<RedisURI> target) |
| Constructor and Description |
|---|
RedisClusterClient(ClientResources clientResources,
Iterable<RedisURI> redisURIs)
Initialize the client with a list of cluster URI's.
|
| Modifier and Type | Method and Description |
|---|---|
List<RedisURI> |
TopologyRefreshEvent.getTopologyRefreshSource() |
| Constructor and Description |
|---|
TopologyRefreshEvent(List<RedisURI> topologyRefreshSource) |
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
RedisClusterNode.getUri() |
| Modifier and Type | Method and Description |
|---|---|
List<RedisURI> |
RedisClusterNode.getAliases() |
| Modifier and Type | Method and Description |
|---|---|
void |
RedisClusterNode.addAlias(RedisURI alias)
Add an alias to
RedisClusterNode. |
void |
RedisClusterNode.setUri(RedisURI uri)
Sets the connection point details.
|
| Constructor and Description |
|---|
RedisClusterNode(RedisURI uri,
String nodeId,
boolean connected,
String slaveOf,
long pingSentTimestamp,
long pongReceivedTimestamp,
long configEpoch,
List<Integer> slots,
Set<RedisClusterNode.NodeFlag> flags) |
| Modifier and Type | Method and Description |
|---|---|
CompletionStage<Map<RedisURI,Partitions>> |
ClusterTopologyRefresh.loadViews(Iterable<RedisURI> seed,
Duration connectTimeout,
boolean discovery)
|
| Modifier and Type | Method and Description |
|---|---|
CompletionStage<Map<RedisURI,Partitions>> |
ClusterTopologyRefresh.loadViews(Iterable<RedisURI> seed,
Duration connectTimeout,
boolean discovery)
|
static List<RedisClusterNode> |
TopologyComparators.predefinedSort(Iterable<RedisClusterNode> clusterNodes,
Iterable<RedisURI> fixedOrder)
Sort partitions by a
fixedOrder and by RedisURI. |
| Modifier and Type | Field and Description |
|---|---|
protected Map<RedisURI,RedisDatabase<C>> |
StatefulRedisMultiDbConnectionImpl.databases |
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
StatefulRedisMultiDbConnectionImpl.getCurrentEndpoint() |
RedisURI |
DatabaseConfig.getRedisURI()
Get the Redis URI.
|
RedisURI |
RedisDatabase.getRedisURI() |
| Modifier and Type | Method and Description |
|---|---|
Iterable<RedisURI> |
StatefulRedisMultiDbConnectionImpl.getEndpoints() |
Collection<RedisURI> |
MultiDbClient.getRedisURIs()
Get the configured Redis URIs.
|
| Modifier and Type | Method and Description |
|---|---|
void |
StatefulRedisMultiDbConnectionImpl.addDatabase(RedisURI redisURI,
float weight) |
static DatabaseConfig.Builder |
DatabaseConfig.builder(RedisURI redisURI)
Create a new
DatabaseConfig.Builder to construct DatabaseConfig. |
StatefulRedisConnection<?,?> |
DatabaseRawConnectionFactory.connectToDatabase(RedisURI endpoint)
Creates a new bare connection to the specified database endpoint.
|
CircuitBreaker |
StatefulRedisMultiDbConnectionImpl.getCircuitBreaker(RedisURI endpoint) |
boolean |
StatefulRedisMultiDbConnectionImpl.isHealthy(RedisURI endpoint) |
void |
StatefulRedisMultiDbConnectionImpl.removeDatabase(RedisURI redisURI) |
void |
StatefulRedisMultiDbPubSubConnectionImpl.switchToDatabase(RedisURI redisURI) |
void |
StatefulRedisMultiDbConnectionImpl.switchToDatabase(RedisURI redisURI) |
| Constructor and Description |
|---|
StatefulRedisMultiDbConnectionImpl(Map<RedisURI,RedisDatabase<C>> connections,
ClientResources resources,
RedisCodec<K,V> codec,
Supplier<JsonParser> parser,
io.lettuce.core.failover.DatabaseConnectionFactory<C,K,V> connectionFactory,
HealthStatusManager healthStatusManager) |
StatefulRedisMultiDbPubSubConnectionImpl(Map<RedisURI,RedisDatabase<StatefulRedisPubSubConnection<K,V>>> connections,
ClientResources resources,
RedisCodec<K,V> codec,
Supplier<JsonParser> parser,
io.lettuce.core.failover.DatabaseConnectionFactory<StatefulRedisPubSubConnection<K,V>,K,V> connectionFactory,
HealthStatusManager healthStatusManager) |
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
BaseRedisMultiDbConnection.getCurrentEndpoint()
Get the current database endpoint.
|
| Modifier and Type | Method and Description |
|---|---|
Iterable<RedisURI> |
BaseRedisMultiDbConnection.getEndpoints()
Get all available database endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
void |
BaseRedisMultiDbConnection.addDatabase(RedisURI redisURI,
float weight)
Add a new database to the multi-database connection.
|
CircuitBreaker |
BaseRedisMultiDbConnection.getCircuitBreaker(RedisURI endpoint)
Get the circuit breaker for a specific endpoint.
|
boolean |
BaseRedisMultiDbConnection.isHealthy(RedisURI endpoint)
Check if an endpoint is healthy (health status is HEALTHY and circuit breaker is CLOSED).
|
void |
BaseRedisMultiDbConnection.removeDatabase(RedisURI redisURI)
Remove a database from the multi-database connection.
|
void |
BaseRedisMultiDbConnection.switchToDatabase(RedisURI redisURI)
Switch to a different database.
|
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
HealthCheck.getEndpoint()
Get the endpoint being monitored.
|
RedisURI |
HealthStatusChangeEvent.getEndpoint() |
RedisURI |
HealthCheckImpl.getEndpoint() |
| Modifier and Type | Method and Description |
|---|---|
HealthCheck |
HealthStatusManagerImpl.add(RedisURI endpoint,
HealthCheckStrategy strategy) |
HealthCheck |
HealthStatusManager.add(RedisURI endpoint,
HealthCheckStrategy strategy)
Create and register a health check for the given endpoint.
|
HealthStatus |
PingStrategy.doHealthCheck(RedisURI endpoint) |
HealthStatus |
HealthCheckStrategy.doHealthCheck(RedisURI endpoint)
Perform the health check for the given endpoint.
|
HealthCheck |
HealthCheckCollection.get(RedisURI endpoint) |
HealthCheckStrategy |
HealthCheckStrategySupplier.get(RedisURI redisURI,
DatabaseRawConnectionFactory connectionFactory)
Get the health check strategy for the given Redis URI
|
HealthStatus |
HealthStatusManagerImpl.getHealthStatus(RedisURI endpoint) |
HealthStatus |
HealthStatusManager.getHealthStatus(RedisURI endpoint)
Get the health status for the given endpoint.
|
long |
HealthStatusManagerImpl.getMaxWaitFor(RedisURI endpoint) |
long |
HealthStatusManager.getMaxWaitFor(RedisURI endpoint)
Get the maximum wait time for the health check to complete.
|
void |
HealthStatusManagerImpl.registerListener(RedisURI endpoint,
HealthStatusListener listener) |
void |
HealthStatusManager.registerListener(RedisURI endpoint,
HealthStatusListener listener)
Register a listener to be notified when the health status of the given endpoint changes.
|
void |
HealthStatusManagerImpl.remove(RedisURI endpoint) |
void |
HealthStatusManager.remove(RedisURI endpoint)
Unregister the health check for the given endpoint.
|
HealthCheck |
HealthCheckCollection.remove(RedisURI endpoint) |
void |
HealthStatusManagerImpl.unregisterListener(RedisURI endpoint,
HealthStatusListener listener) |
void |
HealthStatusManager.unregisterListener(RedisURI endpoint,
HealthStatusListener listener)
Unregister a previously registered listener for the given endpoint.
|
| Constructor and Description |
|---|
HealthStatusChangeEvent(RedisURI endpoint,
HealthStatus oldStatus,
HealthStatus newStatus) |
| Modifier and Type | Method and Description |
|---|---|
static <K,V> StatefulRedisMasterReplicaConnection<K,V> |
MasterReplica.connect(RedisClient redisClient,
RedisCodec<K,V> codec,
RedisURI redisURI)
|
static <K,V> CompletableFuture<StatefulRedisMasterReplicaConnection<K,V>> |
MasterReplica.connectAsync(RedisClient redisClient,
RedisCodec<K,V> codec,
RedisURI redisURI)
|
| Modifier and Type | Method and Description |
|---|---|
static <K,V> StatefulRedisMasterReplicaConnection<K,V> |
MasterReplica.connect(RedisClient redisClient,
RedisCodec<K,V> codec,
Iterable<RedisURI> redisURIs)
|
static <K,V> CompletableFuture<StatefulRedisMasterReplicaConnection<K,V>> |
MasterReplica.connectAsync(RedisClient redisClient,
RedisCodec<K,V> codec,
Iterable<RedisURI> redisURIs)
|
| Modifier and Type | Method and Description |
|---|---|
static <K,V> StatefulRedisMasterSlaveConnection<K,V> |
MasterSlave.connect(RedisClient redisClient,
RedisCodec<K,V> codec,
RedisURI redisURI)
Deprecated.
|
static <K,V> CompletableFuture<StatefulRedisMasterSlaveConnection<K,V>> |
MasterSlave.connectAsync(RedisClient redisClient,
RedisCodec<K,V> codec,
RedisURI redisURI)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static <K,V> StatefulRedisMasterSlaveConnection<K,V> |
MasterSlave.connect(RedisClient redisClient,
RedisCodec<K,V> codec,
Iterable<RedisURI> redisURIs)
Deprecated.
|
static <K,V> CompletableFuture<StatefulRedisMasterSlaveConnection<K,V>> |
MasterSlave.connectAsync(RedisClient redisClient,
RedisCodec<K,V> codec,
Iterable<RedisURI> redisURIs)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
RedisURI |
RedisNodeDescription.getUri() |
| Modifier and Type | Method and Description |
|---|---|
SocketAddress |
SocketAddressResolver.resolve(RedisURI redisURI)
Resolve a
RedisURI to a SocketAddress. |
SocketAddress |
MappingSocketAddressResolver.resolve(RedisURI redisURI) |
static SocketAddress |
SocketAddressResolver.resolve(RedisURI redisURI,
DnsResolver dnsResolver)
Resolves a
RedisURI to a SocketAddress. |
Copyright © 2025 lettuce.io. All rights reserved.