Bridge cluster management commands
Feature of Yandex Enterprise Database
This functionality is available only in the Yandex Enterprise Database. In the open-source version of YDB it is absent.
Commands for managing the cluster in bridge mode let you view pile state, perform planned and emergency PRIMARY change, temporarily take a pile out for maintenance, and return it to the cluster.
Alert
Commands in this section can harm your cluster if used incorrectly. Due to the potentially dangerous nature of these commands, ALL global parameters must be specified explicitly. Profiles are disabled by default and are only used when explicitly specified (--profile <profile-name>). Some commands do not require global options that are otherwise mandatory.
General syntax for bridge cluster management commands:
ydb [global options...] admin cluster bridge [command options...] <subcommand>
where:
ydb— command to launch YDB CLI from the operating system command line;[global options]— global parameters common to all YDB CLI commands;admin cluster bridge— cluster configuration management command;[command options]— parameters specific to each command and subcommand;<subcommand>— subcommand.
Commands
Below is the list of available subcommands for bridge cluster management. You can run any command with the --help option for help.
| Command / subcommand | Brief description |
|---|---|
| admin cluster bridge list | List pile state |
| admin cluster bridge switchover | Planned PRIMARY change |
| admin cluster bridge failover | Emergency failover |
| admin cluster bridge takedown | Take pile out of cluster |
| admin cluster bridge rejoin | Return pile to cluster |