Configuration Reference
Introduction
pgBackRest
can be used entirely with command-line parameters but a configuration file is more practical for installations that are complex or set a lot of options. The default location for the configuration file is
/etc/pgbackrest.conf
.
Archive Options ( archive )
The
archive
section defines parameters when doing async archiving. This means that the archive files will be stored locally, then a background process will pick them and move them to the backup.
Asynchronous Archiving Option ( --archive-async )
Archive WAL segments asynchronously.
WAL segments will be copied to the local repo, then a process will be forked to compress the segment and transfer it to the remote repo if configured. Control will be returned to
PostgreSQL
as soon as the WAL segment is copied locally.
default: n example: archive-async=y
Maximum Archive Queue Size Option ( --archive-queue-max )
Limit size (in bytes) of the
PostgreSQL
archive queue.
After the limit is reached, the following will happen:
In asynchronous mode the entire queue will be dropped to prevent spurts of WAL getting through before the queue limit is exceeded again.
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 PostgreSQL go down.
- pgBackRest will notify PostgreSQL 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.
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 PostgreSQL go down.
allowed: 0-4503599627370496 example: archive-queue-max=1073741824
Archive Timeout Option ( --archive-timeout )
Archive timeout.
Set maximum time, in seconds, to wait for each WAL segment to reach the
pgBackRest
archive repository. The timeout applies to the
check
and
backup
commands when waiting for WAL segments required for backup consistency to be archived.
default: 60 allowed: 0.1-86400 example: archive-timeout=30
Backup Options ( backup )
The
backup
section defines settings related to backup.
Check Archive Option ( --archive-check )
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.
This option must be enabled if archive-copy is enabled.
This option must be enabled if archive-copy is enabled.
default: y example: archive-check=n
Copy Archive Option ( --archive-copy )
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.
On restore, the WAL segments will be present in pg_xlog/pg_wal and PostgreSQL will use them in preference to calling the restore_command .
The archive-check option must be enabled if archive-copy is enabled.
On restore, the WAL segments will be present in pg_xlog/pg_wal and PostgreSQL will use them in preference to calling the restore_command .
The archive-check option must be enabled if archive-copy is enabled.
default: n example: archive-copy=y
Backup from Standby Option ( --backup-standby )
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.
default: n example: backup-standby=y
Page Checksums Option ( --checksum-page )
Validate data page checksums.
Directs
pgBackRest
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.
example: checksum-page=n
Manifest Save Threshold Option ( --manifest-save-threshold )
Manifest save threshold during backup.
Defines how often the manifest will be saved during a backup (in bytes). 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.
default: 1073741824 allowed: 1-1099511627776 example: manifest-save-threshold=5368709120
Resume Option ( --resume )
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.
default: y example: resume=n
Start Fast Option ( --start-fast )
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.
This feature only works in PostgreSQL >= 8.4 .
This feature only works in PostgreSQL >= 8.4 .
default: n example: start-fast=y
Stop Auto Option ( --stop-auto )
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 feature relies on pg_is_in_backup() so only works on PostgreSQL >= 9.3 .
The setting is disabled by default because it assumes that pgBackRest is the only process doing exclusive online backups. It depends on an advisory lock that only pgBackRest 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.
This feature relies on pg_is_in_backup() so only works on PostgreSQL >= 9.3 .
The setting is disabled by default because it assumes that pgBackRest is the only process doing exclusive online backups. It depends on an advisory lock that only pgBackRest 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.
default: n example: stop-auto=y
General Options ( general )
The
general
section defines options that are common for many commands.
Buffer Size Option ( --buffer-size )
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.
default: 4194304 example: buffer-size=32768
SSH client command Option ( --cmd-ssh )
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the
ssh
executable is not in $PATH.
default: ssh example: cmd-ssh=/usr/bin/ssh
Compress Option ( --compress )
Use gzip file compression.
Backup files are compatible with command-line gzip tools.
default: y example: compress=n
Compress Level Option ( --compress-level )
Compression level for stored files.
Sets the zlib level to be used for file compression when
compress=y
.
default: 6 allowed: 0-9 example: compress-level=9
Network Compress Level Option ( --compress-level-network )
Compression level for network transfer when
compress=n
.
Sets the zlib level to be used for protocol compression when
compress=n
and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting
compress-level-network=0
. When
compress=y
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.
default: 3 allowed: 0-9 example: compress-level-network=1
Database Timeout Option ( --db-timeout )
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).
default: 1800 allowed: 0.1-604800 example: db-timeout=600
Lock Path Option ( --lock-path )
Path where lock files are stored.
The lock path provides a location for
pgBackRest
to create lock files to prevent conflicting operations from being run concurrently.
default: /tmp/pgbackrest example: lock-path=/backup/db/lock
Neutral Umask Option ( --neutral-umask )
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.
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.
default: y example: neutral-umask=n
Process Maximum Option ( --process-max )
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.
default: 1 allowed: 1-96 example: process-max=4
Protocol Timeout Option ( --protocol-timeout )
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.
default: 1830 allowed: 0.1-604800 example: protocol-timeout=630
Spool Path Option ( --spool-path )
Path where WAL segments are spooled during async archiving.
When asynchronous archiving is enabled
pgBackRest
needs a local directory to store WAL segments before they are compressed and moved to the repository. Depending on the volume of WAL generated this directory could become very large so be sure to plan accordingly.
The archive-queue-max option can be used to limit the amount of WAL that will be spooled locally.
The archive-queue-max option can be used to limit the amount of WAL that will be spooled locally.
default: /var/spool/pgbackrest example: spool-path=/backup/db/spool
Log Options ( log )
The
log
section defines logging-related settings.
IMPORTANT NOTE : Trace-level logging may expose secrets such as keys and passwords. Use with caution!
IMPORTANT NOTE : Trace-level logging may expose secrets such as keys and passwords. Use with caution!
Console Log Level Option ( --log-level-console )
Level for console 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
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors
default: warn example: log-level-console=error
File Log Level Option ( --log-level-file )
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
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors
default: info example: log-level-file=debug
Std Error Log Level Option ( --log-level-stderr )
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
.
The following log levels are supported:
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
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors
default: warn example: log-level-stderr=error
Repository Options ( repository )
The
repository
section defines options used to configure the repository.
Indexing : All repo- options are indexed to allow for configuring multiple repositories, though only a single repository is currently supported. For example, the repository is configured with the repo1-path , repo1-host , etc. options.
The repo-retention-* options define how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if retention-full is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for retention + 1 backups.
Indexing : All repo- options are indexed to allow for configuring multiple repositories, though only a single repository is currently supported. For example, the repository is configured with the repo1-path , repo1-host , etc. options.
The repo-retention-* options define how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if retention-full is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for retention + 1 backups.
Repository Cipher Passphrase Option ( --repo-cipher-pass )
Repository cipher passphrase.
Passphrase used to encrypt/decrypt files of the repository.
example: repo1-cipher-pass=zWaf6XtpjIVZC5444yXB+cgFDFl7MxGlgkZSaoPvTGirhPygu4jOKOXf9LO4vjfO
Repository Cipher Type Option ( --repo-cipher-type )
Cipher used to encrypt the repository.
The following repository types are supported:
- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length
default: none example: repo1-cipher-type=aes-256-cbc
Repository Hardlink Option ( --repo-hardlink )
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.
default: n example: repo1-hardlink=y
Deprecated Name: hardlink
Repository Host Option ( --repo-host )
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the
PostgreSQL
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.
example: repo1-host=repo1.domain.com
Deprecated Name: backup-host
Repository Host Command Option ( --repo-host-cmd )
pgBackRest
exe path on the repository host.
Required only if the path to
pgbackrest
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.
example: repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Deprecated Name: backup-cmd
Repository Host Configuration Option ( --repo-host-config )
pgBackRest
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.
default: /etc/pgbackrest.conf example: repo1-host-config=/etc/pgbackrest_backup.conf
Deprecated Name: backup-config
Repository Host Port Option ( --repo-host-port )
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
allowed: 0-65535 example: repo1-host-port=25
Deprecated Name: backup-ssh-port
Repository Host User Option ( --repo-host-user )
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
PostgreSQL
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.
default: pgbackrest example: repo1-host-user=repo-user
Deprecated Name: backup-user
Repository Path Option ( --repo-path )
Path where backups and archive are stored.
The repository is where
pgBackRest
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.
default: /var/lib/pgbackrest example: repo1-path=/backup/db/backrest
Archive Retention Option ( --repo-retention-archive )
Number of backups worth of continuous WAL to retain.
Note that the 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, 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.
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, 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.
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.
allowed: 1-9999999 example: repo1-retention-archive=2
Deprecated Name: retention-archive
Archive Retention Type Option ( --repo-retention-archive-type )
Backup type for WAL retention.
If set to
full
pgBackRest
will keep archive logs for the number of full backups defined by
repo-retention-archive
. If set to
diff
(differential)
pgBackRest
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)
pgBackRest
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.
default: full example: repo1-retention-archive-type=diff
Deprecated Name: retention-archive-type
Differential Retention Option ( --repo-retention-diff )
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.
allowed: 1-9999999 example: repo1-retention-diff=3
Deprecated Name: retention-diff
Full Retention Option ( --repo-retention-full )
Number of full backups to retain.
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.
allowed: 1-9999999 example: repo1-retention-full=2
Deprecated Name: retention-full
S3 Repository Bucket Option ( --repo-s3-bucket )
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest 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.
pgBackRest 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.
example: repo1-s3-bucket=pg-backup
S3 SSL CA File Option ( --repo-s3-ca-file )
S3 SSL CA File.
Use a CA file other than the system default.
example: repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
S3 SSL CA Path Option ( --repo-s3-ca-path )
S3 SSL CA Path.
Use a CA path other than the system default.
example: repo1-s3-ca-path=/etc/pki/tls/certs
S3 Repository Endpoint Option ( --repo-s3-endpoint )
S3 repository endpoint.
The AWS end point should be valid for the selected region.
example: repo1-s3-endpoint=s3.amazonaws.com
S3 Repository Host Option ( --repo-s3-host )
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.
example: repo1-s3-host=127.0.0.1
S3 Repository Access Key Option ( --repo-s3-key )
S3 repository access key.
AWS key used to access this bucket.
example: repo1-s3-key=AKIAIOSFODNN7EXAMPLE
S3 Repository Secret Access Key Option ( --repo-s3-key-secret )
S3 repository secret access key.
AWS secret key used to access this bucket.
example: repo1-s3-key-secret=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
S3 Repository Region Option ( --repo-s3-region )
S3 repository region.
The AWS region where the bucket was created.
example: repo1-s3-region=us-east-1
Restore Options ( restore )
The
restore
section defines settings used for restoring backups.
Include Database Option ( --db-include )
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
PostgreSQL
to perform recovery. After recovery the databases that were not included will not be accessible but can be removed with the
drop database
command.
Note that built-in databases ( template0 , template1 , and postgres ) are always restored.
The --db-include option can be passed multiple times to specify more than one database to include.
Note that built-in databases ( template0 , template1 , and postgres ) are always restored.
The --db-include option can be passed multiple times to specify more than one database to include.
example: db-include=db_main
Link All Option ( --link-all )
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.
default: n example: link-all=y
Link Map Option ( --link-map )
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.
example: link-map=pg_xlog=/data/xlog
Recovery Option Option ( --recovery-option )
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
PostgreSQL
version). This option can be used multiple times.
Note: The restore_command option will be automatically generated but can be overridden with this option. Be careful about specifying your own restore_command as pgBackRest is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by pgBackRest and should not be set with this option.
Since pgBackRest does not start PostgreSQL after writing the recovery.conf file, it is always possible to edit/check recovery.conf before manually restarting.
Note: The restore_command option will be automatically generated but can be overridden with this option. Be careful about specifying your own restore_command as pgBackRest is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by pgBackRest and should not be set with this option.
Since pgBackRest does not start PostgreSQL after writing the recovery.conf file, it is always possible to edit/check recovery.conf before manually restarting.
example: recovery-option=primary_conninfo=db.mydomain.com
Tablespace Map Option ( --tablespace-map )
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.
Since PostgreSQL 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 PostgreSQL 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.
example: tablespace-map=ts_01=/db/ts_01
Map All Tablespaces Option ( --tablespace-map-all )
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.
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.
example: tablespace-map-all=/data/tablespace
Stanza Options ( stanza )
A stanza defines the backup configuration for a specific
PostgreSQL
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 PostgreSQL hosts. For example, a single master is configured with the pg1-path , pg1-host , etc. options. If a standby is configured then index the pg- options as pg2- (e.g. pg2-host, pg2-path, etc).
Indexing : All pg- options are indexed to allow for configuring multiple PostgreSQL hosts. For example, a single master is configured with the pg1-path , pg1-host , etc. options. If a standby is configured then index the pg- options as pg2- (e.g. pg2-host, pg2-path, etc).
PostgreSQL Host Option ( --pg-host )
PostgreSQL
host for operating remotely via SSH.
Used for backups where the
PostgreSQL
host is different from the repository host.
example: pg1-host=db.domain.com
Deprecated Name: db-host
PostgreSQL Host Command Option ( --pg-host-cmd )
pgBackRest
exe path on the
PostgreSQL
host.
Required only if the path to
pgbackrest
is different on the local and
PostgreSQL
hosts. If not defined, the database host exe path will be set the same as the local exe path.
example: pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Deprecated Name: db-cmd
PostgreSQL Host Configuration Option ( --pg-host-config )
pgBackRest
database host configuration file.
Sets the location of the configuration file on the
PostgreSQL
host. This is only required if the
PostgreSQL
host configuration file is in a different location than the local configuration file.
default: /etc/pgbackrest.conf example: pg1-host-config=/etc/pgbackrest_db.conf
Deprecated Name: db-config
PostgreSQL Host Port Option ( --pg-host-port )
PostgreSQL
host port when
pg-host
is set.
Use this option to specify a non-default port for the
PostgreSQL
host protocol. Currently only SSH is supported
allowed: 0-65535 example: pg1-host-port=25
Deprecated Name: db-ssh-port
PostgreSQL Host User Option ( --pg-host-user )
PostgreSQL
host logon user when
pg-host
is set.
This user will also own the remote
pgBackRest
process and will initiate connections to
PostgreSQL
. For this to work correctly the user should be the
PostgreSQL
database cluster owner which is generally
postgres
, the default.
default: postgres example: pg1-host-user=db_owner
Deprecated Name: db-user
PostgreSQL Path Option ( --pg-path )
PostgreSQL
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
PostgreSQL
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 PostgreSQL on every online backup so it should always be current.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.
example: pg1-path=/data/db
Deprecated Name: db-path
PostgreSQL Port Option ( --pg-port )
PostgreSQL
port.
Port that
PostgreSQL
is running on. This usually does not need to be specified as most
PostgreSQL
clusters run on the default port.
default: 5432 allowed: 0-65535 example: pg1-port=6543
Deprecated Name: db-port
PostgreSQL Socket Path Option ( --pg-socket-path )
PostgreSQL
unix socket path.
The unix socket directory that was specified when
PostgreSQL
was started.
pgBackRest
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
.
allowed: 0-65535 example: pg1-socket-path=/var/run/postgresql
Deprecated Name: db-socket-path