io.lettuce.core.failover

Interface MultiDbClient

All Superinterfaces:

AutoCloseable, BaseRedisClient

@Experimental
public interface MultiDbClient
extends BaseRedisClient

Since:

7.4

Author:

Ali Takavci

Method Summary

Modifier and Type	Method and Description
StatefulRedisMultiDbConnection<String,String>	connect() Open a new multi database connection to a Redis server that treats keys and values as UTF-8 strings.
<K,V> StatefulRedisMultiDbConnection<K,V>	connect(RedisCodec<K,V> codec) Open a new multi database connection to a Redis server.
MultiDbConnectionFuture<StatefulRedisMultiDbConnection<String,String>>	connectAsync() Open asynchronously a new multi database connection to a Redis server that treats keys and values as UTF-8 strings.
<K,V> MultiDbConnectionFuture<StatefulRedisMultiDbConnection<K,V>>	connectAsync(RedisCodec<K,V> codec) Open asynchronously a new multi database connection to a Redis server.
StatefulRedisMultiDbPubSubConnection<String,String>	connectPubSub() Open a new multi database pub/sub connection to a Redis server that treats keys and values as UTF-8 strings.
<K,V> StatefulRedisMultiDbPubSubConnection<K,V>	connectPubSub(RedisCodec<K,V> codec) Open a new multi database pub/sub connection to a Redis server.
MultiDbConnectionFuture<StatefulRedisMultiDbPubSubConnection<String,String>>	connectPubSubAsync() Open asynchronously a new multi database pub/sub connection to a Redis server that treats keys and values as UTF-8 strings.
<K,V> MultiDbConnectionFuture<StatefulRedisMultiDbPubSubConnection<K,V>>	connectPubSubAsync(RedisCodec<K,V> codec) Open asynchronously a new multi database pub/sub connection to a Redis server.
static MultiDbClient	create(ClientResources resources, Collection<DatabaseConfig> databaseConfigs) Create a new MultiDbClient with the given client resources and database configurations.
static MultiDbClient	create(ClientResources resources, Collection<DatabaseConfig> databaseConfigs, MultiDbOptions multiDbOptions) Create a new MultiDbClient with the given client resources, database configurations, and multi-database options.
static MultiDbClient	create(Collection<DatabaseConfig> databaseConfigs) Create a new MultiDbClient with the given database configurations.
static MultiDbClient	create(Collection<DatabaseConfig> databaseConfigs, MultiDbOptions multiDbOptions) Create a new MultiDbClient with the given database configurations and multi-database options.
MultiDbOptions	getMultiDbOptions() Gets the multi-database options.
Collection<RedisURI>	getRedisURIs() Get the configured Redis URIs.

Methods inherited from interface io.lettuce.core.api.BaseRedisClient

addListener, addListener, getResources, removeListener, removeListener, shutdown, shutdown, shutdown, shutdownAsync, shutdownAsync

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static MultiDbClient create(Collection<DatabaseConfig> databaseConfigs)

Create a new MultiDbClient with the given database configurations.

Parameters:

databaseConfigs - the database configurations

Returns:

a new MultiDbClient

Since:

7.4

create

static MultiDbClient create(ClientResources resources,
                            Collection<DatabaseConfig> databaseConfigs)

Create a new MultiDbClient with the given client resources and database configurations.

Parameters:

resources - the client resources

databaseConfigs - the database configurations

Returns:

a new MultiDbClient

Since:

7.4

create

static MultiDbClient create(Collection<DatabaseConfig> databaseConfigs,
                            MultiDbOptions multiDbOptions)

Create a new MultiDbClient with the given database configurations and multi-database options.

Parameters:

databaseConfigs - the database configurations

multiDbOptions - the multi-database options

Returns:

a new MultiDbClient

Since:

7.4

create

static MultiDbClient create(ClientResources resources,
                            Collection<DatabaseConfig> databaseConfigs,
                            MultiDbOptions multiDbOptions)

Create a new MultiDbClient with the given client resources, database configurations, and multi-database options.

Parameters:

resources - the client resources

databaseConfigs - the database configurations

multiDbOptions - the multi-database options

Returns:

a new MultiDbClient

Since:

7.4

getRedisURIs

Collection<RedisURI> getRedisURIs()

Get the configured Redis URIs.

Returns:

the configured Redis URIs

connect

<K,V> StatefulRedisMultiDbConnection<K,V> connect(RedisCodec<K,V> codec)

Open a new multi database connection to a Redis server. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new stateful Redis connection

connect

StatefulRedisMultiDbConnection<String,String> connect()

Open a new multi database connection to a Redis server that treats keys and values as UTF-8 strings.

Returns:

A new stateful Redis connection

connectPubSub

<K,V> StatefulRedisMultiDbPubSubConnection<K,V> connectPubSub(RedisCodec<K,V> codec)

Open a new multi database pub/sub connection to a Redis server. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new stateful pub/sub connection

connectPubSub

StatefulRedisMultiDbPubSubConnection<String,String> connectPubSub()

Open a new multi database pub/sub connection to a Redis server that treats keys and values as UTF-8 strings.

Returns:

A new stateful pub/sub connection

connectAsync

<K,V> MultiDbConnectionFuture<StatefulRedisMultiDbConnection<K,V>> connectAsync(RedisCodec<K,V> codec)

Open asynchronously a new multi database connection to a Redis server. Use the supplied codec to encode/decode keys and values.

The returned MultiDbConnectionFuture ensures that all callbacks (thenApply, thenAccept, etc.) execute on a separate thread pool rather than on Netty event loop threads, preventing deadlocks when calling blocking sync operations inside callbacks.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

a MultiDbConnectionFuture that is notified with the connection progress.

Since:

7.4

connectAsync

MultiDbConnectionFuture<StatefulRedisMultiDbConnection<String,String>> connectAsync()

Open asynchronously a new multi database connection to a Redis server that treats keys and values as UTF-8 strings.

The returned MultiDbConnectionFuture ensures that all callbacks (thenApply, thenAccept, etc.) execute on a separate thread pool rather than on Netty event loop threads, preventing deadlocks when calling blocking sync operations inside callbacks.

Returns:

a MultiDbConnectionFuture that is notified with the connection progress.

Since:

7.4

connectPubSubAsync

<K,V> MultiDbConnectionFuture<StatefulRedisMultiDbPubSubConnection<K,V>> connectPubSubAsync(RedisCodec<K,V> codec)

Open asynchronously a new multi database pub/sub connection to a Redis server. Use the supplied codec to encode/decode keys and values.

The returned MultiDbConnectionFuture ensures that all callbacks (thenApply, thenAccept, etc.) execute on a separate thread pool rather than on Netty event loop threads, preventing deadlocks when calling blocking sync operations inside callbacks.

Type Parameters:

K - Key type

V - Value type

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

a MultiDbConnectionFuture that is notified with the pub/sub connection progress.

Since:

7.4

connectPubSubAsync

MultiDbConnectionFuture<StatefulRedisMultiDbPubSubConnection<String,String>> connectPubSubAsync()

Open asynchronously a new multi database pub/sub connection to a Redis server that treats keys and values as UTF-8 strings.

The returned MultiDbConnectionFuture ensures that all callbacks (thenApply, thenAccept, etc.) execute on a separate thread pool rather than on Netty event loop threads, preventing deadlocks when calling blocking sync operations inside callbacks.

Returns:

a MultiDbConnectionFuture that is notified with the pub/sub connection progress.

Since:

7.4

getMultiDbOptions

MultiDbOptions getMultiDbOptions()

Gets the multi-database options.

Returns:

the multi-database options