Module: PGBACKREST

snapshot of pgBackRest 2.59 documentation: https://pgbackrest.org/ Introduction pgBackRest is a reliable backup and restore solution for PostgreSQL that seamlessly scales up to the largest databases and workloads. pgBackRest v2.59.0 is the current …

Source: pgBackRest Command Docs: version 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 …

Source: pgBackRest Command Docs: verify 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 …

Source: pgBackRest Command Docs: stop 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 …

Source: pgBackRest Command Docs: start 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 …

Source: pgBackRest Command Docs: stanza-upgrade 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 …

Source: pgBackRest Command Docs: stanza-delete 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 …

Source: pgBackRest Command Docs: stanza-create 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 …

Source: pgBackRest Command Docs: server-ping 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 …

Source: pgBackRest Command Docs: server 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 …

Source: pgBackRest Command Docs: restore 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 …

Source: pgBackRest Command Docs: repo-ls 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 …

Source: pgBackRest Command Docs: repo-get 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 …

Code Coverage pgBackRest aims to have complete function/branch/line coverage for the core C code in /src. Function/line coverage is complete with no exceptions. Branch coverage excludes branches inside macros and assert() calls. Macros have their …

Source: pgBackRest Command Docs: info 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 …

Source: pgBackRest Command Docs: help 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 …

Introduction Frequently Asked Questions are intended to provide details for specific questions that may or may not be covered in the User Guide, Configuration, or Command reference. If you are unable to find details for your specific issue here, …

Introduction pgBackRest release numbers consist of two parts, major and minor. A major release may break compatibility with the prior major release, but v2 releases are fully compatible with v1 repositories and will accept all v1 options. Minor …

Source: pgBackRest Command Docs: expire 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 …

Introduction pgBackRest can be used entirely with command-line parameters but a configuration file is more practical for installations that are complex or set a lot of options. The default location for the configuration file is …

Source: pgBackRest Command Docs: check 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 …

Source: https://pgbackrest.org/command.html Introduction Commands are used to execute the various pgBackRest functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even …

Source: pgBackRest Command Docs: backup 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 …

Introduction This user guide is intended to be followed sequentially from beginning to end — each section depends on the last. For example, the Restore section relies on setup that is performed in the Quick Start section. Once pgBackRest is up and …

Source: pgBackRest Command Docs: archive-push 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 …

Introduction This user guide is intended to be followed sequentially from beginning to end — each section depends on the last. For example, the Restore section relies on setup that is performed in the Quick Start section. Once pgBackRest is up and …

Source: pgBackRest Command Docs: archive-get 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 …

Source: https://pgbackrest.org/news.html New Distribution Tarball July 20, 2026 Starting with pgBackRest 2.59.0, every release includes a distribution tarball that makes building from source simpler. Unlike a checkout of the git repository, the …

Source: pgBackRest Command Docs: annotate 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 …