Справочник команд
Введение
Команды выполняют различные функции pgBackRest. Здесь приведён полный список параметров команд: каждый применимый к команде параметр перечислен в её описании, даже если он применим и к другим командам. Сюда входят все параметры, которые также можно настроить в pgbackrest.conf.
Параметры, не имеющие логического типа, заданные в pgbackrest.conf, можно сбросить к значениям по умолчанию из командной строки с помощью префикса reset-. Это позволяет восстановить резервную копию непосредственно на сервере репозитория. Обычно pgBackRest выдаёт ошибку, поскольку определяет, что сервер базы данных удалённый, а удалённое восстановление невозможно. Если добавить --reset-pg1-host в командную строку, pgBackRest проигнорирует удалённый сервер базы данных и выполнит восстановление локально. Может потребоваться передать новый --pg1-path, чтобы выполнить восстановление в определённый каталог, отличный от каталога на сервере базы данных.
Префикс no- позволяет задать логическому параметру значение false в командной строке.
Любой параметр можно задать переменной окружения, добавив префикс PGBACKREST_ к имени параметра в верхнем регистре и заменив - на _: например, pg1-path превращается в PGBACKREST_PG1_PATH, а stanza — в PGBACKREST_STANZA. Логические параметры представляются так же, как в файле конфигурации, например PGBACKREST_COMPRESS="n"; варианты reset-* не допускаются. Для параметров, которые можно указывать несколько раз в командной строке или файле конфигурации, значения разделяются двоеточиями, например 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
|
Запуск TLS-сервера pgBackRest для доступа к удалённому серверу без SSH. |
server-ping
|
Проверка того, что TLS-сервер pgBackRest принимает соединения. |
stanza-create
|
Создание метаданных stanza во всех настроенных репозиториях. |
stanza-delete
|
Безвозвратное удаление всех резервных копий и архивов stanza. |
stanza-upgrade
|
Обновление метаданных stanza после обновления основной версии PostgreSQL. |
start
|
Возобновление разрешения на запуск процессов pgBackRest после команды stop. |
stop
|
Запрет запуска новых процессов pgBackRest и, при необходимости, принудительная остановка работающих. |
verify
|
Проверка корректности данных резервных копий и архива в репозитории. |
version
|
Вывод установленной версии pgBackRest. |
Справочник по параметрам и поведению команды pgBackRest annotate.
Справочник по параметрам и поведению команды pgBackRest archive-get.
Справочник по параметрам и поведению команды pgBackRest archive-push.
Справочник по параметрам и поведению команды pgBackRest backup.
Справочник по параметрам и поведению команды pgBackRest check.
Справочник по параметрам и поведению команды pgBackRest expire.
Справочник по параметрам и поведению команды pgBackRest help.
Справочник по параметрам и поведению команды pgBackRest info.
Справочник по параметрам и поведению команды pgBackRest repo-get.
Справочник по параметрам и поведению команды pgBackRest repo-ls.
Справочник по параметрам и поведению команды pgBackRest restore.
Справочник по параметрам и поведению команды pgBackRest server.
Справочник по параметрам и поведению команды pgBackRest server-ping.
Справочник по параметрам и поведению команды pgBackRest stanza-create.
Справочник по параметрам и поведению команды pgBackRest stanza-delete.
Справочник по параметрам и поведению команды pgBackRest stanza-upgrade.
Справочник по параметрам и поведению команды pgBackRest start.
Справочник по параметрам и поведению команды pgBackRest stop.
Справочник по параметрам и поведению команды pgBackRest verify.
Справочник по параметрам и поведению команды pgBackRest version.