MultiDbConfig (Jedis 7.0.0 API)

java.lang.Object
- redis.clients.jedis.MultiDbConfig

```
@Experimental
public final class MultiDbConfig
extends java.lang.Object
```
Configuration class for multi-database Redis deployments with automatic failover and failback capabilities.
This configuration enables seamless failover between multiple Redis databases endpoints by providing comprehensive settings for retry logic, circuit breaker behavior, health checks, and failback mechanisms. It is designed to work with MultiDbConnectionProvider to provide high availability and disaster recovery capabilities.

Key Features:
- Multi-Database Support: Configure multiple Redis endpoints with individual weights and health checks
- Circuit Breaker Pattern: Automatic failure detection and circuit opening based on configurable thresholds
- Retry Logic: Configurable retry attempts with exponential backoff for transient failures
- Health Check Integration: Pluggable health check strategies for proactive monitoring
- Automatic Failback: Intelligent failback to higher-priority databases when they recover
- Weight-Based Routing: Priority-based database selection using configurable weights
Usage Example:
```
 {
   @code
   // Configure individual databases
   DatabaseConfig primary = DatabaseConfig.builder(primaryEndpoint, clientConfig).weight(1.0f)
       .build();

   DatabaseConfig secondary = DatabaseConfig.builder(secondaryEndpoint, clientConfig).weight(0.5f)
       .healthCheckEnabled(true).build();

   // Build multi-database configuration
   MultiDbConfig config = MultiDbConfig.builder(primary, secondary)
       .failureDetector(CircuitBreakerConfig.builder().failureRateThreshold(10.0f).build())
       .commandRetry(RetryConfig.builder().maxAttempts(3).build()).failbackSupported(true)
       .gracePeriod(10000).build();

   // Use with connection provider
   MultiDbConnectionProvider provider = new MultiDbConnectionProvider(config);
 }
 
```
The configuration leverages Resilience4j for circuit breaker and retry implementations, providing battle-tested fault tolerance patterns.
Since:

7.0

See Also:

MultiDbConnectionProvider, HealthCheckStrategy, PingStrategy, LagAwareStrategy

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MultiDbConfig.Builder` Builder class for creating MultiDbConfig instances with comprehensive configuration options.
`static class`	`MultiDbConfig.CircuitBreakerConfig` Configuration for circuit breaker failure detection.
`static class`	`MultiDbConfig.DatabaseConfig` Configuration class for individual Redis database endpoints within a multi-database setup.
`static class`	`MultiDbConfig.RetryConfig` Configuration for command retry behavior.
`static interface`	`MultiDbConfig.StrategySupplier` Functional interface for creating `HealthCheckStrategy` instances for specific Redis endpoints.

Constructor Summary

Constructors
Constructor and Description

MultiDbConfig(MultiDbConfig.DatabaseConfig[] databaseConfigs)
Constructs a new MultiDbConfig with the specified database configurations.

Constructors
Constructor and Description
`MultiDbConfig(MultiDbConfig.DatabaseConfig[] databaseConfigs)` Constructs a new MultiDbConfig with the specified database configurations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MultiDbConfig.Builder`	`builder()` Creates a new Builder instance for configuring MultiDbConfig.
`static MultiDbConfig.Builder`	`builder(java.util.List<MultiDbConfig.DatabaseConfig> databaseConfigs)` Creates a new Builder instance for configuring MultiDbConfig.
`static MultiDbConfig.Builder`	`builder(MultiDbConfig.DatabaseConfig[] databaseConfigs)` Creates a new Builder instance for configuring MultiDbConfig.
`MultiDbConfig.RetryConfig`	`getCommandRetry()` Returns the encapsulated retry configuration for command execution.
`MultiDbConfig.DatabaseConfig[]`	`getDatabaseConfigs()` Returns the array of database configurations defining available Redis endpoints.
`int`	`getDelayInBetweenFailoverAttempts()` Returns the delay in milliseconds between failover attempts.
`long`	`getFailbackCheckInterval()` Returns the interval between checks for failback opportunities.
`MultiDbConfig.CircuitBreakerConfig`	`getFailureDetector()` Returns the encapsulated circuit breaker configuration for failure detection.
`java.util.List<java.lang.Class<? extends java.lang.Throwable>>`	`getFallbackExceptionList()` Returns the list of exception classes that trigger immediate fallback to next database.
`long`	`getGracePeriod()` Returns the grace period to keep databases disabled after they become unhealthy.
`int`	`getMaxNumFailoverAttempts()` Returns the maximum number of failover attempts.
`boolean`	`isFailbackSupported()` Returns whether automatic failback to higher-priority databases is supported.
`boolean`	`isFastFailover()` Returns whether connections are forcefully terminated during failover.
`boolean`	`isRetryOnFailover()` Returns whether failed commands are retried during failover.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MultiDbConfig
```
public MultiDbConfig(MultiDbConfig.DatabaseConfig[] databaseConfigs)
```
    Constructs a new MultiDbConfig with the specified database configurations.
    This constructor validates that at least one database configuration is provided and that all configurations are non-null. Use the Builder class for more convenient configuration with default values.
    
    Parameters:
    
    databaseConfigs - array of database configurations defining the available Redis endpoints
    
    Throws:
    
    JedisValidationException - if databaseConfigs is null or empty
    
    java.lang.IllegalArgumentException - if any database configuration is null
    
    See Also:
    
    Builder#Builder(DatabaseConfig[])
