Category: Reference
-
Version Command (version)
Categories:less than a minute
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: 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 …
-
Verify Command (verify)
Categories:21 minute read
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: 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 …
-
Release notes
Categories:135 minute read
Source: https://patroni.readthedocs.io/en/latest/releases.html Version 4.1.5 Released 2026-08-12 Compatibility improvements Compatibility with PostgreSQL 14.24, 15.19, 16.15, 17.11, 18.6 (Alexander Kukushkin) Add the new output_plugin_libraries GUC, …
Source: https://patroni.readthedocs.io/en/latest/releases.html Version 4.1.5 Released 2026-08-12 Compatibility improvements Compatibility with PostgreSQL 14.24, 15.19, 16.15, 17.11, 18.6 (Alexander Kukushkin) Add the new output_plugin_libraries GUC, …
-
Stop Command (stop)
Categories:5 minute read
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: 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 …
-
FAQ
Categories:16 minute read
Source: https://patroni.readthedocs.io/en/latest/faq.html In this section you will find answers for the most frequently asked questions about Patroni. Each sub-section attempts to focus on different kinds of questions. We hope that this helps you to …
Source: https://patroni.readthedocs.io/en/latest/faq.html In this section you will find answers for the most frequently asked questions about Patroni. Each sub-section attempts to focus on different kinds of questions. We hope that this helps you to …
-
Start Command (start)
Categories:5 minute read
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: 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 …
-
Stanza Upgrade Command (stanza-upgrade)
Categories:23 minute read
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-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 …
-
Stanza Delete Command (stanza-delete)
Categories:24 minute read
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-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 …
-
Stanza Create Command (stanza-create)
Categories:24 minute read
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: 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 …
-
Server Ping Command (server-ping)
Categories:6 minute read
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-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 …
-
Server Command (server)
Categories:7 minute read
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: 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 …
-
Restore Command (restore)
Categories:28 minute read
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: 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 …
-
License and Credits
Categories:2 minute read
Source: upstream LICENSE, README.md, and resources/LICENSE at the pinned source commit. pgBadger is free and open-source software distributed under the PostgreSQL License. It may be used, copied, modified, and distributed without a fee, subject to …
Source: upstream LICENSE, README.md, and resources/LICENSE at the pinned source commit. pgBadger is free and open-source software distributed under the PostgreSQL License. It may be used, copied, modified, and distributed without a fee, subject to …
-
Repository List Command (repo-ls)
Categories:20 minute read
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-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 …
-
Repository Get Command (repo-get)
Categories:19 minute read
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 …
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 …
-
Frequently Asked Questions
Categories:4 minute read
Source: https://www.pgbouncer.org/faq.html How to connect to PgBouncer? PgBouncer acts as a Postgres server, so simply point your client to the PgBouncer port. How to load-balance queries between several servers? PgBouncer does not have an internal …
Source: https://www.pgbouncer.org/faq.html How to connect to PgBouncer? PgBouncer acts as a Postgres server, so simply point your client to the PgBouncer port. How to load-balance queries between several servers? PgBouncer does not have an internal …
-
Info Command (info)
Categories:23 minute read
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: 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 …
-
Output Formats
Categories:2 minute read
Source: pinned upstream README.md, sections “Binary Format” and “JSON Format”, plus the generated command reference. pgBadger selects output from the filename extension or from -x / --extension. Use -o / --outfile more than once to create multiple …
Source: pinned upstream README.md, sections “Binary Format” and “JSON Format”, plus the generated command reference. pgBadger selects output from the filename extension or from -x / --extension. Use -o / --outfile more than once to create multiple …
-
Help Command (help)
Categories:less than a minute
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 …
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 …
-
Frequently Asked Questions
Categories:5 minute read
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 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, …
-
Changelog
Categories:48 minute read
Source: https://www.pgbouncer.org/changelog.html PgBouncer 1.25.x 2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties” Security Fix CVE-2026-6664: An integer overflow in network packet parsing code in …
Source: https://www.pgbouncer.org/changelog.html PgBouncer 1.25.x 2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties” Security Fix CVE-2026-6664: An integer overflow in network packet parsing code in …
-
Release Notes
Categories:100 minute read
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 …
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 …
-
Expire Command (expire)
Categories:26 minute read
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 …
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 …
-
patronictl
Categories:39 minute read
Source: https://patroni.readthedocs.io/en/latest/patronictl.html Patroni has a command-line interface named patronictl, which is used basically to interact with Patroni’s REST API and with the DCS. It is intended to make it easier to perform …
Source: https://patroni.readthedocs.io/en/latest/patronictl.html Patroni has a command-line interface named patronictl, which is used basically to interact with Patroni’s REST API and with the DCS. It is intended to make it easier to perform …
-
Source Releases Download
Categories:3 minute read
Source: https://www.pgbouncer.org/downloads/ PgBouncer 1.25 File Date Size SHA256 pgbouncer-1.25.2.tar.gz 2026-05-08 865371 bytes sha256 pgbouncer-1.25.1.tar.gz 2025-12-03 864801 bytes sha256 pgbouncer-1.25.0.tar.gz 2025-11-09 863322 bytes sha256 …
Source: https://www.pgbouncer.org/downloads/ PgBouncer 1.25 File Date Size SHA256 pgbouncer-1.25.2.tar.gz 2026-05-08 865371 bytes sha256 pgbouncer-1.25.1.tar.gz 2025-12-03 864801 bytes sha256 pgbouncer-1.25.0.tar.gz 2025-11-09 863322 bytes sha256 …
-
Configuration Reference
Categories:48 minute read
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 …
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 …
-
Check Command (check)
Categories:25 minute read
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: 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 …
-
Patroni REST API
Categories:17 minute read
Source: https://patroni.readthedocs.io/en/latest/rest_api.html Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the patronictl tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by …
Source: https://patroni.readthedocs.io/en/latest/rest_api.html Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the patronictl tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by …
-
Command Reference
Categories:3 minute read
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: 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 …
-
Backup Command (backup)
Categories:37 minute read
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 …
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 …
-
Patroni configuration
Categories:10 minute read
Source: https://patroni.readthedocs.io/en/latest/patroni_configuration.html There are 3 types of Patroni configuration: Global dynamic configuration. These options are stored in the DCS (Distributed Configuration Store) and applied on all cluster …
Source: https://patroni.readthedocs.io/en/latest/patroni_configuration.html There are 3 types of Patroni configuration: Global dynamic configuration. These options are stored in the DCS (Distributed Configuration Store) and applied on all cluster …
-
Environment Configuration Settings
Categories:20 minute read
Source: https://patroni.readthedocs.io/en/latest/ENVIRONMENT.html It is possible to override some of the configuration parameters defined in the Patroni configuration file using the system environment variables. This document lists all environment …
Source: https://patroni.readthedocs.io/en/latest/ENVIRONMENT.html It is possible to override some of the configuration parameters defined in the Patroni configuration file using the system environment variables. This document lists all environment …
-
Command-Line Reference
Categories:13 minute read
This page preserves the command reference generated from the pinned upstream source. Option names and help text remain verbatim so they can be compared directly with pgbadger --help. Source: pgBadger README.md at commit a1ad95a. Usage and options …
This page preserves the command reference generated from the pinned upstream source. Option names and help text remain verbatim so they can be compared directly with pgbadger --help. Source: pgBadger README.md at commit a1ad95a. Usage and options …
-
Archive Push Command (archive-push)
Categories:25 minute read
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 …
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 …
-
Configuration: pgbouncer.ini
Categories:41 minute read
Source: https://www.pgbouncer.org/config.html Description The configuration file is in “ini” format. Section names are between [ and ]. Lines starting with ; or # are taken as comments and ignored. The characters ; and # are not recognized as …
Source: https://www.pgbouncer.org/config.html Description The configuration file is in “ini” format. Section names are between [ and ]. Lines starting with ; or # are taken as comments and ignored. The characters ; and # are not recognized as …
-
Archive Get Command (archive-get)
Categories:24 minute read
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: 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 …
-
YAML Configuration Settings
Categories:30 minute read
Source: https://patroni.readthedocs.io/en/latest/yaml_configuration.html Global/Universal thread_pool_size: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or …
Source: https://patroni.readthedocs.io/en/latest/yaml_configuration.html Global/Universal thread_pool_size: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or …
-
News
Categories:8 minute read
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: 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 …
-
Dynamic Configuration Settings
Categories:10 minute read
Source: https://patroni.readthedocs.io/en/latest/dynamic_configuration.html Dynamic configuration is stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes. In order to change the dynamic configuration you can use …
Source: https://patroni.readthedocs.io/en/latest/dynamic_configuration.html Dynamic configuration is stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes. In order to change the dynamic configuration you can use …
-
Annotate Command (annotate)
Categories:19 minute read
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 …
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 …