PostgreSQL

F.5. basebackup_to_shell — example "shell" pg_basebackup module
Prev	Up	Appendix F. Additional Supplied Modules and Extensions	Home	Next

F.5. 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:`DETAIL_STRING`, 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.

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.5.1. Configuration Parameters #

[.term]#basebackup_to_shell.command (string): The command which the server should execute for each archive generated by the backup process. If %f occurs in the command string, it will be replaced by the name of the archive (e.g. base.tar). If %d occurs in the command string, it will be replaced by the target detail provided by the user. A target detail is required if %d is 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.
[.term]#basebackup_to_shell.required_role (string): The role required in order to make use of the shell backup target. If this is not set, any replication user may make use of the shell backup target.

F.5.2. Author #

Robert Haas <`[email protected]>`

Prev	Up	Next
F.4. auto_explain — log execution plans of slow queries	Home	F.6. basic_archive — an example WAL archive module

F.4. auto_explain — log execution plans of slow queries

Home

F.6. basic_archive — an example WAL archive module

Submit correction

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.