io.lettuce.core.failover.api

Class MultiDbOptions

java.lang.Object

io.lettuce.core.failover.api.MultiDbOptions

@Experimental
public class MultiDbOptions
extends Object

Options for multi-database client behavior.

This class contains configuration options that apply at the multi-database level, such as failback behavior. Individual database configurations are managed separately via DatabaseConfig.

Since:

7.4

Author:

Ali TAKAVCI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiDbOptions.Builder Builder for MultiDbOptions.

Method Summary

Modifier and Type	Method and Description
static MultiDbOptions.Builder	builder() Creates a new builder for MultiDbOptions.
static MultiDbOptions	create() Creates a default MultiDbOptions with failback enabled and default check interval.
Duration	getDelayInBetweenFailoverAttempts() Returns the delay between failover attempts when no healthy database is available.
Duration	getFailbackCheckInterval() Returns the interval in milliseconds for checking if failed databases have recovered.
Duration	getGracePeriod() Returns the grace period duration that starts when a database is failed over from.
InitializationPolicy	getInitializationPolicy() Returns the initialization policy.
boolean	isFailbackSupported() Returns whether automatic failback to higher-priority databases is supported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isFailbackSupported

public boolean isFailbackSupported()

Returns whether automatic failback to higher-priority databases is supported.

Returns:

true if failback is supported

getFailbackCheckInterval

public Duration getFailbackCheckInterval()

Returns the interval in milliseconds for checking if failed databases have recovered.

Returns:

the failback check interval in milliseconds

getInitializationPolicy

public InitializationPolicy getInitializationPolicy()

Returns the initialization policy.

Returns:

the initialization policy

getGracePeriod

public Duration getGracePeriod()

Returns the grace period duration that starts when a database is failed over from. During this grace period, no failbacks or failovers can trigger a switch back to that database until the duration ends.

Returns:

the grace period duration

getDelayInBetweenFailoverAttempts

public Duration getDelayInBetweenFailoverAttempts()

Returns the delay between failover attempts when no healthy database is available.

When all databases are unhealthy and no failover target can be selected, the client will wait for this duration before retrying to find a healthy database.

Returns:

the delay between failover attempts

builder

public static MultiDbOptions.Builder builder()

Creates a new builder for MultiDbOptions.

Returns:

a new builder instance

create

public static MultiDbOptions create()

Creates a default MultiDbOptions with failback enabled and default check interval.

Returns:

a default options instance