Справочник команд

pgBackRest справочник команд со всеми параметрами для резервного копирования, восстановления, архивирования и операций управления

Справочник

Введение

Команды используются для выполнения различных функций pgBackRest. Здесь перечислены исчерпывающе все параметры команд, то есть каждый параметр, применимый к команде, указан вместе с этой командой, даже если он применим к одной или нескольким другим командам. Это включает все параметры, которые также могут быть настроены в pgbackrest.conf.

Опции, не являющиеся логическими, настроенные в pgbackrest.conf, могут быть сброшены на значения по умолчанию на командной строке с использованием префикса reset-. Эта функция может использоваться для восстановления резервной копии непосредственно на сервере репозитория. Обычно pgBackRest выдает ошибку, поскольку видит, что хост базы данных удалённый, и восстановление не может выполняться удалённо. Добавив --reset-pg1-host на командной строке, pgBackRest проигнорирует удалённый хост базы данных и выполнит восстановление локально. Возможно, потребуется передать новый --pg1-path, чтобы заставить восстановление произойти в определённом пути, i.e, а не в пути, использованном на хосте базы данных.

Предикат no- может использоваться для установки логического параметра в значение false из командной строки.

Любая опция может быть установлена в переменной среды с использованием префикса PGBACKREST_ и имени опции в верхнем регистре, заменяя - на _, e.g. pg1-path превращается в PGBACKREST_PG1_PATH, а stanza — в PGBACKREST_STANZA. Логические опции представляются так же, как в файле конфигурации, e.g. Варианты PGBACKREST_COMPRESS="n" и reset-* не допускаются. Опции, которые могут быть указаны несколько раз в командной строке или в файле конфигурации, могут быть представлены путём разделения значений двоеточиями, e.g. PGBACKREST_DB_INCLUDE="db1:db2".

Опции командной строки переопределяют опции среды, которые переопределяют опции файлов конфигурации.

См. Введение в конфигурацию для получения сведений о типах параметров

Команды

Команда	Краткое описание
`annotate`	Добавление, изменение или удаление аннотаций резервной копии после её создания.
`archive-get`	Получение архивированных сегментов WAL для восстановления, PITR или восстановления реплики.
`archive-push`	Принятие сегментов WAL от PostgreSQL и передача их в настроенные репозитории.
`backup`	Создание резервных копий в целевом репозитории (по умолчанию — репозиторий с наивысшим приоритетом).
`check`	Проверить конфигурацию резервной копии/stanza и архива, а также состояние архивирования WAL.
`expire`	Удалить резервные копии и архивированные WAL на основе настроенных политик хранения.
`help`	Показать справку по команде и параметрам на уровне общего, командного или параметрического.
`info`	Отобразить состояние/stanza и резервной копии/метаданные в текстовом или JSON формате.
`repo-get`	Прочитать файлы репозитория (например, `cat`) для администрирования, анализа и тестирования.
`repo-ls`	Вывести список файлов/путей репозитория (например, `ls`) для администрирования, анализа и тестирования.
`restore`	Восстановление из резервной копии (последняя по умолчанию) с необязательным восстановлением до определённого момента времени.
`server`	Запуск сервера pgBackRest TLS для удалённого доступа без SSH.
`server-ping`	Проверка доступности сервера pgBackRest TLS для подтверждения установления соединения.
`stanza-create`	Создание метаданных stanza во всех настроенных репозиториях.
`stanza-delete`	Постоянное удаление всех резервных копий и архивов для stanza.
`stanza-upgrade`	Обновление метаданных stanza после обновления основной версии PostgreSQL.
`start`	Разрешить повторный запуск процессов pgBackRest после предыдущего `stop`.
`stop`	Запретить запуск новых процессов pgBackRest и по желанию принудительно остановить работающие.
`verify`	Проверить корректность данных резервной копии и архива в репозитории.
`version`	Отобразить установленную версию pgBackRest.