Command Reference on PIG.CENTER

Annotate Command (annotate)

Mon, 01 Jan 0001 00:00:00 +0000

Annotations included with the backup command can be added, modified, or removed afterwards using the annotate command.

Command Options

Backup Annotation Option (`--annotation`)

Annotate backup with user-defined key/value pairs.

Users can attach informative key/value pairs to the backup. This option may be used multiple times to attach multiple annotations.

Annotations are output by the info command text output when a backup is specified with --set and always appear in the JSON output.

Archive Get Command (archive-get)

Mon, 01 Jan 0001 00:00:00 +0000

This command is used by PostgreSQL to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for PostgreSQL recovery or to maintain a replica.

When multiple repositories are configured, WAL will be fetched from the repositories in priority order (e.g. repo1, repo2, etc.). In general it is better if faster/cheaper storage has higher priority. If a repository is specified with the --repo option then only that repository will be searched.

Archive Push Command (archive-push)

Mon, 01 Jan 0001 00:00:00 +0000

Accepts a WAL segment from PostgreSQL and archives it in each repository defined by the indexed repo-path option (see the Repository section for information on configuring repositories). The WAL segment may be pushed immediately to the archive or stored locally depending on the value of archive-async. With multiple repositories configured, archive-push will attempt to push to as many repositories as possible.

The archive-push is intended to be configured and called by PostgreSQL. See Configure Archiving for an example.

Backup Command (backup)

Mon, 01 Jan 0001 00:00:00 +0000

When multiple repositories are configured, pgBackRest will backup to the highest priority repository (e.g. repo1) unless the --repo option is specified.

pgBackRest does not have a built-in scheduler so it’s best to run it from cron or some other scheduling mechanism.

See Perform a Backup for more details and examples.

Command Options

Backup Annotation Option (`--annotation`)

Annotate backup with user-defined key/value pairs.

Check Command (check)

Mon, 01 Jan 0001 00:00:00 +0000

The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups for the specified stanza. It will attempt to check all repositories and databases that are configured for the host on which the command is run. It detects misconfigurations, particularly in archiving, that result in incomplete backups because required WAL segments did not reach the archive. The command can be run on the PostgreSQL or repository host. The command may also be run on the standby host, however, since pg_switch_xlog()/pg_switch_wal() cannot be performed on the standby, the command will only test the repository configuration.

Expire Command (expire)

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest does full backup rotation based on the retention type which can be a count or a time period. When a count is specified, then expiration is not concerned with when the backups were created but with how many must be retained. Differential backups are count-based but will always be expired when the full backup they depend on is expired. Incremental backups are not expired by retention independently — they are always expired with their related full or differential backup. See sections Full Backup Retention and Differential Backup Retention for details and examples.

Help Command (help)

Mon, 01 Jan 0001 00:00:00 +0000

Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command (e.g. pgbackrest help backup type) then a full description of the option as it applies to the command will be displayed.

Info Command (info)

Mon, 01 Jan 0001 00:00:00 +0000

The info command operates on a single stanza or all stanzas. Text output is the default and gives a human-readable summary of backups for the stanza(s) requested. This format is subject to change with any release.

For machine-readable output use --output=json. The JSON output contains far more information than the text output and is kept stable unless a bug is found.

To speed up execution, limit the output to only progress information by specifying --detail-level=progress. Note that this skips all checks except for availability of the stanza.

Repository Get Command (repo-get)

Mon, 01 Jan 0001 00:00:00 +0000

Similar to the unix cat command but works on any supported repository type. This command requires a fully qualified file name and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

If the repository is encrypted then repo-get will automatically decrypt the file. Files are not automatically decompressed but the output can be piped through the appropriate decompression command, e.g. gzip -d.

Repository List Command (repo-ls)

Mon, 01 Jan 0001 00:00:00 +0000

Similar to the unix ls command but works on any supported repository type. This command accepts a path, absolute or relative to the repository path defined by the --repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

The default text output prints one file name per line. JSON output is available by specifying --output=json.

If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the --repo option is specified.

Restore Command (restore)

Mon, 01 Jan 0001 00:00:00 +0000

The restore command automatically defaults to selecting the latest backup from the first repository where backups exist (see Quick Start - Restore a Backup ). The order in which the repositories are checked is dictated by the pgbackrest.conf (e.g. repo1 will be checked before repo2). To select from a specific repository, the --repo option can be passed (e.g. --repo=1). The --set option can be passed if a backup other than the latest is desired.

Server Command (server)

Mon, 01 Jan 0001 00:00:00 +0000

The pgBackRest server allows access to remote hosts without using the SSH protocol.

Command Options

TLS Server Address Option (`--tls-server-address`)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=*

TLS Server Authorized Clients Option (`--tls-server-auth`)

TLS server authorized clients.

Clients are authorized on the server by verifying their certificate and checking their certificate CN (Common Name) against a list on the server configured with the tls-server-auth option.

Server Ping Command (server-ping)

