F.6. basebackup_to_shell — пример создания получателей резервной копии для модуля pg_basebackup #
В модуле basebackup_to_shell реализован дополнительный получатель базовых копий, названный shell. Он позволяет выполнить pg_basebackup --target=shell или, в зависимости от конфигурации этого модуля, pg_basebackup --target=shell: и вызвать серверную команду, выбранную администратором сервера для каждого tar-архива, созданного в процессе резервного копирования. Команда получит содержимое архива через стандартный ввод.ДОП_ИНФОРМАЦИЯ
Этот модуль разрабатывался в первую очередь как пример создания новых получателей резервной копии посредством модуля расширения, но в некоторых сценариях он может быть полезен сам по себе. Для использования модуля его нужно загрузить через shared_preload_libraries или local_preload_libraries.
F.6.1. Параметры конфигурации #
basebackup_to_shell.command(string)Команда, которую сервер должен выполнять для каждого архива, созданного в процессе резервного копирования. Если строка команды содержит символы
%f, они заменяются именем архива (например,base.tar). Символы%dв строке команды заменяются дополнительной информацией, указанной пользователем, — она должна задаваться обязательно, если строка команды содержит символы%d; в противном случае задать её нельзя. Из соображений безопасности описание может содержать только буквенные и цифровые символы. Символы%%в командной строке заменяются одним символом%. Если за символом%в командной строке следует любой другой символ или он стоит в конце строки, возникает ошибка.basebackup_to_shell.required_role(string)Роль, необходимая для использования получателя резервных копий
shell. Если роль не задана, этого получателя может использовать любой пользователь репликации.
F.6.2. Автор #
Роберт Хаас <rhaas@postgresql.org>
F.6. basebackup_to_shell — example "shell" pg_basebackup module #
basebackup_to_shell adds a custom basebackup target called shell. This makes it possible to run pg_basebackup --target=shell or, depending on how this module is configured, pg_basebackup --target=shell:, and cause a server command chosen by the server administrator to be executed for each tar archive generated by the backup process. The command will receive the contents of the archive via standard input. DETAIL_STRING
This module is primarily intended as an example of how to create a new backup targets via an extension module, but in some scenarios it may be useful for its own sake. In order to function, this module must be loaded via shared_preload_libraries or local_preload_libraries.
F.6.1. Configuration Parameters #
-
basebackup_to_shell.command(string) The command which the server should execute for each archive generated by the backup process. If
%foccurs in the command string, it will be replaced by the name of the archive (e.g.base.tar). If%doccurs in the command string, it will be replaced by the target detail provided by the user. A target detail is required if%dis used in the command string, and prohibited otherwise. For security reasons, it may contain only alphanumeric characters. If%%occurs in the command string, it will be replaced by a single%. If%occurs in the command string followed by any other character or at the end of the string, an error occurs.-
basebackup_to_shell.required_role(string) The role required in order to make use of the
shellbackup target. If this is not set, any replication user may make use of theshellbackup target.
F.6.2. Author #
Robert Haas <rhaas@postgresql.org>
