PGBACKREST

Snapshot of the pgBackRest 2.59.2 documentation: https://pgbackrest.org/ Introduction pgBackRest provides backup and restore functions for PostgreSQL. It supports large databases and workloads. pgBackRest v2.59.2 is the current stable release. …

Source: pgBackRest Command Docs: version Display the 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 checks whether repository backups and archives are valid. Command Options Output Option (--output) Output type. The following output types are supported: none - No verify output. text - Output verify …

Source: pgBackRest Command Docs: stop Prevent new pgBackRest processes from running. By default, existing processes can finish. Use --force to terminate them. After stop completes, new pgBackRest processes return an error. See Starting and Stopping …

Source: pgBackRest Command Docs: start After stop prevents pgBackRest processes from running, use start to permit them again. This does not immediately start any processes. See Starting and Stopping for details and examples. General Options Allow …

Source: pgBackRest Command Docs: stanza-upgrade Immediately after a PostgreSQL major version upgrade, update pg-path in all pgBackRest configurations to the new database location. Then run stanza-upgrade. It upgrades the stanza in every repository …

Source: pgBackRest Command Docs: stanza-delete The stanza-delete command removes repository data for a stanza. WARNING: Use this command with care. It permanently removes every backup and archive for the specified stanza from the pgBackRest …

Source: pgBackRest Command Docs: stanza-create After configuring a stanza in pgbackrest.conf, run stanza-create. With multiple repositories, pgBackRest creates the stanza in each one. It skips existing stanzas, so you can safely repeat …

Source: pgBackRest Command Docs: server-ping Ping a pgBackRest TLS server to check whether it accepts connections. This checks availability only; it does not attempt authentication. If the command line does not specify a host, use tls-server-host. …

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. Set the IP address on which the server …

Source: pgBackRest Command Docs: restore By default, restore selects the latest backup from the first repository that has backups. See Quick Start - Restore a Backup. The repository order comes from pgbackrest.conf; for example, repo1 precedes …

Source: pgBackRest Command Docs: repo-ls This command works like Unix ls on any supported repository type. Supply an absolute path or a path relative to --repo-path. It mainly supports administration, investigation, and testing. A normal pgBackRest …

Source: pgBackRest Command Docs: repo-get This command works like Unix cat on any supported repository type. Supply a fully qualified file name. It mainly supports administration, investigation, and testing. A normal pgBackRest setup does not …

Source: pgBackRest project metrics, captured for the 2.59.2 documentation snapshot. 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. …

Source: pgBackRest Command Docs: info The info command reports on one stanza or all stanzas. By default, text output summarizes backups for the requested stanzas. The text format can change in any release. For machine-readable output, use …

Source: pgBackRest Command Docs: help Help has three levels. With no command, pgBackRest shows general help. With a command, such as pgbackrest help backup, it shows the command description and valid options. Add an option, such as pgbackrest help …

Introduction These answers cover specific questions that the User Guide and references might not cover. If your issue is absent, check the pgBackRest Issues List in GitHub. What if I get the “could not find WAL segment” error? This error has several …

Introduction pgBackRest release numbers have major and minor parts. A major release may break compatibility with the previous major release. However, v2 releases fully support v1 repositories and accept all v1 options. Minor releases can add …

Source: pgBackRest Command Docs: expire pgBackRest rotates full backups according to a count or time period. Count-based retention keeps a specified number of backups, regardless of their creation times. Differential retention uses a count, but a …

Introduction You can configure pgBackRest entirely with command-line parameters. For complex installations or many options, a configuration file is more practical. Its default location is /etc/pgbackrest/pgbackrest.conf. If that file is absent, …

Source: pgBackRest Command Docs: check The check command validates pgBackRest and archive_command configuration for the specified stanza. It checks backup and archive settings for all repositories and databases configured on the current host. It …

Source: https://pgbackrest.org/command.html Introduction Commands execute pgBackRest functions. Each command page lists every applicable option, including options shared with other commands. The lists also include options that you can set in …

Source: pgBackRest Command Docs: backup With multiple repositories, pgBackRest backs up to the highest priority repository, such as repo1. Use --repo to select another repository. pgBackRest has no built-in scheduler. Use cron or another scheduler …

Source: pgBackRest 2.59.2 user guide. Introduction Follow this guide in order the first time. Each section depends on earlier sections. For example, Restore requires the configuration from Quick Start. After pgBackRest is running, you can use …

Source: pgBackRest Command Docs: archive-push This command accepts a WAL segment from PostgreSQL. It archives the segment in each repository defined by an indexed repo-path option. See Repository for configuration details. The archive-async value …

Source: pgBackRest 2.59.2 user guide. Introduction Follow this guide in order the first time. Each section depends on earlier sections. For example, Restore requires the configuration from Quick Start. After pgBackRest is running, you can use …

Source: pgBackRest Command Docs: archive-get PostgreSQL uses this command to restore a backup or perform PITR. It can also use the command instead of streaming to keep a replica current. PostgreSQL needs WAL segments for recovery and replica …

Source: https://pgbackrest.org/news.html pgBackRest 2.59.2 Released September 27, 2026 The pgBackRest community released pgBackRest 2.59.2. This backup and restore solution supports PostgreSQL databases and workloads of all sizes. pgBackRest …

Source: pgBackRest Command Docs: annotate Use annotate to add, change, or remove annotations after the backup command creates a backup. Command Options Backup Annotation Option (--annotation) Annotate backup with user-defined key/value pairs. Attach …