Module cartridge.lua-api.failover
Administration functions (failover related).
Functions
get_params () | Get failover configuration. |
set_params (opts) | Configure automatic failover. |
get_failover_enabled () | Get current failover state. |
set_failover_enabled (enabled) | Enable or disable automatic failover. |
Tables
FailoverParams | Failover parameters. |
Functions
- get_params ()
-
Get failover configuration.
(Added in v2.0.1-95)
Returns:
- set_params (opts)
-
Configure automatic failover.
(Added in v2.0.1-95)
Parameters:
Returns:
-
boolean
true
if config applied successfullyOr
- nil
- table Error description
- get_failover_enabled ()
-
Get current failover state.
(Deprecated since v2.0.1-95)
- set_failover_enabled (enabled)
-
Enable or disable automatic failover.
(Deprecated since v2.0.1-95)
Parameters:
- enabled boolean
Returns:
-
boolean
New failover state
Or
- nil
- table Error description