Команды управления кластером в режиме bridge

Функциональность Корпоративной СУБД Яндекса

Данная функциональность доступна только в Корпоративной СУБД Яндекса. В open-source версии YDB она отсутствует.

Команды управления кластером в режиме bridge позволяют просматривать состояние pile, выполнять плановую и аварийную смену PRIMARY, временно выводить pile на обслуживание и возвращать его в кластер.

Внимание

Команды из этого раздела могут нанести вред вашему кластеру при неправильном использовании. Из-за потенциально опасного характера этих команд ВСЕ глобальные параметры должны быть заданы явно. Профили отключены по умолчанию и используются только при явном указании (--profile <имя-профиля>). Некоторые команды не требуют глобальных опций, которые в противном случае являются обязательными.

Общий синтаксис вызова команд управления кластером в режиме bridge:

ydb [global options...] admin cluster bridge [command options...] <subcommand>

где:

  • ydb — команда запуска YDB CLI из командной строки операционной системы;
  • [global options] — глобальные параметры, одинаковые для всех команд YDB CLI;
  • admin cluster bridge — команда управления конфигурацией кластера;
  • [command options] — параметры команды, специфичные для каждой команды и подкоманды;
  • <subcommand> — подкоманда.

Команды

Ниже представлен список доступных подкоманд для управления кластером в режиме bridge. Любую команду можно вызвать с опцией --help для получения справки по ней.

Команда / подкоманда Краткое описание
admin cluster bridge list Вывод состояния pile
admin cluster bridge switchover Плановая смена PRIMARY
admin cluster bridge failover Аварийное переключение
admin cluster bridge takedown Вывод pile из кластера
admin cluster bridge rejoin Возвращение pile в кластер