Команда остановки (stop)

Запрещает запуск новых процессов pgBackRest. По умолчанию работающим процессам разрешается успешно завершиться. Для завершения работающих процессов используйте параметр --force.

Процессы pgBackRest, запущенные после завершения команды stop, возвращают ошибку. Дополнительные сведения и примеры приведены в разделе Запуск и остановка .

Параметры команды

Параметр принудительного выполнения (--force)

Принудительная остановка всех процессов pgBackRest.

Этот параметр отправляет сигналы TERM всем работающим процессам pgBackRest для корректного, но немедленного завершения. Это также останавливает процессы, запущенные на другой системе, если их удалённые процессы работают на текущей. Например, если резервное копирование запущено на сервере резервного копирования, команда stop --force на сервере базы данных остановит процесс резервного копирования на сервере резервного копирования.

default: n
example: --force

Общие параметры

Параметр разрешения запуска от root (--allow-root)

Разрешение запуска команды от пользователя root.

По умолчанию только команда restore может выполняться от пользователя root, поскольку она предназначена для тщательного управления принадлежностью файлов. Выполнение других команд от пользователя root может привести к созданию файлов (например, в репозитории), принадлежащих root, и, как следствие, недоступных для пользователя PostgreSQL, что вызовет сбой последующих команд.

Включите этот параметр, чтобы запустить команду от имени root. Однако гораздо лучше запускать pgBackRest от пользователя, владеющего репозиторием и кластером PostgreSQL.

default: n
example: --allow-root

Параметр файла конфигурации (--config)

Конфигурационный файл pgBackRest.

Используйте этот параметр для указания другого файла конфигурации, отличного от файла по умолчанию.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Параметр каталога включаемых конфигураций (--config-include-path)

Путь к дополнительным файлам конфигурации pgBackRest.

Файлы конфигурации с расширением .conf, находящиеся в указанном каталоге, объединяются с файлом конфигурации pgBackRest в единый файл конфигурации.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Параметр каталога конфигурации (--config-path)

Базовый путь файлов конфигурации pgBackRest.

Эта настройка переопределяет базовый каталог по умолчанию для параметров --config и --config-include-path, если они не заданы явно в командной строке.

Например, передача только --config-path=/conf/pgbackrest приводит к установке значения по умолчанию для --config в /conf/pgbackrest/pgbackrest.conf и значения по умолчанию для --config-include-path в /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Параметр каталога блокировок (--lock-path)

Путь для хранения файлов блокировок.

В каталоге блокировок pgBackRest создаёт файлы блокировок, предотвращающие одновременное выполнение конфликтующих операций.

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

Параметр нейтральной маски umask (--neutral-umask)

Использование нейтральной маски umask.

Устанавливает umask в 0000, чтобы объекты в репозитории создавались с подходящими правами. По умолчанию права каталогов — 0750, файлов — 0640.

Чтобы вместо этого использовать umask пользователя, выполняющего команду, укажите neutral-umask=n в файле конфигурации или --no-neutral-umask в командной строке.

default: y
example: --no-neutral-umask

Параметр приоритета процесса (--priority)

Установка приоритета процесса.

Определяет приоритет процесса (то есть значение nice) для планировщика ядра. Положительные значения понижают приоритет, отрицательные — повышают. В большинстве случаев процессы не имеют права повышать свой приоритет.

allowed: [-20, 19]
example: --priority=19

Параметр stanza (--stanza)

Определение stanza.

Stanza — конфигурация кластера баз данных PostgreSQL, которая определяет его расположение, способ резервного копирования, параметры архивирования и т. п. Большинство серверов баз данных содержат только один кластер PostgreSQL и, соответственно, одну stanza, тогда как на серверах резервного копирования есть stanza для каждого кластера, требующего резервного копирования.

Может возникнуть желание назвать stanza по имени первичного кластера, но лучше выбрать имя, описывающее базы данных в нём. Поскольку имя stanza используется для первичного сервера и всех реплик, уместнее выбрать имя, отражающее назначение кластера, например app или dw, а не локальное имя кластера, такое как main или prod.

example: --stanza=main

Параметры журналирования

Параметр уровня журналирования в консоль (--log-level-console)

Уровень журналирования в консоль.

Поддерживаются следующие уровни журналирования:

• off - Журналирование отключено (не рекомендуется)
• error - Только ошибки
• warn - Предупреждения и ошибки
• info - Информационные сообщения, предупреждения и ошибки
• detail - Подробные и информационные сообщения, предупреждения и ошибки
• debug - Отладочные, подробные и информационные сообщения, предупреждения и ошибки
• trace - Трассировка (очень подробная отладка), отладочные и информационные сообщения, предупреждения и ошибки

default: warn
example: --log-level-console=error

Параметр уровня журналирования в файл (--log-level-file)

Уровень журналирования в файл.

Поддерживаются следующие уровни журналирования:

• off - Журналирование отключено (не рекомендуется)
• error - Только ошибки
• warn - Предупреждения и ошибки
• info - Информационные сообщения, предупреждения и ошибки
• detail - Подробные и информационные сообщения, предупреждения и ошибки
• debug - Отладочные, подробные и информационные сообщения, предупреждения и ошибки
• trace - Трассировка (очень подробная отладка), отладочные и информационные сообщения, предупреждения и ошибки

default: info
example: --log-level-file=debug

Параметр уровня журналирования в стандартный поток ошибок (--log-level-stderr)

Уровень ведения журнала для stderr.

Задаёт уровни журнала, сообщения которых выводятся в stderr, а не в stdout (задаваемый параметром log-level-console). Временная метка и процесс в stderr не выводятся.

Поддерживаются следующие уровни журналирования:

• off - Журналирование отключено (не рекомендуется)
• error - Только ошибки
• warn - Предупреждения и ошибки
• info - Информационные сообщения, предупреждения и ошибки
• detail - Подробные и информационные сообщения, предупреждения и ошибки
• debug - Отладочные, подробные и информационные сообщения, предупреждения и ошибки
• trace - Трассировка (очень подробная отладка), отладочные и информационные сообщения, предупреждения и ошибки

default: off
example: --log-level-stderr=error

Параметр каталога журналов (--log-path)

Путь, по которому хранятся файлы журналов.

Путь к журналу задаёт местоположение для хранения файлов журналов pgBackRest. Примечание: если log-level-file=off, то путь к журналу не требуется.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Параметр временных меток журнала (--log-timestamp)

Включение временных меток в журнале.

Включает временные метки при выводе журнала в консоль и в файл. Этот параметр отключается в особых случаях, например при генерации документации.

default: y
example: --no-log-timestamp