'],
'id' => ['', ''],
'host' => ['', ''],
'file' => ['', ''],
@@ -851,7 +850,7 @@ sub processTag
$strBuffer .= $self->processAdmonitionStart($oTag);
}
- if ($strTag eq 'p' || $strTag eq 'title' || $strTag eq 'li' || $strTag eq 'code-block' || $strTag eq 'summary'
+ if ($strTag eq 'p' || $strTag eq 'title' || $strTag eq 'list-item' || $strTag eq 'code-block' || $strTag eq 'summary'
|| $strTag eq 'admonition')
{
$strBuffer .= $self->processText($oTag);
@@ -997,7 +996,11 @@ sub processText
confess &log(ERROR, "unable to process quotes in string (use instead):\n${oNode}");
}
- $strBuffer .= $oNode;
+ # Skip text nodes with linefeeds since they happen between tags
+ if (index($oNode, "\n") == -1)
+ {
+ $strBuffer .= $oNode;
+ }
}
else
{
diff --git a/doc/lib/pgBackRestDoc/Custom/DocCustomRelease.pm b/doc/lib/pgBackRestDoc/Custom/DocCustomRelease.pm
index 7abda3e3b..3b56a4dd7 100644
--- a/doc/lib/pgBackRestDoc/Custom/DocCustomRelease.pm
+++ b/doc/lib/pgBackRestDoc/Custom/DocCustomRelease.pm
@@ -552,9 +552,9 @@ sub docGet
}
# Add release note if present
- if (!$bReleaseNote && $oRelease->nodeGet($strSectionType)->nodeTest('p'))
+ if (!$bReleaseNote && defined($oRelease->nodeGet($strSectionType)->textGet(false)))
{
- $oReleaseSection->nodeAdd('p')->textSet($oRelease->nodeGet($strSectionType)->nodeGet('p')->textGet());
+ $oReleaseSection->nodeAdd('p')->textSet($oRelease->nodeGet($strSectionType)->textGet());
$bReleaseNote = true;
}
diff --git a/doc/lib/pgBackRestDoc/Html/DocHtmlBuilder.pm b/doc/lib/pgBackRestDoc/Html/DocHtmlBuilder.pm
index de6f242d9..970fd0687 100644
--- a/doc/lib/pgBackRestDoc/Html/DocHtmlBuilder.pm
+++ b/doc/lib/pgBackRestDoc/Html/DocHtmlBuilder.pm
@@ -150,7 +150,6 @@ sub htmlRender
{
if (!defined($oElement->{bPre}) || !$oElement->{bPre})
{
- $oElement->{strContent} =~ s/\n/\\n/g;
$oElement->{strContent} = trim($oElement->{strContent});
# Add a linefeed before the content if not pre. This makes the output more diffable.
diff --git a/doc/xml/dtd/doc.dtd b/doc/xml/dtd/doc.dtd
index 629560b76..2d6df1edb 100644
--- a/doc/xml/dtd/doc.dtd
+++ b/doc/xml/dtd/doc.dtd
@@ -155,9 +155,9 @@
-
-
-
+
+
+
@@ -237,12 +237,9 @@
br-setting|pg-option|pg-setting|link|user|proper)*>
-
+
-
-
-
diff --git a/doc/xml/index.xml b/doc/xml/index.xml
index 29e4c7d7f..33ec9aaff 100644
--- a/doc/xml/index.xml
+++ b/doc/xml/index.xml
@@ -171,21 +171,21 @@
Support
-
is completely free and open source under the MIT license. You may use it for personal or commercial purposes without any restrictions whatsoever. Bug reports are taken very seriously and will be addressed as quickly as possible.
+
is completely free and open source under the MIT license. You may use it for personal or commercial purposes without any restrictions whatsoever. Bug reports are taken very seriously and will be addressed as quickly as possible.
- Creating a robust disaster recovery policy with proper replication and backup strategies can be a very complex and daunting task. You may find that you need help during the architecture phase and ongoing support to ensure that your enterprise continues running smoothly.
+
Creating a robust disaster recovery policy with proper replication and backup strategies can be a very complex and daunting task. You may find that you need help during the architecture phase and ongoing support to ensure that your enterprise continues running smoothly.
- Crunchy Data provides packaged versions of for major operating systems and expert full life-cycle commercial support for and all things . Crunchy Data is committed to providing open source solutions with no vendor lock-in, ensuring that cross-compatibility with the community version of is always strictly maintained.
+
Crunchy Data provides packaged versions of for major operating systems and expert full life-cycle commercial support for and all things . Crunchy Data is committed to providing open source solutions with no vendor lock-in, ensuring that cross-compatibility with the community version of is always strictly maintained.
- Please visit Crunchy Data for more information.
+
Please visit Crunchy Data for more information.
Recognition
-
Primary recognition goes to Stephen Frost for all his valuable advice and criticism during the development of .
+
Primary recognition goes to Stephen Frost for all his valuable advice and criticism during the development of .
- Crunchy Data has contributed significant time and resources to and continues to actively support development. Resonate also contributed to the development of and allowed early (but well tested) versions to be installed as their primary backup solution.
+
Crunchy Data has contributed significant time and resources to and continues to actively support development. Resonate also contributed to the development of and allowed early (but well tested) versions to be installed as their primary backup solution.
Armchair graphic by Sandor Szabo.
diff --git a/doc/xml/reference.xml b/doc/xml/reference.xml
index 7bcf02837..2e30e37ba 100644
--- a/doc/xml/reference.xml
+++ b/doc/xml/reference.xml
@@ -5,28 +5,37 @@
The {[project]} Configuration Reference details all configuration options.
- 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 /etc/pgbackrest/pgbackrest.conf. If no file exists in that location then the old default of /etc/pgbackrest.conf will be checked.
+
+
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 /etc/pgbackrest/pgbackrest.conf. If no file exists in that location then the old default of /etc/pgbackrest.conf will be checked.
+
- The log section defines logging-related settings.Trace-level logging may expose secrets such as keys and passwords. Use with caution!
+
+
The log section defines logging-related settings.
+
+ Trace-level logging may expose secrets such as keys and passwords. Use with caution!
+ Level for file logging.
- The following log levels are supported:
-
-
off - No logging at all (not recommended)
-
error - Log only errors
-
warn - Log warnings and errors
-
info - Log info, warnings, and errors
-
detail - Log detail, info, warnings, and errors
-
debug - Log debug, detail, info, warnings, and errors
+
+
+ off - No logging at all (not recommended)
+ error - Log only errors
+ warn - Log warnings and errors
+ info - Log info, warnings, and errors
+ detail - Log detail, info, warnings, and errors
+ debug - Log debug, detail, info, warnings, and errors
+ trace - Log trace (very verbose debugging), debug, info, warnings, and errors
+
+ error
@@ -53,18 +65,21 @@
Level for stderr logging.
- Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
+
+
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
- The following log levels are supported:
-
-
off - No logging at all (not recommended)
-
error - Log only errors
-
warn - Log warnings and errors
-
info - Log info, warnings, and errors
-
detail - Log detail, info, warnings, and errors
-
debug - Log debug, detail, info, warnings, and errors
+
+
+ off - No logging at all (not recommended)
+ error - Log only errors
+ warn - Log warnings and errors
+ info - Log info, warnings, and errors
+ detail - Log detail, info, warnings, and errors
+ debug - Log debug, detail, info, warnings, and errors
+ trace - Log trace (very verbose debugging), debug, info, warnings, and errors
+
+ error
@@ -73,7 +88,9 @@
Path where log files are stored.
- The log path provides a location for to store log files. Note that if log-level-file=off then no log path is required.
+
+
The log path provides a location for to store log files. Note that if log-level-file=off then no log path is required.
+ /backup/db/log
@@ -82,7 +99,9 @@
Enable timestamp in logging.
- Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.
+
+
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.
+ n
@@ -91,7 +110,9 @@
Enable logging in subprocesses.
- Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.
+
+
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.
+ y
@@ -100,17 +121,21 @@
- The general section defines options that are common for many commands.
+
+
The general section defines options that are common for many commands.
+ Buffer size for file operations.
- Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
+
+
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
- Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
+
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
- Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.
+
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.
+ 32K
@@ -119,7 +144,9 @@
Path to ssh client executable.
- Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.
+
+
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.
+ /usr/bin/ssh
@@ -128,9 +155,11 @@
Use file compression.
- Backup files are compatible with command-line compression tools.
+
+
Backup files are compatible with command-line compression tools.
- This option is now deprecated. The compress-type option should be used instead.
+
This option is now deprecated. The compress-type option should be used instead.
+ n
@@ -139,14 +168,17 @@
File compression type.
- The following compression types are supported:
-
-
none - no compression
-
bz2 - bzip2 compression format
-
gz - gzip compression format
-
lz4 - lz4 compression format (not available on all platforms)
-
zst - Zstandard compression format (not available on all platforms)
-
+
+
The following compression types are supported:
+
+
+ none - no compression
+ bz2 - bzip2 compression format
+ gz - gzip compression format
+ lz4 - lz4 compression format (not available on all platforms)
+ zst - Zstandard compression format (not available on all platforms)
+
+ none
@@ -155,15 +187,18 @@
File compression level.
- Sets the level to be used for file compression when compress-type does not equal none or compress=y (deprecated).
+
+
Sets the level to be used for file compression when compress-type does not equal none or compress=y (deprecated).
- The following are the defaults levels based on compress-type when compress-level is not specified:
-
-
bz2 - 9
-
gz - 6
-
lz4 - 1
-
zst - 3
-
+
The following are the defaults levels based on compress-type when compress-level is not specified:
+
+
+ bz2 - 9
+ gz - 6
+ lz4 - 1
+ zst - 3
+
+ 0-99
@@ -173,7 +208,9 @@
Network compression level.
- Sets the network compression level when compress-type=none and the command is not run on the same host as the repository. Compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress-type does not equal none the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.
+
+
Sets the network compression level when compress-type=none and the command is not run on the same host as the repository. Compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress-type does not equal none the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.
+ 0-91
@@ -183,7 +220,11 @@
Database query timeout.
- Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup). The db-timeout option must be less than the protocol-timeout option.
+
+
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
+
+ The db-timeout option must be less than the protocol-timeout option.
+ 600
@@ -192,9 +233,11 @@
Restore or backup using checksums.
- During a restore, by default the data and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums.
+
+
During a restore, by default the data and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums.
- During a backup, this option will use checksums instead of the timestamps to determine if files will be copied.
+
During a backup, this option will use checksums instead of the timestamps to determine if files will be copied.
+ y
@@ -203,9 +246,11 @@
I/O timeout.
- Timeout, in seconds, used for connections and read/write operations.
+
+
Timeout, in seconds, used for connections and read/write operations.
- Note that the entire read/write operation does not need to complete within this timeout but some progress must be made, even if it is only a single byte.
+
Note that the entire read/write operation does not need to complete within this timeout but some progress must be made, even if it is only a single byte.
+ 120
@@ -214,7 +259,9 @@
Retry count for local jobs.
- The number of retries for jobs run in the local process, e.g. file backup.
+
+
The number of retries for jobs run in the local process, e.g. file backup.
+ 5
@@ -223,7 +270,9 @@
Retry interval after first retry.
- The first retry is always performed immediately. This option specifies the interval to wait (in seconds) before performing each additional retry.
+
+
The first retry is always performed immediately. This option specifies the interval to wait (in seconds) before performing each additional retry.
+ 30
@@ -232,7 +281,9 @@
Path where lock files are stored.
- The lock path provides a location for to create lock files to prevent conflicting operations from being run concurrently.
+
+
The lock path provides a location for to create lock files to prevent conflicting operations from being run concurrently.
+ /backup/db/lock
@@ -241,9 +292,11 @@
Use a neutral umask.
- Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
+
+
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
- To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.
+
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.
+ n
@@ -252,15 +305,17 @@
Path where transient data is stored.
- This path is used to store data for the asynchronous archive-push and archive-get command.
+
+
This path is used to store data for the asynchronous archive-push and archive-get command.
- The asynchronous archive-push command writes acknowledgements into the spool path when it has successfully stored WAL in the archive (and errors on failure) so the foreground process can quickly notify . Acknowledgement files are very small (zero on success and a few hundred bytes on error).
+
The asynchronous archive-push command writes acknowledgements into the spool path when it has successfully stored WAL in the archive (and errors on failure) so the foreground process can quickly notify . Acknowledgement files are very small (zero on success and a few hundred bytes on error).
- The asynchronous archive-get command queues WAL in the spool path so it can be provided very quickly when requests it. Moving files to is most efficient when the spool path is on the same filesystem as pg_xlog/pg_wal.
+
The asynchronous archive-get command queues WAL in the spool path so it can be provided very quickly when requests it. Moving files to is most efficient when the spool path is on the same filesystem as pg_xlog/pg_wal.
- The data stored in the spool path is not strictly temporary since it can and should survive a reboot. However, loss of the data in the spool path is not a problem. will simply recheck each WAL segment to ensure it is safely archived for archive-push and rebuild the queue for archive-get.
+
The data stored in the spool path is not strictly temporary since it can and should survive a reboot. However, loss of the data in the spool path is not a problem. will simply recheck each WAL segment to ensure it is safely archived for archive-push and rebuild the queue for archive-get.
- The spool path is intended to be located on a local Posix-compatible filesystem, not a remote filesystem such as NFS or CIFS.
+
The spool path is intended to be located on a local Posix-compatible filesystem, not a remote filesystem such as NFS or CIFS.
+ /backup/db/spool
@@ -269,7 +324,9 @@
Max processes to use for compress/transfer.
- Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.
+
+
Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.
+ 4
@@ -278,7 +335,11 @@
Protocol timeout.
- Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message. The protocol-timeout option must be greater than the db-timeout option.
+
+
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
+
+ The protocol-timeout option must be greater than the db-timeout option.
+ 630
@@ -287,7 +348,9 @@
Socket blocking enable.
- Enable blocking on socket connections.
+
+
Enable blocking on socket connections.
+ y
@@ -296,7 +359,9 @@
Keep-alive enable.
- Enables keep-alive messages on socket connections.
+
+
Enables keep-alive messages on socket connections.
+ n
@@ -305,9 +370,11 @@
Keep-alive count.
- Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.
+
+
Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.
- This option is available on systems that support the TCP_KEEPCNT socket option.
+
This option is available on systems that support the TCP_KEEPCNT socket option.
+ 3
@@ -316,9 +383,11 @@
Keep-alive idle time.
- Specifies the amount of time (in seconds) with no network activity after which the operating system should send a TCP keep-alive message.
+
+
Specifies the amount of time (in seconds) with no network activity after which the operating system should send a TCP keep-alive message.
- This option is available on systems that support the TCP_KEEPIDLE socket option.
+
This option is available on systems that support the TCP_KEEPIDLE socket option.
+ 60
@@ -327,9 +396,11 @@
Keep-alive interval time.
- Specifies the amount of time (in seconds) after which a TCP keep-alive message that has not been acknowledged should be retransmitted.
+
+
Specifies the amount of time (in seconds) after which a TCP keep-alive message that has not been acknowledged should be retransmitted.
- This option is available on systems that support the TCP_KEEPINTVL socket option.
+
This option is available on systems that support the TCP_KEEPINTVL socket option.
+ 30
@@ -338,18 +409,22 @@
- The repository section defines options used to configure the repository.
+
+
The repository section defines options used to configure the repository.
- Indexing: All repo- options are indexed to allow for configuring multiple repositories. For example, a single repository is configured with the repo1-path, repo1-host, etc. options. If there is more than one repository configured and the {[dash]}-repo option is not specified for a command, the repositories will be acted upon in highest priority order (e.g. repo1 then repo2).
+
Indexing: All repo- options are indexed to allow for configuring multiple repositories. For example, a single repository is configured with the repo1-path, repo1-host, etc. options. If there is more than one repository configured and the {[dash]}-repo option is not specified for a command, the repositories will be acted upon in highest priority order (e.g. repo1 then repo2).
- The repo-retention-* options define how long backups will be retained. Expiration only occurs when the count of complete backups exceeds the allowed retention. In other words, if repo1-retention-full-type is set to count (default) and repo1-retention-full is set to 2, then there must be 3 complete backups before the oldest will be expired. If repo1-retention-full-type is set to time then repo1-retention-full represents days so there must be at least that many days worth of full backups before expiration can occur. Make sure you always have enough space for retention + 1 backups.
+
The repo-retention-* options define how long backups will be retained. Expiration only occurs when the count of complete backups exceeds the allowed retention. In other words, if repo1-retention-full-type is set to count (default) and repo1-retention-full is set to 2, then there must be 3 complete backups before the oldest will be expired. If repo1-retention-full-type is set to time then repo1-retention-full represents days so there must be at least that many days worth of full backups before expiration can occur. Make sure you always have enough space for retention + 1 backups.
+ Azure repository account.
- Azure account used to store the repository.
+
+
Azure account used to store the repository.
+ pg-backup
@@ -358,9 +433,11 @@
Azure repository container.
- Azure container used to store the repository.
+
+
Azure container used to store the repository.
- repositories can be stored in the container root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other Azure-generated content can also be stored in the container.
+
repositories can be stored in the container root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other Azure-generated content can also be stored in the container.
+ pg-backup
@@ -369,9 +446,11 @@
Azure repository endpoint.
- Endpoint used to connect to the blob service. The default is generally correct unless using Azure Government.
+
+
Endpoint used to connect to the blob service. The default is generally correct unless using Azure Government.
- For custom/test configurations the repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, and repo-storage-verify-tls options may be useful.
+
For custom/test configurations the repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, and repo-storage-verify-tls options may be useful.
+ blob.core.usgovcloudapi.net
@@ -380,7 +459,9 @@
Azure repository key.
- A shared key or shared access signature depending on the repo-azure-key-type option.
+
+
A shared key or shared access signature depending on the repo-azure-key-type option.
+ T+9+aov82qNhrcXSNGZCzm9mjd4d75/oxxOr6r1JVpgTLA==
@@ -389,11 +470,14 @@
Azure repository key type.
- The following types are supported for authorization:
-
-
shared - Shared key
-
sas - Shared access signature
-
+
+
The following types are supported for authorization:
+
+
+ shared - Shared key
+ sas - Shared access signature
+
+ sas
@@ -402,9 +486,11 @@
GCS repository bucket.
- GCS bucket used to store the repository.
+
+
GCS bucket used to store the repository.
- repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other GCS-generated content can also be stored in the bucket.
+
repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other GCS-generated content can also be stored in the bucket.
+ /pg-backup
@@ -413,7 +499,9 @@
GCS repository endpoint.
- Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.
+
+
Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.
+ localhost
@@ -422,7 +510,9 @@
GCS repository key.
- A token or service key file depending on the repo-gcs-key-type option.
+
+
A token or service key file depending on the repo-gcs-key-type option.
+ /etc/pgbackrest/gcs-key.json
@@ -431,12 +521,15 @@
GCS repository key type.
- The following types are supported for authorization:
-
-
auto - Authorize using the instance service account.
-
service - Service account from locally stored key.
-
token - For local testing, e.g. fakegcs.
-
+
+
The following types are supported for authorization:
+
+
+ auto - Authorize using the instance service account.
+ service - Service account from locally stored key.
+ token - For local testing, e.g. fakegcs.
+
+ none
@@ -445,9 +538,11 @@
Repository host when operating remotely via SSH.
- Make sure that trusted SSH authentication is configured between the host and the repository host.
+
+
Make sure that trusted SSH authentication is configured between the host and the repository host.
- When backing up and archiving to a locally mounted filesystem this setting is not required.
+
When backing up and archiving to a locally mounted filesystem this setting is not required.
+ repo1.domain.com
@@ -456,7 +551,9 @@
exe path on the repository host.
- Required only if the path to is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.
+
+
Required only if the path to is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.
+ same as local/usr/lib/backrest/bin/pgbackrest
@@ -466,7 +563,9 @@
repository host configuration file.
- Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.
+
+
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.
+ /conf/pgbackrest/pgbackrest.conf
@@ -475,7 +574,9 @@
repository host configuration include path.
- Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.
+
+
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.
+ /conf/pgbackrest/conf.d
@@ -484,7 +585,9 @@
repository host configuration path.
- Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.
+
+
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.
+ /conf/pgbackrest
@@ -493,7 +596,9 @@
Repository host user when repo-host is set.
- Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.
+
+
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.
+ repo-user
@@ -502,7 +607,9 @@
Repository host port when repo-host is set.
- Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported
+
+
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported.
+ 25
@@ -511,7 +618,9 @@
Hardlink files between backups in the repository.
- Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup at the file-system level. Be careful, though, because modifying files that are hard-linked can affect all the backups in the set.
+
+
Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup at the file-system level. Be careful, though, because modifying files that are hard-linked can affect all the backups in the set.
+ y
@@ -520,7 +629,9 @@
Repository is local.
- Indicates that the repository for the specified index is local and any repository host settings for that index (e.g. repo1-host) should be ignored.
+
+
Indicates that the repository for the specified index is local and any repository host settings for that index (e.g. repo1-host) should be ignored.
+ y
@@ -529,9 +640,11 @@
Path where backups and archive are stored.
- The repository is where stores backups and archives WAL segments.
+
+
The repository is where stores backups and archives WAL segments.
- It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.
+
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.
+ /backup/db/backrest
@@ -540,7 +653,9 @@
Full backup retention count/time.
- When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When the option is not defined a warning will be issued. If indefinite retention is desired then set the option to the max value.
+
+
When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When the option is not defined a warning will be issued. If indefinite retention is desired then set the option to the max value.
+ 2
@@ -549,7 +664,9 @@
Retention type for full backups.
- Determines whether the repo-retention-full setting represents a time period (days) or count of full backups to keep. If set to time then full backups older than repo-retention-full will be removed from the repository if there is at least one backup that is equal to or greater than the repo-retention-full setting. For example, if repo-retention-full is 30 (days) and there are 2 full backups: one 25 days old and one 35 days old, no full backups will be expired because expiring the 35 day old backup would leave only the 25 day old backup, which would violate the 30 day retention policy of having at least one backup 30 days old before an older one can be expired. Archived WAL older than the oldest full backup remaining will be automatically expired unless repo-retention-archive-type and repo-retention-archive are explicitly set.
+
+
Determines whether the repo-retention-full setting represents a time period (days) or count of full backups to keep. If set to time then full backups older than repo-retention-full will be removed from the repository if there is at least one backup that is equal to or greater than the repo-retention-full setting. For example, if repo-retention-full is 30 (days) and there are 2 full backups: one 25 days old and one 35 days old, no full backups will be expired because expiring the 35 day old backup would leave only the 25 day old backup, which would violate the 30 day retention policy of having at least one backup 30 days old before an older one can be expired. Archived WAL older than the oldest full backup remaining will be automatically expired unless repo-retention-archive-type and repo-retention-archive are explicitly set.
+ time
@@ -558,7 +675,9 @@
Number of differential backups to retain.
- When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept until the full backups they depend on expire.
+
+
When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept until the full backups they depend on expire.
+ 3
@@ -567,7 +686,9 @@
Backup type for WAL retention.
- If set to full will keep archive logs for the number of full backups defined by repo-retention-archive. If set to diff (differential) will keep archive logs for the number of full and differential backups defined by repo-retention-archive, meaning if the last backup taken was a full backup, it will be counted as a differential for the purpose of repo-retention. If set to incr (incremental) will keep archive logs for the number of full, differential, and incremental backups defined by repo-retention-archive. It is recommended that this setting not be changed from the default which will only expire WAL in conjunction with expiring full backups.
+
+
If set to full will keep archive logs for the number of full backups defined by repo-retention-archive. If set to diff (differential) will keep archive logs for the number of full and differential backups defined by repo-retention-archive, meaning if the last backup taken was a full backup, it will be counted as a differential for the purpose of repo-retention. If set to incr (incremental) will keep archive logs for the number of full, differential, and incremental backups defined by repo-retention-archive. It is recommended that this setting not be changed from the default which will only expire WAL in conjunction with expiring full backups.
+ diff
@@ -576,9 +697,13 @@
Number of backups worth of continuous WAL to retain.
- WAL segments required to make a backup consistent are always retained until the backup is expired regardless of how this option is configured.If this value is not set and repo-retention-full-type is count (default), then the archive to expire will default to the repo-retention-full (or repo-retention-diff) value corresponding to the repo-retention-archive-type if set to full (or diff). This will ensure that WAL is only expired for backups that are already expired. If repo-retention-full-type is time, then this value will default to removing archives that are earlier than the oldest full backup retained after satisfying the repo-retention-full setting.
+
+ WAL segments required to make a backup consistent are always retained until the backup is expired regardless of how this option is configured.
- This option must be set if repo-retention-archive-type is set to incr. If disk space is at a premium, then this setting, in conjunction with repo-retention-archive-type, can be used to aggressively expire WAL segments. However, doing so negates the ability to perform PITR from the backups with expired WAL and is therefore not recommended.
+
If this value is not set and repo-retention-full-type is count (default), then the archive to expire will default to the repo-retention-full (or repo-retention-diff) value corresponding to the repo-retention-archive-type if set to full (or diff). This will ensure that WAL is only expired for backups that are already expired. If repo-retention-full-type is time, then this value will default to removing archives that are earlier than the oldest full backup retained after satisfying the repo-retention-full setting.
+
+
This option must be set if repo-retention-archive-type is set to incr. If disk space is at a premium, then this setting, in conjunction with repo-retention-archive-type, can be used to aggressively expire WAL segments. However, doing so negates the ability to perform PITR from the backups with expired WAL and is therefore not recommended.
+ 2
@@ -587,11 +712,13 @@
Days of backup history manifests to retain.
- A copy of the backup manifest is stored in the backup.history path when a backup completes. By default these files are never expired since they are useful for data mining, e.g. measuring backup and WAL growth over time.
+
+
A copy of the backup manifest is stored in the backup.history path when a backup completes. By default these files are never expired since they are useful for data mining, e.g. measuring backup and WAL growth over time.
- Set repo-retention-history to define the number of days of backup history manifests to retain. Unexpired backups are always kept in the backup history. Specify repo-retention-history=0 to retain the backup history only for unexpired backups.
+
Set repo-retention-history to define the number of days of backup history manifests to retain. Unexpired backups are always kept in the backup history. Specify repo-retention-history=0 to retain the backup history only for unexpired backups.
- When a full backup history manifest is expired, all differential and incremental backup history manifests associated with the full backup also expire.
+
When a full backup history manifest is expired, all differential and incremental backup history manifests associated with the full backup also expire.
+ 365
@@ -600,7 +727,9 @@
S3 repository access key.
- AWS key used to access this bucket.
+
+
AWS key used to access this bucket.
+ AKIAIOSFODNN7EXAMPLE
@@ -609,7 +738,9 @@
S3 repository secret access key.
- AWS secret key used to access this bucket.
+
+
AWS secret key used to access this bucket.
+ wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
@@ -618,11 +749,14 @@
S3 repository key type.
- The following types are supported:
-
-
shared - Shared keys
-
auto - Automatically retrieve temporary credentials
-
+
+
The following types are supported:
+
+
+ shared - Shared keys
+ auto - Automatically retrieve temporary credentials
+
+ auto
@@ -631,7 +765,9 @@
S3 repository security token.
- AWS security token used with temporary credentials.
+
+
AWS security token used with temporary credentials.
+ AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22 ...
@@ -640,9 +776,11 @@
S3 repository bucket.
- S3 bucket used to store the repository.
+
+
S3 bucket used to store the repository.
- repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.
+
repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.
+ pg-backup
@@ -651,9 +789,11 @@
S3 repository endpoint.
- The AWS endpoint should be valid for the selected region.
+
+
The AWS endpoint should be valid for the selected region.
- For custom/test configurations the repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, and repo-storage-verify-tls options may be useful.
+
For custom/test configurations the repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, and repo-storage-verify-tls options may be useful.
+ s3.amazonaws.com
@@ -662,7 +802,9 @@
S3 repository role.
- The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.
+
+
The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.
+ authrole
@@ -671,7 +813,9 @@
S3 repository region.
- The AWS region where the bucket was created.
+
+
The AWS region where the bucket was created.
+ us-east-1
@@ -680,11 +824,14 @@
S3 URI Style.
- The following URI styles are supported:
-
-
host - Connect to bucket.endpoint host.
-
path - Connect to endpoint host and prepend bucket to URIs.
-
+
+
The following URI styles are supported:
+
+
+ host - Connect to bucket.endpoint host.
+ path - Connect to endpoint host and prepend bucket to URIs.
+
+ path
@@ -693,7 +840,9 @@
Repository storage CA file.
- Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.
+
+
Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.
+ /etc/pki/tls/certs/ca-bundle.crt
@@ -702,7 +851,9 @@
Repository storage CA path.
- Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.
+
+
Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.
+ /etc/pki/tls/certs
@@ -711,7 +862,9 @@
Repository storage host.
- Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.
+
+
Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.
+ 127.0.0.1
@@ -720,7 +873,9 @@
Repository storage port.
- Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).
+
+
Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).
+ 9000
@@ -729,7 +884,9 @@
Repository storage certificate verify.
- This option provides the ability to enable/disable verification of the storage (e.g. S3, Azure) server TLS certificate. Disabling should only be used for testing or other scenarios where a certificate has been self-signed.
+
+
This option provides the ability to enable/disable verification of the storage (e.g. S3, Azure) server TLS certificate. Disabling should only be used for testing or other scenarios where a certificate has been self-signed.
+ n
@@ -738,14 +895,19 @@
Type of storage used for the repository.
- The following repository types are supported:
-
-
azure - Azure Blob Storage Service
-
cifs - Like posix, but disables links and directory fsyncs
-
gcs - Google Cloud Storage
-
posix - Posix-compliant file systems
-
s3 - AWS Simple Storage Service
-
When an NFS mount is used as a posix repository, the same rules apply to as described in the documentation: Creating a Database Cluster - File Systems.
+
+
The following repository types are supported:
+
+
+ azure - Azure Blob Storage Service
+ cifs - Like posix, but disables links and directory fsyncs
+ gcs - Google Cloud Storage
+ posix - Posix-compliant file systems
+ s3 - AWS Simple Storage Service
+
+
+
When an NFS mount is used as a posix repository, the same rules apply to as described in the documentation: Creating a Database Cluster - File Systems.
+ cifs
@@ -754,11 +916,16 @@
Cipher used to encrypt the repository.
- The following cipher types are supported:
-
-
none - The repository is not encrypted
-
aes-256-cbc - Advanced Encryption Standard with 256 bit key length
-
Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.
+
+
The following cipher types are supported:
+
+
+ none - The repository is not encrypted
+ aes-256-cbc - Advanced Encryption Standard with 256 bit key length
+
+
+
Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.
+ noneaes-256-cbc
@@ -768,7 +935,9 @@
Repository cipher passphrase.
- Passphrase used to encrypt/decrypt files of the repository.
+
+
Passphrase used to encrypt/decrypt files of the repository.
+ zWaf6XtpjIVZC5444yXB+cgFDFl7MxGlgkZSaoPvTGirhPygu4jOKOXf9LO4vjfO
@@ -777,16 +946,20 @@
- The backup section defines settings related to backup.
+
+
The backup section defines settings related to backup.
+ Check that WAL segments are in the archive before backup completes.
- Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.
+
+
Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.
- This option must be enabled if archive-copy is enabled.
+
This option must be enabled if archive-copy is enabled.
+ n
@@ -795,13 +968,15 @@
Copy WAL segments needed for consistency to the backup.
- This slightly paranoid option protects against corruption in the WAL segment archive by storing the WAL segments required for consistency directly in the backup. WAL segments are still stored in the archive so this option will use additional space.
+
+
This slightly paranoid option protects against corruption in the WAL segment archive by storing the WAL segments required for consistency directly in the backup. WAL segments are still stored in the archive so this option will use additional space.
- It is best if the archive-push and backup commands have the same compress-type (e.g. lz4) when using this option. Otherwise, the WAL segments will need to be recompressed with the compress-type used by the backup, which can be fairly expensive depending on how much WAL was generated during the backup.
+
It is best if the archive-push and backup commands have the same compress-type (e.g. lz4) when using this option. Otherwise, the WAL segments will need to be recompressed with the compress-type used by the backup, which can be fairly expensive depending on how much WAL was generated during the backup.
- On restore, the WAL segments will be present in pg_xlog/pg_wal and will use them in preference to calling the restore_command.
+
On restore, the WAL segments will be present in pg_xlog/pg_wal and will use them in preference to calling the restore_command.
- The archive-check option must be enabled if archive-copy is enabled.
+
The archive-check option must be enabled if archive-copy is enabled.
+ y
@@ -810,9 +985,11 @@
Check PostgreSQL version/id in WAL headers.
- Enabled by default, this option checks the WAL header against the version and system identifier to ensure that the WAL is being copied to the correct stanza. This is in addition to checking pg_control against the stanza and verifying that WAL is being copied from the same data directory where pg_control is located.
+
+
Enabled by default, this option checks the WAL header against the version and system identifier to ensure that the WAL is being copied to the correct stanza. This is in addition to checking pg_control against the stanza and verifying that WAL is being copied from the same data directory where pg_control is located.
- Therefore, disabling this check is fairly safe but should only be done when needed, e.g. if the WAL is encrypted.
+
Therefore, disabling this check is fairly safe but should only be done when needed, e.g. if the WAL is encrypted.
+ n
@@ -821,11 +998,13 @@
Check the archive_mode setting.
- Enabled by default, this option disallows archive_mode=always.
+
+
Enabled by default, this option disallows archive_mode=always.
- WAL segments pushed from a standby server might be logically the same as WAL segments pushed from the primary but have different checksums. Disabling archiving from multiple sources is recommended to avoid conflicts.
+
WAL segments pushed from a standby server might be logically the same as WAL segments pushed from the primary but have different checksums. Disabling archiving from multiple sources is recommended to avoid conflicts.
- If this option is disabled then it is critical to ensure that only one archiver is writing to the repository via the archive-push command.
+ If this option is disabled then it is critical to ensure that only one archiver is writing to the repository via the archive-push command.
+ n
@@ -834,7 +1013,9 @@
Backup from the standby cluster.
- Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.
+
+
Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.
+ y
@@ -843,9 +1024,11 @@
Validate data page checksums.
- Directs to validate all data page checksums while backing up a cluster. This option is automatically enabled when data page checksums are enabled on the cluster.
+
+
Directs to validate all data page checksums while backing up a cluster. This option is automatically enabled when data page checksums are enabled on the cluster.
- Failures in checksum validation will not abort a backup. Rather, warnings will be emitted in the log (and to the console with default settings) and the list of invalid pages will be stored in the backup manifest.
+
Failures in checksum validation will not abort a backup. Rather, warnings will be emitted in the log (and to the console with default settings) and the list of invalid pages will be stored in the backup manifest.
+ n
@@ -854,13 +1037,19 @@
Exclude paths/files from the backup.
- All exclusions are relative to $PGDATA. If the exclusion ends with / then only files in the specified directory will be excluded, e.g. --exclude=junk/ will exclude all files in the $PGDATA/junk directory but include the directory itself. If the exclusion does not end with / then the file may match the exclusion exactly or match with / appended to the exclusion, e.g. --exclude=junk will exclude the $PGDATA/junk directory and all the files it contains.
+
+
All exclusions are relative to $PGDATA. If the exclusion ends with / then only files in the specified directory will be excluded, e.g. --exclude=junk/ will exclude all files in the $PGDATA/junk directory but include the directory itself. If the exclusion does not end with / then the file may match the exclusion exactly or match with / appended to the exclusion, e.g. --exclude=junk will exclude the $PGDATA/junk directory and all the files it contains.
- Be careful using this feature -- it is very easy to exclude something critical that will make the backup inconsistent. Be sure to test your restores!
+
Be careful using this feature -- it is very easy to exclude something critical that will make the backup inconsistent. Be sure to test your restores!
- All excluded files will be logged at info level along with the exclusion rule. Be sure to audit the list of excluded files to ensure nothing unexpected is being excluded.Exclusions are not honored on delta restores. Any files/directories that were excluded by the backup will be removed on delta restore.This option should not be used to exclude logs from a backup. Logs can be moved out of the PGDATA directory using the log_directory setting, which has the benefit of allowing logs to be preserved after a restore.
+
All excluded files will be logged at info level along with the exclusion rule. Be sure to audit the list of excluded files to ensure nothing unexpected is being excluded.
- Multiple exclusions may be specified on the command-line or in a configuration file.
+ Exclusions are not honored on delta restores. Any files/directories that were excluded by the backup will be removed on delta restore.
+
+
This option should not be used to exclude logs from a backup. Logs can be moved out of the PGDATA directory using the log_directory setting, which has the benefit of allowing logs to be preserved after a restore.
+
+
Multiple exclusions may be specified on the command-line or in a configuration file.
+ junk/
@@ -869,9 +1058,11 @@
Manifest save threshold during backup.
- Defines how often the manifest will be saved during a backup. Saving the manifest is important because it stores the checksums and allows the resume function to work efficiently. The actual threshold used is 1% of the backup size or manifest-save-threshold, whichever is greater.
+
+
Defines how often the manifest will be saved during a backup. Saving the manifest is important because it stores the checksums and allows the resume function to work efficiently. The actual threshold used is 1% of the backup size or manifest-save-threshold, whichever is greater.
- Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+ 5G
@@ -880,7 +1071,9 @@
Automatically run the expire command after a successful backup.
- The setting is enabled by default. Use caution when disabling this option as doing so will result in retaining all backups and archives indefinitely, which could cause your repository to run out of space. The expire command will need to be run regularly to prevent this from happening.
+
+
The setting is enabled by default. Use caution when disabling this option as doing so will result in retaining all backups and archives indefinitely, which could cause your repository to run out of space. The expire command will need to be run regularly to prevent this from happening.
+ y
@@ -889,7 +1082,9 @@
Allow resume of failed backup.
- Defines whether the resume feature is enabled. Resume can greatly reduce the amount of time required to run a backup after a previous backup of the same type has failed. It adds complexity, however, so it may be desirable to disable in environments that do not require the feature.
+
+
Defines whether the resume feature is enabled. Resume can greatly reduce the amount of time required to run a backup after a previous backup of the same type has failed. It adds complexity, however, so it may be desirable to disable in environments that do not require the feature.
+ n
@@ -898,9 +1093,11 @@
Force a checkpoint to start backup quickly.
- Forces a checkpoint (by passing y to the fast parameter of pg_start_backup()) so the backup begins immediately. Otherwise the backup will start after the next regular checkpoint.
+
+
Forces a checkpoint (by passing y to the fast parameter of pg_start_backup()) so the backup begins immediately. Otherwise the backup will start after the next regular checkpoint.
- This feature only works in >= 8.4.
+
This feature only works in >= 8.4.
+ y
@@ -909,13 +1106,15 @@
Stop prior failed backup on new backup.
- This will only be done if an exclusive advisory lock can be acquired to demonstrate that the prior failed backup process has really stopped.
+
+
This will only be done if an exclusive advisory lock can be acquired to demonstrate that the prior failed backup process has really stopped.
- This feature relies on pg_is_in_backup() so only works on >= 9.3.
+
This feature relies on pg_is_in_backup() so only works on >= 9.3.
- This feature is not supported for >= 9.6 since backups are run in non-exclusive mode.
+
This feature is not supported for >= 9.6 since backups are run in non-exclusive mode.
- The setting is disabled by default because it assumes that is the only process doing exclusive online backups. It depends on an advisory lock that only sets so it may abort other processes that do exclusive online backups. Note that base_backup and pg_dump are safe to use with this setting because they do not call pg_start_backup() so are not exclusive.
+
The setting is disabled by default because it assumes that is the only process doing exclusive online backups. It depends on an advisory lock that only sets so it may abort other processes that do exclusive online backups. Note that base_backup and pg_dump are safe to use with this setting because they do not call pg_start_backup() so are not exclusive.
+ y
@@ -924,16 +1123,20 @@
- The archive section defines options for the archive-push and archive-get commands.
+
+
The archive section defines options for the archive-push and archive-get commands.
+ Push/get WAL segments asynchronously.
- Enables asynchronous operation for the archive-push and archive-get commands.
+
+
Enables asynchronous operation for the archive-push and archive-get commands.
- Asynchronous operation is more efficient because it can reuse connections and take advantage of parallelism. See the spool-path, archive-get-queue-max, and archive-push-queue-max options for more information.
+
Asynchronous operation is more efficient because it can reuse connections and take advantage of parallelism. See the spool-path, archive-get-queue-max, and archive-push-queue-max options for more information.
+ y
@@ -942,9 +1145,11 @@
Maximum size of the archive-get queue.
- Specifies the maximum size of the archive-get queue when archive-async is enabled. The queue is stored in the spool-path and is used to speed providing WAL to .
+
+
Specifies the maximum size of the archive-get queue when archive-async is enabled. The queue is stored in the spool-path and is used to speed providing WAL to .
- Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+ 1073741824
@@ -953,18 +1158,22 @@
Maximum size of the archive queue.
- After the limit is reached, the following will happen:
-
-
will notify that the WAL was successfully archived, then DROP IT.
-
A warning will be output to the Postgres log.
+
+
After the limit is reached, the following will happen:
- If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability.
+
+ will notify that the WAL was successfully archived, then DROP IT.
+ A warning will be output to the Postgres log.
+
- In asynchronous mode the entire queue will be dropped to prevent spurts of WAL getting through before the queue limit is exceeded again.
+
If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability.
- The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have go down.
+
In asynchronous mode the entire queue will be dropped to prevent spurts of WAL getting through before the queue limit is exceeded again.
- Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+
The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have go down.
+
+
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.
+
1GB
@@ -973,7 +1182,9 @@
Archive timeout.
- Set maximum time, in seconds, to wait for each WAL segment to reach the archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.
+
+
Set maximum time, in seconds, to wait for each WAL segment to reach the archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.
+ 30
@@ -982,20 +1193,27 @@
- The restore section defines settings used for restoring backups.
+
+
The restore section defines settings used for restoring backups.
+ Preserve or disable archiving on restored cluster.
- This option allows archiving to be preserved or disabled on a restored cluster. This is useful when the cluster must be promoted to do some work but is not intended to become the new primary. In this case it is not a good idea to push WAL from the cluster into the repository.
+
+
This option allows archiving to be preserved or disabled on a restored cluster. This is useful when the cluster must be promoted to do some work but is not intended to become the new primary. In this case it is not a good idea to push WAL from the cluster into the repository.
- The following modes are supported:
-
-
off - disable archiving by setting archive_mode=off.
-
preserve - preserve current archive_mode setting.
-
NOTE: This option is not available on < 12.
+
The following modes are supported:
+
+
+ off - disable archiving by setting archive_mode=off.
+ preserve - preserve current archive_mode setting.
+
+
+
NOTE: This option is not available on < 12.
+ off
@@ -1004,9 +1222,11 @@
Restore excluding the specified databases.
- Databases excluded will be restored as sparse, zeroed files to save space but still allow to perform recovery. After recovery, those databases will not be accessible but can be removed with the drop database command. The {[dash]}-db-exclude option can be passed multiple times to specify more than one database to exclude.
+
+
Databases excluded will be restored as sparse, zeroed files to save space but still allow to perform recovery. After recovery, those databases will not be accessible but can be removed with the drop database command. The {[dash]}-db-exclude option can be passed multiple times to specify more than one database to exclude.
- When used in combination with the {[dash]}-db-include option, {[dash]}-db-exclude will only apply to standard system databases (template0, template1, and postgres).
+
When used in combination with the {[dash]}-db-include option, {[dash]}-db-exclude will only apply to standard system databases (template0, template1, and postgres).
+ db_main
@@ -1015,9 +1235,15 @@
Restore only specified databases.
- This feature allows only selected databases to be restored. Databases not specifically included will be restored as sparse, zeroed files to save space but still allow to perform recovery. After recovery, the databases that were not included will not be accessible but can be removed with the drop database command. built-in databases (template0, template1, and postgres) are always restored unless specifically excluded.The {[dash]}-db-include option can be passed multiple times to specify more than one database to include.
+
+
This feature allows only selected databases to be restored. Databases not specifically included will be restored as sparse, zeroed files to save space but still allow to perform recovery. After recovery, the databases that were not included will not be accessible but can be removed with the drop database command.
- See Restore Selected Databases for additional information and caveats.
+ built-in databases (template0, template1, and postgres) are always restored unless specifically excluded.
+
+
The {[dash]}-db-include option can be passed multiple times to specify more than one database to include.
+
+
See Restore Selected Databases for additional information and caveats.
+ db_main
@@ -1026,7 +1252,9 @@
Restore all symlinks.
- By default symlinked directories and files are restored as normal directories and files in $PGDATA. This is because it may not be safe to restore symlinks to their original destinations on a system other than where the original backup was performed. This option restores all the symlinks just as they were on the original system where the backup was performed.
+
+
By default symlinked directories and files are restored as normal directories and files in $PGDATA. This is because it may not be safe to restore symlinks to their original destinations on a system other than where the original backup was performed. This option restores all the symlinks just as they were on the original system where the backup was performed.
+ y
@@ -1035,7 +1263,9 @@
Modify the destination of a symlink.
- Allows the destination file or path of a symlink to be changed on restore. This is useful for restoring to systems that have a different storage layout than the original system where the backup was generated.
+
+
Allows the destination file or path of a symlink to be changed on restore. This is useful for restoring to systems that have a different storage layout than the original system where the backup was generated.
+ pg_xlog=/data/xlog
@@ -1044,7 +1274,13 @@
Set an option in recovery.conf.
- See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on recovery.conf options (replace X.X with your version). This option can be used multiple times.The restore_command option will be automatically generated but can be overridden with this option. Be careful about specifying your own restore_command as is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by and should not be set with this option.Since does not start after writing the recovery.conf file, it is always possible to edit/check recovery.conf before manually restarting.
+
+
See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on recovery.conf options (replace X.X with your version). This option can be used multiple times.
+
+ The restore_command option will be automatically generated but can be overridden with this option. Be careful about specifying your own restore_command as is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by and should not be set with this option.
+
+
Since does not start after writing the recovery.conf file, it is always possible to edit/check recovery.conf before manually restarting.
+ primary_conninfo=db.mydomain.com
@@ -1053,9 +1289,11 @@
Restore a tablespace into the specified directory.
- Moves a tablespace to a new location during the restore. This is useful when tablespace locations are not the same on a replica, or an upgraded system has different mount points.
+
+
Moves a tablespace to a new location during the restore. This is useful when tablespace locations are not the same on a replica, or an upgraded system has different mount points.
- Since 9.2 tablespace locations are not stored in pg_tablespace so moving tablespaces can be done with impunity. However, moving a tablespace to the data_directory is not recommended and may cause problems. For more information on moving tablespaces http://www.databasesoup.com/2013/11/moving-tablespaces.html is a good resource.
+
Since 9.2 tablespace locations are not stored in pg_tablespace so moving tablespaces can be done with impunity. However, moving a tablespace to the data_directory is not recommended and may cause problems. For more information on moving tablespaces http://www.databasesoup.com/2013/11/moving-tablespaces.html is a good resource.
+ ts_01=/db/ts_01
@@ -1064,9 +1302,11 @@
Restore all tablespaces into the specified directory.
- By default tablespaces are restored into their original locations and while this behavior can be modified by with the tablespace-map open it is sometime preferable to remap all tablespaces to a new directory all at once. This is particularly useful for development or staging systems that may not have the same storage layout as the original system where the backup was generated.
+
+
By default tablespaces are restored into their original locations and while this behavior can be modified by with the tablespace-map open it is sometime preferable to remap all tablespaces to a new directory all at once. This is particularly useful for development or staging systems that may not have the same storage layout as the original system where the backup was generated.
- The path specified will be the parent path used to create all the tablespaces in the backup.
+
The path specified will be the parent path used to create all the tablespaces in the backup.
+ /data/tablespace
@@ -1075,16 +1315,20 @@
- A stanza defines the backup configuration for a specific database cluster. The stanza section must define the database cluster path and host/user if the database cluster is remote. Also, any global configuration sections can be overridden to define stanza-specific settings.
+
+
A stanza defines the backup configuration for a specific database cluster. The stanza section must define the database cluster path and host/user if the database cluster is remote. Also, any global configuration sections can be overridden to define stanza-specific settings.
- Indexing: All pg- options are indexed to allow for configuring multiple hosts. For example, a single primary is configured with the pg1-path, pg1-port, etc. options. If a standby is configured then index the pg- options on the repository host as pg2- (e.g. pg2-host, pg2-path, etc).
+
Indexing: All pg- options are indexed to allow for configuring multiple hosts. For example, a single primary is configured with the pg1-path, pg1-port, etc. options. If a standby is configured then index the pg- options on the repository host as pg2- (e.g. pg2-host, pg2-path, etc).
+ exe path on the host.
- Required only if the path to is different on the local and hosts. If not defined, the database host exe path will be set the same as the local exe path.
+
+
Required only if the path to is different on the local and hosts. If not defined, the database host exe path will be set the same as the local exe path.
+ same as local/usr/lib/backrest/bin/pgbackrest
@@ -1094,7 +1338,9 @@
database host configuration file.
- Sets the location of the configuration file on the host. This is only required if the host configuration file is in a different location than the local configuration file.
+
+
Sets the location of the configuration file on the host. This is only required if the host configuration file is in a different location than the local configuration file.
+ /conf/pgbackrest/pgbackrest.conf
@@ -1103,7 +1349,9 @@
database host configuration include path.
- Sets the location of the configuration include path on the host. This is only required if the host configuration include path is in a different location than the local configuration include path.
+
+
Sets the location of the configuration include path on the host. This is only required if the host configuration include path is in a different location than the local configuration include path.
+ /conf/pgbackrest/conf.d
@@ -1112,7 +1360,9 @@
database host configuration path.
- Sets the location of the configuration path on the host. This is only required if the host configuration path is in a different location than the local configuration path.
+
+
Sets the location of the configuration path on the host. This is only required if the host configuration path is in a different location than the local configuration path.
+ /conf/pgbackrest
@@ -1121,7 +1371,9 @@
host for operating remotely via SSH.
- Used for backups where the host is different from the repository host.
+
+
Used for backups where the host is different from the repository host.
+ db.domain.com
@@ -1130,7 +1382,9 @@
host logon user when pg-host is set.
- This user will also own the remote process and will initiate connections to . For this to work correctly the user should be the database cluster owner which is generally postgres, the default.
+
+
This user will also own the remote process and will initiate connections to . For this to work correctly the user should be the database cluster owner which is generally postgres, the default.
+ db_owner
@@ -1139,9 +1393,11 @@
database.
- The database name used when connecting to . The default is usually best but some installations may not contain this database.
+
+
The database name used when connecting to . The default is usually best but some installations may not contain this database.
- Note that for legacy reasons the setting of the PGDATABASE environment variable will be ignored.
+
Note that for legacy reasons the setting of the PGDATABASE environment variable will be ignored.
+ backupdb
@@ -1150,7 +1406,9 @@
is local.
- Indicates that for the specified index is local and any host settings for that index (e.g. pg1-host) should be ignored.
+
+
Indicates that for the specified index is local and any host settings for that index (e.g. pg1-host) should be ignored.
+ y
@@ -1159,9 +1417,11 @@
data directory.
- This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
+
+
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
- The pg-path option is tested against the value reported by on every online backup so it should always be current.
+
The pg-path option is tested against the value reported by on every online backup so it should always be current.
+ /data/db
@@ -1170,7 +1430,9 @@
port.
- Port that is running on. This usually does not need to be specified as most clusters run on the default port.
+
+
Port that is running on. This usually does not need to be specified as most clusters run on the default port.
+ 6543
@@ -1179,7 +1441,9 @@
unix socket path.
- The unix socket directory that was specified when was started. will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.
+
+
The unix socket directory that was specified when was started. will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.
+ /var/run/postgresql
@@ -1188,7 +1452,9 @@
database user.
- The database user name used when connecting to . If not specified will connect with the local OS user or PGUSER.
+
+
The database user name used when connecting to . If not specified will connect with the local OS user or PGUSER.
+ backupuser
@@ -1197,7 +1463,9 @@
host port when pg-host is set.
- Use this option to specify a non-default port for the host protocol. Currently only SSH is supported
+
+
Use this option to specify a non-default port for the host protocol. Currently only SSH is supported.
+ 25
@@ -1210,15 +1478,17 @@
The {[project]} Command Reference details all commands and options.
- Commands are used to execute the various functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also configured in pgbackrest.conf.
+
+
Commands are used to execute the various functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also configured in pgbackrest.conf.
- Non-boolean options configured in pgbackrest.conf can be reset to default on the command-line by using the reset- prefix. This feature may be used to restore a backup directly on a repository host. Normally, will error because it can see that the database host is remote and restores cannot be done remotely. By adding --reset-pg1-host on the command-line, will ignore the remote database host and restore locally. It may be necessary to pass a new --pg1-path to force the restore to happen in a specific path, i.e. not the path used on the database host.
+
Non-boolean options configured in pgbackrest.conf can be reset to default on the command-line by using the reset- prefix. This feature may be used to restore a backup directly on a repository host. Normally, will error because it can see that the database host is remote and restores cannot be done remotely. By adding --reset-pg1-host on the command-line, will ignore the remote database host and restore locally. It may be necessary to pass a new --pg1-path to force the restore to happen in a specific path, i.e. not the path used on the database host.
- The no- prefix may be used to set a boolean option to false on the command-line.
+
The no- prefix may be used to set a boolean option to false on the command-line.
- Any option may be set in an environment variable using the PGBACKREST_ prefix and the option name in all caps replacing - with _, e.g. pg1-path becomes PGBACKREST_PG1_PATH and stanza becomes PGBACKREST_STANZA. Boolean options are represented as they would be in a configuration file, e.g. PGBACKREST_COMPRESS="n", and reset-* variants are not allowed. Options that that can be specified multiple times on the command-line or in a config file can be represented by separating the values with colons, e.g. PGBACKREST_DB_INCLUDE="db1:db2".
+
Any option may be set in an environment variable using the PGBACKREST_ prefix and the option name in all caps replacing - with _, e.g. pg1-path becomes PGBACKREST_PG1_PATH and stanza becomes PGBACKREST_STANZA. Boolean options are represented as they would be in a configuration file, e.g. PGBACKREST_COMPRESS="n", and reset-* variants are not allowed. Options that that can be specified multiple times on the command-line or in a config file can be represented by separating the values with colons, e.g. PGBACKREST_DB_INCLUDE="db1:db2".
Command-line options override environment options which override config file options.
+
@@ -1226,7 +1496,9 @@
@@ -1235,7 +1507,9 @@
@@ -1244,7 +1518,9 @@
@@ -1253,9 +1529,11 @@
@@ -1264,7 +1542,9 @@
@@ -1273,9 +1553,11 @@
@@ -1284,7 +1566,9 @@
@@ -1293,9 +1577,11 @@
@@ -1304,9 +1590,11 @@
@@ -1318,23 +1606,28 @@
Backup a database cluster.
- When multiple repositories are configured, will backup to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
+
When multiple repositories are configured, will backup to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
- does not have a built-in scheduler so it's best to run it from cron or some other scheduling mechanism.
+
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.
+
See Perform a Backup for more details and examples.
+
@@ -1343,9 +1636,11 @@
@@ -1354,9 +1649,11 @@
@@ -1367,46 +1664,60 @@
Push a WAL segment to the archive.
- Accepts a WAL segment from 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.
+
+
Accepts a WAL segment from 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 . See Configure Archiving for an example.
+
The archive-push is intended to be configured and called by . See Configure Archiving for an example.
+ Get a WAL segment from the archive.
- This command is used by to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for recovery or to maintain a replica.
+
+
This command is used by to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for 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 {[dash]}-repo option then only that repository will be searched.
+
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 {[dash]}-repo option then only that repository will be searched.
- The archive-get command is configured and generated by during a restore for use by . See Point-in-Time Recovery for an example.
+
The archive-get command is configured and generated by during a restore for use by . See Point-in-Time Recovery for an example.
+ Check the configuration.
- The check command validates that 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 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.
+
+
The check command validates that 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 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.
- Note that pg_create_restore_point('pgBackRest Archive Check') and pg_switch_xlog()/pg_switch_wal() are called to force to archive a WAL segment. Restore points are only supported in >= 9.1 so for older versions the check command may fail if there has been no write activity since the last log rotation, therefore it is recommended that activity be generated by the user if there have been no writes since the last WAL switch before running the check command.
-
+
Note that pg_create_restore_point('pgBackRest Archive Check') and pg_switch_xlog()/pg_switch_wal() are called to force to archive a WAL segment. Restore points are only supported in >= 9.1 so for older versions the check command may fail if there has been no write activity since the last log rotation, therefore it is recommended that activity be generated by the user if there have been no writes since the last WAL switch before running the check command.
+
+
+ Expire backups that exceed retention.
- 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 and Incremental backups are count-based but will always be expired when the backup they depend on is expired. See sections Full Backup Retention and Differential Backup Retention for details and examples. Archived WAL is retained by default for backups that have not expired, however, although not recommended, this schedule can be modified per repository with the retention-archive options. See section Archive Retention for details and examples.
+
+
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 and Incremental backups are count-based but will always be expired when the backup they depend on is expired. See sections Full Backup Retention and Differential Backup Retention for details and examples. Archived WAL is retained by default for backups that have not expired, however, although not recommended, this schedule can be modified per repository with the retention-archive options. See section Archive Retention for details and examples.
- The expire command is run automatically after each successful backup and can also be run by the user. When run by the user, expiration will occur as defined by the retention settings for each configured repository. If the {[dash]}-repo option is provided, expiration will occur only on the specified repository. Expiration can also be limited by the user to a specific backup set with the --set option and, unless the {[dash]}-repo option is specified, all repositories will be searched and any matching the set criteria will be expired. It should be noted that the archive retention schedule will be checked and performed any time the expire command is run.
+
The expire command is run automatically after each successful backup and can also be run by the user. When run by the user, expiration will occur as defined by the retention settings for each configured repository. If the {[dash]}-repo option is provided, expiration will occur only on the specified repository. Expiration can also be limited by the user to a specific backup set with the --set option and, unless the {[dash]}-repo option is specified, all repositories will be searched and any matching the set criteria will be expired. It should be noted that the archive retention schedule will be checked and performed any time the expire command is run.
+
@@ -1416,26 +1727,31 @@
Create the repository.
- Create the repository (path, bucket, etc.) on the default repository. If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified. If repo-type=s3 the bucket will be created.
-
+
+
Create the repository (path, bucket, etc.) on the default repository. If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified. If repo-type=s3 the bucket will be created.
+ Get a file from a repository.
- 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 setup.
+
+
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 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.
+
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.
- If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
@@ -1446,18 +1762,22 @@
List files in a repository.
- 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 {[dash]}-repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal setup.
+
+
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 {[dash]}-repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal setup.
- The default text output prints one file name per line. JSON output is available by specifying --output=json.
+
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 {[dash]}-repo option is specified.
+
If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
@@ -1466,18 +1786,24 @@
@@ -1486,7 +1812,9 @@
@@ -1495,12 +1823,15 @@
@@ -1511,25 +1842,31 @@
Put a file in the repository.
- Similar to the unix tee command by copying from stdin to a file but options and behavior are different. 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 setup.
+
+
Similar to the unix tee command by copying from stdin to a file but options and behavior are different. 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 setup.
- If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+ Remove paths/files in the repository.
- Similar to the unix rm command but options are different. This command accepts a path, absolute or relative to the repository path defined by the {[dash]}-repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal setup.
+
+
Similar to the unix rm command but options are different. This command accepts a path, absolute or relative to the repository path defined by the {[dash]}-repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal setup.
- If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the {[dash]}-repo option is specified.
+
@@ -1540,16 +1877,21 @@
Restore a database cluster.
- 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 {[dash]}-repo option can be passed (e.g. {[dash]}-repo=1). The {[dash]}-set option can be passed if a backup other than the latest is desired.
+
+
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 {[dash]}-repo option can be passed (e.g. {[dash]}-repo=1). The {[dash]}-set option can be passed if a backup other than the latest is desired.
- When PITR of {[dash]}-type=time is specified, then the target time must be specified with the {[dash]}-target option. If a backup is not specified via the {[dash]}-set option, then the configured repositories will be checked, in order, for a backup that contains the requested time. If no backup can be found, the latest backup from the first repository containing backups will be used. For other types of PITR, e.g. xid, the {[dash]}-set option must be provided if the target is prior to the latest backup. See Point-in-Time Recovery for more details and examples.
+
When PITR of {[dash]}-type=time is specified, then the target time must be specified with the {[dash]}-target option. If a backup is not specified via the {[dash]}-set option, then the configured repositories will be checked, in order, for a backup that contains the requested time. If no backup can be found, the latest backup from the first repository containing backups will be used. For other types of PITR, e.g. xid, the {[dash]}-set option must be provided if the target is prior to the latest backup. See Point-in-Time Recovery for more details and examples.
+
@@ -1557,7 +1899,9 @@
@@ -1566,18 +1910,22 @@
@@ -1585,7 +1933,10 @@
@@ -1593,7 +1944,9 @@
@@ -1602,14 +1955,17 @@
@@ -1618,7 +1974,9 @@
@@ -1629,37 +1987,43 @@
Retrieve information about backups.
- 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.
+
+
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.
+
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.
- Each stanza has a separate section and it is possible to limit output to a single stanza with the --stanza option. The stanza 'status' gives a brief indication of the stanza's health. If this is 'ok' then is functioning normally. If there are multiple repositories, then a status of 'mixed' indicates that the stanza is not in a healthy state on one or more of the repositories; in this case the state of the stanza will be detailed per repository. For cases in which an error on a repository occurred that is not one of the known error codes, then an error code of 'other' will be used and the full error details will be provided. The 'wal archive min/max' shows the minimum and maximum WAL currently stored in the archive and, in the case of multiple repositories, will be reported across all repositories unless the {[dash]}-repo option is set. Note that there may be gaps due to archive retention policies or other reasons.
+
Each stanza has a separate section and it is possible to limit output to a single stanza with the --stanza option. The stanza 'status' gives a brief indication of the stanza's health. If this is 'ok' then is functioning normally. If there are multiple repositories, then a status of 'mixed' indicates that the stanza is not in a healthy state on one or more of the repositories; in this case the state of the stanza will be detailed per repository. For cases in which an error on a repository occurred that is not one of the known error codes, then an error code of 'other' will be used and the full error details will be provided. The 'wal archive min/max' shows the minimum and maximum WAL currently stored in the archive and, in the case of multiple repositories, will be reported across all repositories unless the {[dash]}-repo option is set. Note that there may be gaps due to archive retention policies or other reasons.
- The 'backup/expire running' message will appear beside the 'status' information if one of those commands is currently running on the host.
+
The 'backup/expire running' message will appear beside the 'status' information if one of those commands is currently running on the host.
- The backups are displayed oldest to newest. The oldest backup will always be a full backup (indicated by an F at the end of the label) but the newest backup can be full, differential (ends with D), or incremental (ends with I).
+
The backups are displayed oldest to newest. The oldest backup will always be a full backup (indicated by an F at the end of the label) but the newest backup can be full, differential (ends with D), or incremental (ends with I).
- The 'timestamp start/stop' defines the time period when the backup ran. The 'timestamp stop' can be used to determine the backup to use when performing Point-In-Time Recovery. More information about Point-In-Time Recovery can be found in the Point-In-Time Recovery section.
+
The 'timestamp start/stop' defines the time period when the backup ran. The 'timestamp stop' can be used to determine the backup to use when performing Point-In-Time Recovery. More information about Point-In-Time Recovery can be found in the Point-In-Time Recovery section.
- The 'wal start/stop' defines the WAL range that is required to make the database consistent when restoring. The backup command will ensure that this WAL range is in the archive before completing.
+
The 'wal start/stop' defines the WAL range that is required to make the database consistent when restoring. The backup command will ensure that this WAL range is in the archive before completing.
- The 'database size' is the full uncompressed size of the database while 'database backup size' is the amount of data in the database to actually back up (these will be the same for full backups).
+
The 'database size' is the full uncompressed size of the database while 'database backup size' is the amount of data in the database to actually back up (these will be the same for full backups).
- The 'repo' indicates in which repository this backup resides. The 'backup set size' includes all the files from this backup and any referenced backups in the repository that are required to restore the database from this backup while 'backup size' includes only the files in this backup (these will also be the same for full backups). Repository sizes reflect compressed file sizes if compression is enabled in or the filesystem.
+
The 'repo' indicates in which repository this backup resides. The 'backup set size' includes all the files from this backup and any referenced backups in the repository that are required to restore the database from this backup while 'backup size' includes only the files in this backup (these will also be the same for full backups). Repository sizes reflect compressed file sizes if compression is enabled in or the filesystem.
- The 'backup reference list' contains the additional backups that are required to restore this backup.
-
+
The 'backup reference list' contains the additional backups that are required to restore this backup.
+
+
+
@@ -1667,7 +2031,10 @@
@@ -1677,30 +2044,38 @@
Get 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 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.
+
+
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.
+ Allow processes to run.
- If the 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 processes but they are allowed to run. See Starting and Stopping for more information and examples.
+
+
If the 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 processes but they are allowed to run. See Starting and Stopping for more information and examples.
+ Stop processes from running.
- Does not allow any new processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes.
+
+
Does not allow any new processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes.
- processes will return an error if they are run after the stop command completes. See Starting and Stopping for more information and examples.
+
processes will return an error if they are run after the stop command completes. See Starting and Stopping for more information and examples.
+
@@ -1711,14 +2086,19 @@
Verify the contents of the repository.
- Verify will attempt to determine if the backups and archives in the repository are valid.
+
+
Verify will attempt to determine if the backups and archives in the repository are valid.
+ Create the required stanza data.
- 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. See Create the Stanza for more information and an example.
+
+
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. See Create the Stanza for more information and an example.
+
@@ -1751,7 +2137,9 @@
@@ -1762,15 +2150,20 @@
Upgrade a stanza.
- Immediately after upgrading to a newer major version, the pg-path for all 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 created on each. If the database is offline use the --no-online option.
-
+
+
Immediately after upgrading to a newer major version, the pg-path for all 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 created on each. If the database is offline use the --no-online option.
+
+
+
@@ -1781,23 +2174,34 @@
Delete a stanza.
- The stanza-delete command removes data in the repository associated with a stanza.Use this command with caution — it will permanently remove all backups and archives from the repository for the specified stanza.
- To delete a stanza:
-
-
Shut down the 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 configuration files and/or environment variables.
+
+
The stanza-delete command removes data in the repository associated with a stanza.
- A stanza may only be deleted from one repository at a time. To delete the stanza from multiple repositories, repeat the stanza-delete command for each repository while specifying the {[dash]}-repo option.
-
+ Use this command with caution — it will permanently remove all backups and archives from the repository for the specified stanza.
+
+
To delete a stanza:
+
+
+ Shut down the 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 configuration files and/or environment variables.
+
+
A stanza may only be deleted from one repository at a time. To delete the stanza from multiple repositories, repeat the stanza-delete command for each repository while specifying the {[dash]}-repo option.
+
+
+
diff --git a/doc/xml/release.xml b/doc/xml/release.xml
index 36fad2158..06868797c 100644
--- a/doc/xml/release.xml
+++ b/doc/xml/release.xml
@@ -4,11 +4,13 @@
The {[project]} Releases detail each version of the software and lists the changes made in each version.
- 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 releases can include bug fixes and features but do not change the repository format and strive to avoid changing options and naming.
+
+
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 releases can include bug fixes and features but do not change the repository format and strive to avoid changing options and naming.
- Documentation for the v1 release can be found here.
+
Documentation for the v1 release can be found here.
- The notes for a release may also contain Additional Notes but changes in this section are only to documentation or the test suite and have no direct impact on the codebase.
+
The notes for a release may also contain Additional Notes but changes in this section are only to documentation or the test suite and have no direct impact on the codebase.
+
@@ -31,7 +33,10 @@
-
IMPORTANT NOTE: The log level for copied files in the backup/restore commands has been changed to detail. This makes the info log level less noisy but if these messages are required then set the log level for the backup/restore commands to detail.
+
+
IMPORTANT NOTE: The log level for copied files in the backup/restore commands has been changed to detail. This makes the info log level less noisy but if these messages are required then set the log level for the backup/restore commands to detail.
+
+
@@ -3266,7 +3271,9 @@
-
IMPORTANT NOTE: The new TLS/SSL implementation forbids dots in S3 bucket names per RFC-2818. This security fix is required for compliant hostname verification.
+
+
IMPORTANT NOTE: The new TLS/SSL implementation forbids dots in S3 bucket names per RFC-2818. This security fix is required for compliant hostname verification.
+
@@ -5020,7 +5027,9 @@
-
IMPORTANT NOTE: This release fixes a critical bug in the backup resume feature. All resumed backups prior to this release should be considered inconsistent. A backup will be resumed after a prior backup fails, unless resume=n has been specified. A resumed backup can be identified by checking the backup log for the message aborted backup of same type exists, will be cleaned to remove invalid files and resumed. If the message exists, do not use this backup or any backup in the same set for a restore and check the restore logs to see if a resumed backup was restored. If so, there may be inconsistent data in the cluster.
+
+
IMPORTANT NOTE: This release fixes a critical bug in the backup resume feature. All resumed backups prior to this release should be considered inconsistent. A backup will be resumed after a prior backup fails, unless resume=n has been specified. A resumed backup can be identified by checking the backup log for the message aborted backup of same type exists, will be cleaned to remove invalid files and resumed. If the message exists, do not use this backup or any backup in the same set for a restore and check the restore logs to see if a resumed backup was restored. If so, there may be inconsistent data in the cluster.
+
@@ -5948,7 +5957,9 @@
-
IMPORTANT NOTE: This release fixes a critical bug in the backup resume feature. All resumed backups prior to this release should be considered inconsistent. A backup will be resumed after a prior backup fails, unless resume=n has been specified. A resumed backup can be identified by checking the backup log for the message aborted backup of same type exists, will be cleaned to remove invalid files and resumed. If the message exists, do not use this backup or any backup in the same set for a restore and check the restore logs to see if a resumed backup was restored. If so, there may be inconsistent data in the cluster.
+
+
IMPORTANT NOTE: This release fixes a critical bug in the backup resume feature. All resumed backups prior to this release should be considered inconsistent. A backup will be resumed after a prior backup fails, unless resume=n has been specified. A resumed backup can be identified by checking the backup log for the message aborted backup of same type exists, will be cleaned to remove invalid files and resumed. If the message exists, do not use this backup or any backup in the same set for a restore and check the restore logs to see if a resumed backup was restored. If so, there may be inconsistent data in the cluster.
+
@@ -6928,7 +6939,10 @@
-
IMPORTANT NOTE: 8.3 and 8.4 installations utilizing tablespaces should upgrade immediately from any v1 release and run a full backup. A bug prevented tablespaces from being backed up on these versions only. ≥ 9.0 is not affected.
+
+
IMPORTANT NOTE: 8.3 and 8.4 installations utilizing tablespaces should upgrade immediately from any v1 release and run a full backup. A bug prevented tablespaces from being backed up on these versions only. ≥ 9.0
+ is not affected.
+
@@ -7522,11 +7536,13 @@
-
IMPORTANT NOTE: The new implementation of asynchronous archiving no longer copies WAL to a separate queue. If there is any WAL left over in the old queue after upgrading to 1.13, it will be abandoned and not pushed to the repository.
+
+
IMPORTANT NOTE: The new implementation of asynchronous archiving no longer copies WAL to a separate queue. If there is any WAL left over in the old queue after upgrading to 1.13, it will be abandoned and not pushed to the repository.
- To prevent this outcome, stop archiving by setting archive_command = false. Next, drain the async queue by running pgbackrest --stanza=[stanza-name] archive-push and wait for the process to complete. Check that the queue in [spool-path]/archive/[stanza-name]/out is empty. Finally, install 1.13 and restore the original archive_command.
+
To prevent this outcome, stop archiving by setting archive_command = false. Next, drain the async queue by running pgbackrest --stanza=[stanza-name] archive-push and wait for the process to complete. Check that the queue in [spool-path]/archive/[stanza-name]/out is empty. Finally, install 1.13 and restore the original archive_command.
- IMPORTANT NOTE: The stanza-create command is not longer optional and must be executed before backup or archiving can be performed on a new stanza. Pre-existing stanzas do not require stanza-create to be executed.
+
IMPORTANT NOTE: The stanza-create command is not longer optional and must be executed before backup or archiving can be performed on a new stanza. Pre-existing stanzas do not require stanza-create to be executed.
+
@@ -7762,7 +7778,9 @@
-
IMPORTANT NOTE: In prior releases it was possible to specify options on the command-line that were invalid for the current command without getting an error. An error will now be generated for invalid options so it is important to carefully check command-line options in your environment to prevent disruption.
+
+
IMPORTANT NOTE: In prior releases it was possible to specify options on the command-line that were invalid for the current command without getting an error. An error will now be generated for invalid options so it is important to carefully check command-line options in your environment to prevent disruption.
+
@@ -8919,7 +8937,9 @@
-
IMPORTANT NOTE: This flag day release breaks compatibility with older versions of . The manifest format, on-disk structure, configuration scheme, and the exe/path names have all changed. You must create a new repository to hold backups for this version of and keep your older repository for a time in case you need to do a restore. Restores from the prior repository will require the prior version of but because of name changes it is possible to have 1.00 and a prior version of installed at the same time. See the notes below for more detailed information on what has changed.
+
+
IMPORTANT NOTE: This flag day release breaks compatibility with older versions of . The manifest format, on-disk structure, configuration scheme, and the exe/path names have all changed. You must create a new repository to hold backups for this version of and keep your older repository for a time in case you need to do a restore. Restores from the prior repository will require the prior version of but because of name changes it is possible to have 1.00 and a prior version of installed at the same time. See the notes below for more detailed information on what has changed.
+
@@ -9013,7 +9033,9 @@
-
IMPORTANT BUG FIX FOR TABLESPACES: A change to the repository format was accidentally introduced in 0.90 which means the on-disk backup was no longer a valid cluster when the backup contained tablespaces. This only affected users who directly copied the backups to restore clusters rather than using the restore command. However, the fix breaks compatibility with older backups that contain tablespaces no matter how they are being restored ( will throw errors and refuse to restore). New full backups should be taken immediately after installing version 0.91 for any clusters that contain tablespaces. If older backups need to be restored then use a version of that matches the backup version.
+
+
IMPORTANT BUG FIX FOR TABLESPACES: A change to the repository format was accidentally introduced in 0.90 which means the on-disk backup was no longer a valid cluster when the backup contained tablespaces. This only affected users who directly copied the backups to restore clusters rather than using the restore command. However, the fix breaks compatibility with older backups that contain tablespaces no matter how they are being restored ( will throw errors and refuse to restore). New full backups should be taken immediately after installing version 0.91 for any clusters that contain tablespaces. If older backups need to be restored then use a version of that matches the backup version.
+
@@ -9511,7 +9533,9 @@
-
IMPORTANT NOTE: This flag day release breaks compatibility with older versions of . The manifest format, on-disk structure, and the binary names have all changed. You must create a new repository to hold backups for this version of and keep your older repository for a time in case you need to do a restore. The pg_backrest.conf file has not changed but you'll need to change any references to pg_backrest.pl in cron (or elsewhere) to pg_backrest (without the .pl extension).
+
+
IMPORTANT NOTE: This flag day release breaks compatibility with older versions of . The manifest format, on-disk structure, and the binary names have all changed. You must create a new repository to hold backups for this version of and keep your older repository for a time in case you need to do a restore. The pg_backrest.conf file has not changed but you'll need to change any references to pg_backrest.pl in cron (or elsewhere) to pg_backrest (without the .pl extension).