Утилита резервного копирования copywala-ob

copywala-ob - утилита командной строки для резервного копирования и восстановления данных базы данных OceanBase Database.

Список консольных команд

Подсказка

Для всех команд доступны флаги:

• -h|--help – показать справку по команде;
• -c|--config <path to copywala-ob config> – по умолчанию используется /etc/pbr/copywala-ob.yaml.

Для перехода к информации о команде нажмите на ее описание в таблице.

Внимание!

:title: Экспериментальная возможность

Команды copywala-ob create-backup, copywala-ob restore, copywala-ob archive-logs и copywala-ob cache-clear утилиты Copywala OB являются экспериментальными возможностями.

Работоспособность экспериментальной возможности не гарантируется. Применять ее можно только в предварительно подготовленном тестовом окружении.

Команда	Описание
copywala-ob version	Вывод версии установленной утилиты copywala-ob
copywala-ob init <name>	Выполнение инициализации утилиты copywala-ob
copywala-ob db info	Вывод информации об экземпляре БД
copywala-ob create-backup <tenant name>	Создание резервной копии
copywala-ob restore <tenant name> <new tenant name>	Восстановление резервной копии
copywala-ob archive-logs <tenant name>	Непрерывная архивация логов OceanBase Database
copywala-ob cache-clear <tenant>	Очистка FUSE-кеша резервных копий тенанта

Описание команд

copywala-ob version

Описание:

Выводит версию установленной утилиты copywala-ob.

Синтаксис:

copywala-ob version [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml

Сценарии использования:

Вывод версии установленной утилиты copywala-ob.

copywala-ob init

Описание:

Выполняет инициализацию утилиты copywala-ob: создает идентификатор агента (application ID) и устанавливает имя агента. Инициализация обязательна для выполнения остальных команд утилиты. Команда идемпотентна: при повторном запуске с уже инициализированным агентом идентификатор не пересоздается, а выводится соответствующее предупреждение и завершается выполнение команды

Синтаксис:

copywala-ob init <name> [flags]

Обязательные параметры:

<name> – уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml

Сценарии использования:

Инициализация copywala-ob.

copywala-ob db info

Описание:

Выводит информацию об экземпляре базы данных OceanBase Database, к которому подключен агент copywala-ob: имя экземпляра, версия БД, список пользовательских тенантов и баз данных в них. Подключение выполняется от имени пользователя, определенного в параметре target_db конфигурационного файла. По умолчанию информация выводится в YAML-формате (при передаче флага --json — в формате JSON).

Синтаксис:

copywala-ob db info [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml
--json	Вывод информации в JSON-формате

Сценарии использования:

Вывод информации об экземпляре БД.

copywala-ob create-backup

Описание:

Создает резервную копию (РК) указанного тенанта OceanBase Database. Команда подключается к базе данных OceanBase Database по данным из конфигурационного файла, а к хранилищу – по параметрам backup_destination_uri и logs_destination_uri. Если не настроена непрерывная доставка архивных логов, команда запускает архивацию логов на время создания РК и дожидается корректного SCN перед остановкой. Тип копии (полная или дельта) определяется конфигурационным параметром backup_policy.strategy.

В текущей версии резервная копия создается только в S3-совместимое хранилище (режим backup_mode: s3-proxy).

Если непрерывная архивация логов уже запущена (например, командой copywala-ob archive-logs), существующий поток используется и по завершении РК не останавливается.

Важно

:title: Использование FUSE (режим backup_mode: fuse-proxy) запрещено

Функциональность находится в разработке.

Синтаксис:

copywala-ob create-backup <tenant name> [flags]

Обязательные параметры:

<tenant name> – имя тенанта OceanBase Database, для которого создается резервная копия.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml

Сценарии использования:

Создание резервной копии.

copywala-ob restore

Описание:

Восстанавливает резервную копию указанного тенанта в тенант с новым именем. Команда подключается к базе данных OceanBase Database (системный тенант (sys-тенант)) по данным из конфигурационного файла и к хранилищу по параметрам backup_destination_uri и logs_destination_uri. Восстановление выполняется с использованием выделенного пула ресурсов из параметра restore_policy.with_statement. Ход восстановления отслеживается посредством опроса служебных таблиц и выводится в лог.

Синтаксис:

copywala-ob restore <tenant name> <new tenant name> [flags]

Обязательные параметры:

• <tenant name> – имя восстанавливаемого тенанта;
• <new tenant name> – новое имя восстановленного тенанта.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml
--until-scn <value>	Значение SCN, до которого выполняется восстановление тенанта (на какую точку времени восстанавливать)

Сценарии использования:

Восстановление резервной копии.

copywala-ob archive-logs

Описание:

Запускает непрерывную архивацию логов указанного тенанта OceanBase Database на хранилище. Команда подключается к базе данных OceanBase Database по данным из конфигурационного файла и к хранилищу по параметру logs_destination_uri, блокирует процесс и непрерывно архивирует логи.

Синтаксис:

copywala-ob archive-logs <tenant name> [flags]

Обязательные параметры:

<tenant name> – имя тенанта OceanBase Database, для которого запускается архивация логов.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-ob config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-ob.yaml

Сценарии использования:

Непрерывная архивация логов OceanBase Database.

copywala-ob cache-clear

Важно

:title: Использование FUSE запрещено

Функциональность находится в разработке.

Описание:

Удаляет постоянный FUSE-кеш резервных копий указанного тенанта.