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

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

---

Индекс LLMS: [llms.txt](/ru/llms.txt)

---

## Введение {#introduction}

Команды выполняют различные функции 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"`.

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

Сведения о типах параметров приведены во [введении в конфигурацию](/ru/docs/pgbackrest/configuration/#introduction)

## Команды {#commands}

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

---

Страницы раздела:

- [Команда аннотирования (annotate)](/ru/docs/pgbackrest/command/annotate/): Справочник по параметрам и поведению команды pgBackRest `annotate`.
- [Команда получения из архива (archive-get)](/ru/docs/pgbackrest/command/archive-get/): Справочник по параметрам и поведению команды pgBackRest `archive-get`.
- [Команда отправки в архив (archive-push)](/ru/docs/pgbackrest/command/archive-push/): Справочник по параметрам и поведению команды pgBackRest `archive-push`.
- [Команда резервного копирования (backup)](/ru/docs/pgbackrest/command/backup/): Справочник по параметрам и поведению команды pgBackRest `backup`.
- [Команда проверки конфигурации (check)](/ru/docs/pgbackrest/command/check/): Справочник по параметрам и поведению команды pgBackRest `check`.
- [Команда удаления устаревших копий (expire)](/ru/docs/pgbackrest/command/expire/): Справочник по параметрам и поведению команды pgBackRest `expire`.
- [Команда справки (help)](/ru/docs/pgbackrest/command/help/): Справочник по параметрам и поведению команды pgBackRest `help`.
- [Команда вывода сведений (info)](/ru/docs/pgbackrest/command/info/): Справочник по параметрам и поведению команды pgBackRest `info`.
- [Команда чтения из репозитория (repo-get)](/ru/docs/pgbackrest/command/repo-get/): Справочник по параметрам и поведению команды pgBackRest `repo-get`.
- [Команда просмотра репозитория (repo-ls)](/ru/docs/pgbackrest/command/repo-ls/): Справочник по параметрам и поведению команды pgBackRest `repo-ls`.
- [Команда восстановления (restore)](/ru/docs/pgbackrest/command/restore/): Справочник по параметрам и поведению команды pgBackRest `restore`.
- [Команда сервера (server)](/ru/docs/pgbackrest/command/server/): Справочник по параметрам и поведению команды pgBackRest `server`.
- [Команда проверки доступности сервера (server-ping)](/ru/docs/pgbackrest/command/server-ping/): Справочник по параметрам и поведению команды pgBackRest `server-ping`.
- [Команда создания stanza (stanza-create)](/ru/docs/pgbackrest/command/stanza-create/): Справочник по параметрам и поведению команды pgBackRest `stanza-create`.
- [Команда удаления stanza (stanza-delete)](/ru/docs/pgbackrest/command/stanza-delete/): Справочник по параметрам и поведению команды pgBackRest `stanza-delete`.
- [Команда обновления stanza (stanza-upgrade)](/ru/docs/pgbackrest/command/stanza-upgrade/): Справочник по параметрам и поведению команды pgBackRest `stanza-upgrade`.
- [Команда разрешения запуска (start)](/ru/docs/pgbackrest/command/start/): Справочник по параметрам и поведению команды pgBackRest `start`.
- [Команда остановки (stop)](/ru/docs/pgbackrest/command/stop/): Справочник по параметрам и поведению команды pgBackRest `stop`.
- [Команда проверки данных (verify)](/ru/docs/pgbackrest/command/verify/): Справочник по параметрам и поведению команды pgBackRest `verify`.
- [Команда версии (version)](/ru/docs/pgbackrest/command/version/): Справочник по параметрам и поведению команды pgBackRest `version`.