- Method Detail
  - getDatabaseConfigs
```
public MultiDbConfig.DatabaseConfig[] getDatabaseConfigs()
```
    Returns the array of database configurations defining available Redis endpoints.
    
    Returns:
    
    array of database configurations, never null or empty
  - getCommandRetry
```
public MultiDbConfig.RetryConfig getCommandRetry()
```
    Returns the encapsulated retry configuration for command execution.
    This provides access to all retry-related settings through a single configuration object.
    
    Returns:
    
    retry configuration, never null
    
    See Also:
    
    MultiDbConfig.RetryConfig
  - getFailureDetector
```
public MultiDbConfig.CircuitBreakerConfig getFailureDetector()
```
    Returns the encapsulated circuit breaker configuration for failure detection.
    This provides access to all circuit breaker-related settings through a single configuration object.
    
    Returns:
    
    circuit breaker configuration, never null
    
    See Also:
    
    MultiDbConfig.CircuitBreakerConfig
  - getFallbackExceptionList
```
public java.util.List<java.lang.Class<? extends java.lang.Throwable>> getFallbackExceptionList()
```
    Returns the list of exception classes that trigger immediate fallback to next database.
    
    Returns:
    
    list of exception classes that trigger fallback, never null
    
    See Also:
    
    fallbackExceptionList
  - isRetryOnFailover
```
public boolean isRetryOnFailover()
```
    Returns whether failed commands are retried during failover.
    
    Returns:
    
    true if commands are retried during failover, false otherwise
    
    See Also:
    
    retryOnFailover
  - isFailbackSupported
```
public boolean isFailbackSupported()
```
    Returns whether automatic failback to higher-priority databases is supported.
    
    Returns:
    
    true if automatic failback is enabled, false if manual failback is required
    
    See Also:
    
    isFailbackSupported
  - getFailbackCheckInterval
```
public long getFailbackCheckInterval()
```
    Returns the interval between checks for failback opportunities.
    
    Returns:
    
    failback check interval in milliseconds
    
    See Also:
    
    failbackCheckInterval
  - getGracePeriod
```
public long getGracePeriod()
```
    Returns the grace period to keep databases disabled after they become unhealthy.
    
    Returns:
    
    grace period in milliseconds
    
    See Also:
    
    gracePeriod
  - getMaxNumFailoverAttempts
```
public int getMaxNumFailoverAttempts()
```
    Returns the maximum number of failover attempts.
    
    Returns:
    
    maximum number of failover attempts
    
    See Also:
    
    maxNumFailoverAttempts
  - getDelayInBetweenFailoverAttempts
```
public int getDelayInBetweenFailoverAttempts()
```
    Returns the delay in milliseconds between failover attempts.
    
    Returns:
    
    delay in milliseconds between failover attempts
    
    See Also:
    
    delayInBetweenFailoverAttempts
  - isFastFailover
```
public boolean isFastFailover()
```
    Returns whether connections are forcefully terminated during failover.
    
    Returns:
    
    true if fast failover is enabled, false for graceful failover
    
    See Also:
    
    fastFailover
  - builder
```
public static MultiDbConfig.Builder builder()
```
    Creates a new Builder instance for configuring MultiDbConfig.
    At least one database configuration must be added to the builder before calling build(). Use the endpoint() methods to add database configurations.
    
    Returns:
    
    new Builder instance
    
    Throws:
    
    JedisValidationException - if databaseConfigs is null or empty
    
    See Also:
    
    Builder#Builder(DatabaseConfig[])
  - builder
```
public static MultiDbConfig.Builder builder(MultiDbConfig.DatabaseConfig[] databaseConfigs)
```
    Creates a new Builder instance for configuring MultiDbConfig.
    
    Parameters:
    
    databaseConfigs - array of database configurations defining available Redis endpoints
    
    Returns:
    
    new Builder instance
    
    Throws:
    
    JedisValidationException - if databaseConfigs is null or empty
    
    See Also:
    
    Builder#Builder(DatabaseConfig[])
  - builder
```
public static MultiDbConfig.Builder builder(java.util.List<MultiDbConfig.DatabaseConfig> databaseConfigs)
```
    Creates a new Builder instance for configuring MultiDbConfig.
    
    Parameters:
    
    databaseConfigs - list of database configurations defining available Redis endpoints
    
    Returns:
    
    new Builder instance
    
    Throws:
    
    JedisValidationException - if databaseConfigs is null or empty
    
    See Also:
    
    Builder#Builder(List)

Class MultiDbConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiDbConfig

Method Detail

getDatabaseConfigs

getCommandRetry

getFailureDetector

getFallbackExceptionList

isRetryOnFailover

isFailbackSupported

getFailbackCheckInterval

getGracePeriod

getMaxNumFailoverAttempts

getDelayInBetweenFailoverAttempts

isFastFailover

builder

builder

builder