Mon, 01 Jan 0001 00:00:00 +0000

Ping a pgBackRest TLS server to ensure it is accepting connections. This serves as an aliveness check only since no authentication is attempted.

If no host is specified on the command-line then the tls-server-host option will be used.

Command Options

TLS Server Address Option (`--tls-server-address`)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=*

TLS Server Port Option (`--tls-server-port`)

TLS server port.

Stanza Create Command (stanza-create)

Mon, 01 Jan 0001 00:00:00 +0000

The stanza-create command must be run after the stanza has been configured in pgbackrest.conf. If there is more than one repository configured, the stanza will be created on each. Stanzas that have already been created will be skipped so it is always safe to run stanza-create, even when a new repository has been configured.

See Create the Stanza for more information and an example.

Command Options

Online Option (`--online`)

Create on an online cluster.

Stanza Delete Command (stanza-delete)

Mon, 01 Jan 0001 00:00:00 +0000

The stanza-delete command removes data in the repository associated with a stanza.

WARNING:

Use this command with caution — it will permanently remove all backups and archives from the pgBackRest repository for the specified stanza.

To delete a stanza:

Shut down the PostgreSQL cluster associated with the stanza (or use –force to override).
Run the stop command on the host where the stanza-delete command will be run.
Run the stanza-delete command.

Once the command successfully completes, it is the responsibility of the user to remove the stanza from all pgBackRest configuration files and/or environment variables.

Stanza Upgrade Command (stanza-upgrade)

Mon, 01 Jan 0001 00:00:00 +0000

Immediately after upgrading PostgreSQL to a newer major version, the pg-path for all pgBackRest configurations must be set to the new database location and the stanza-upgrade command run. If there is more than one repository configured on the host, the stanza will be upgraded on each. If the database is offline use the --no-online option.

Command Options

Online Option (`--online`)

Update an online cluster.

Start Command (start)

Mon, 01 Jan 0001 00:00:00 +0000

If the pgBackRest processes were previously stopped using the stop command then they can be started again using the start command. Note that this will not immediately start up any pgBackRest processes but they are allowed to run. See Starting and Stopping for more information and examples.

General Options

Allow Run as Root Option (`--allow-root`)

Allow the command to run as the root user.

Stop Command (stop)

Mon, 01 Jan 0001 00:00:00 +0000

Does not allow any new pgBackRest processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes.

pgBackRest processes will return an error if they are run after the stop command completes. See Starting and Stopping for more information and examples.

Command Options

Force Option (`--force`)

Force all pgBackRest processes to stop.

Verify Command (verify)

Mon, 01 Jan 0001 00:00:00 +0000

Verify determines if the backups and archives in a repository are valid.

Command Options

Output Option (`--output`)

Output type.

The following output types are supported:

none - No verify output.
text - Output verify information to stdout.

default: none
example: --output=text

Set Option (`--set`)

Backup set to verify.

Verify all database and archive files associated with the specified backup set.

Version Command (version)

Mon, 01 Jan 0001 00:00:00 +0000

Displays installed pgBackRest version.

Command Options

Output Option (`--output`)

Output type.

The following output types are supported:

text - Display the installed pgBackRest version as text.
num - Display the installed pgBackRest version as an integer.

default: text
example: --output=num

Command Reference on PIG.CENTER

Annotate Command (annotate)

Command Options

Backup Annotation Option (--annotation)

Archive Get Command (archive-get)

Archive Push Command (archive-push)

Backup Command (backup)

Command Options

Backup Annotation Option (--annotation)

Check Command (check)

Expire Command (expire)

Help Command (help)

Info Command (info)

Repository Get Command (repo-get)

Repository List Command (repo-ls)

Restore Command (restore)

Server Command (server)

Command Options

TLS Server Address Option (--tls-server-address)

TLS Server Authorized Clients Option (--tls-server-auth)

Server Ping Command (server-ping)

Command Options

TLS Server Address Option (--tls-server-address)

TLS Server Port Option (--tls-server-port)

Stanza Create Command (stanza-create)

Command Options

Online Option (--online)

Stanza Delete Command (stanza-delete)

Stanza Upgrade Command (stanza-upgrade)

Command Options

Online Option (--online)

Start Command (start)

General Options

Allow Run as Root Option (--allow-root)

Stop Command (stop)

Command Options

Force Option (--force)

Verify Command (verify)

Command Options

Output Option (--output)

Set Option (--set)

Version Command (version)

Command Options

Output Option (--output)

Backup Annotation Option (`--annotation`)

Backup Annotation Option (`--annotation`)

TLS Server Address Option (`--tls-server-address`)

TLS Server Authorized Clients Option (`--tls-server-auth`)

TLS Server Address Option (`--tls-server-address`)

TLS Server Port Option (`--tls-server-port`)

Online Option (`--online`)

Online Option (`--online`)

Allow Run as Root Option (`--allow-root`)

Force Option (`--force`)

Output Option (`--output`)

Set Option (`--set`)

Output Option (`--output`)