barman-get-wal1

Barman sub-commands

Overview

Retrieve a WAL file from the xlog archive of a specified server. By default, if the requested WAL file is found, it is returned as uncompressed content to STDOUT.

Parameters

SERVER_NAME: Name of the server in barman node

WAL_NAME: Id of the backup in barman catalog.

--bzip2 / -j: Output will be compressed using bzip2.

--gzip / -z / -x: Output will be compressed using gzip.

-h / --help: Show a help message and exit. Provides information about command usage.

--keep-compression: Do not uncompress the file content. The output will be the original compressed file.

--output-directory / -o: Destination directory where barman will store the WAL file.

--peek / -p: Specify an integer value greater than or equal to 1 to retrieve WAL files from the specified WAL file up to the value specified by this parameter. When using this option, get-wal returns a list of zero to the specified WAL segment names, with one name per row.

-P / --partial: Additionally, collect partial WAL files (.partial).

-t / --test: Test both the connection and configuration of the specified Postgres server in Barman for WAL retrieval. When this option is used, the required WAL_NAME argument is disregarded.

WARNING:

-z / --gzip and -j / --bzip2 options are deprecated and will be removed in the future. For WAL compression, please make sure to enable it directly on the Barman server via the compression configuration option.