pgBackRest

https://pgbackrest.org/configuration.html
Admin
pgBackRest is a reliable and robust backup and restore solution specifically designed for PostgreSQL...
Tokens:18,567
Snippets:241
Trust Score:9.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### repo1-azure-uri-style example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-uri-style option. Default is host. Example shows path.

```plaintext
default: host
example: repo1-azure-uri-style=path
```

--------------------------------

### tablespace-map-all example

Source: https://pgbackrest.org/configuration.html

Example of remapping all tablespaces to a new parent directory using the tablespace-map-all option. Tablespaces created after the backup started will not be mapped.

```plaintext
example: tablespace-map-all=/data/tablespace
```

--------------------------------

### tls-server-key-file example

Source: https://pgbackrest.org/configuration.html

Example of specifying the TLS server key file.

```plaintext
example: tls-server-key-file=/path/to/server.key
```

--------------------------------

### pg1-host example

Source: https://pgbackrest.org/configuration.html

Example of setting the PostgreSQL host for remote backups.

```plaintext
example: pg1-host=db.domain.com
```

--------------------------------

### repo1-azure-key-type example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-key-type option. Default is shared. Example shows sas.

```plaintext
default: shared
example: repo1-azure-key-type=sas
```

--------------------------------

### db-include example

Source: https://pgbackrest.org/configuration.html

Example of including only the database db_main in restore. The option can be passed multiple times.

```plaintext
example: db-include=db_main
```

--------------------------------

### repo-type example

Source: https://pgbackrest.org/configuration.html

Example of setting the repository type to cifs. The default is posix.

```plaintext
default: posix
example: repo1-type=cifs
```

--------------------------------

### repo1-azure-endpoint example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-endpoint option. Default is blob.core.windows.net. Example shows Azure Government endpoint.

```plaintext
default: blob.core.windows.net
example: repo1-azure-endpoint=blob.core.usgovcloudapi.net
```

--------------------------------

### Command line and configuration file examples for list options

Source: https://pgbackrest.org/configuration.html

Examples for options that can be provided multiple times, shown for command line and configuration file formats.

```plaintext
Command line example: --db-exclude=db1 --db-exclude=db2 --db-exclude=db5
Configuration file example, each on its own line:
    db-exclude=db1
    db-exclude=db2
    db-exclude=db5
```

--------------------------------

### link-all example

Source: https://pgbackrest.org/configuration.html

Example of setting link-all to y to restore all symlinks. The default is n.

```plaintext
default: n
example: link-all=y
```

--------------------------------

### tls-server-cert-file example

Source: https://pgbackrest.org/configuration.html

Example of specifying the TLS server certificate file.

```plaintext
example: tls-server-cert-file=/path/to/server.crt
```

--------------------------------

### repo1-azure-account example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-account option. Specifies Azure account used to store the repository.

```plaintext
example: repo1-azure-account=pg-backup
```

--------------------------------

### Command line and configuration file examples for size options

Source: https://pgbackrest.org/configuration.html

Examples for options that accept a size value, shown for command line and configuration file formats.

```plaintext
Command line example: --archive-get-queue-max=1GiB
Configuration file example: buffer-size=2MiB
```

--------------------------------

### Log Path Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-path, which sets the path where log files are stored. The default is /var/log/pgbackrest.

```plaintext
default: /var/log/pgbackrest
example: log-path=/backup/db/log
```

--------------------------------

### Command line and configuration file examples for key/value options

Source: https://pgbackrest.org/configuration.html

Examples for options that can be provided multiple times in the form key=value, shown for command line and configuration file formats.

```plaintext
Command line example: --tablespace-map=ts_01=/db/ts_01 --tablespace-map=ts_02=/db/ts_02
Configuration file example, each on its own line:
    tablespace-map=ts_01=/db/ts_01
    tablespace-map=ts_02=/db/ts_02
```

--------------------------------

### link-map example

Source: https://pgbackrest.org/configuration.html

Example of mapping a symlink destination to a new path.

```plaintext
example: link-map=pg_xlog=/data/xlog
```

--------------------------------

### Command line and configuration file examples for time options

Source: https://pgbackrest.org/configuration.html

Examples for options that accept a time value in seconds, shown for command line and configuration file formats.

```plaintext
Command line example: --io-timeout=90
Configuration file example: db-timeout=600
```

--------------------------------

### tls-server-address example

Source: https://pgbackrest.org/configuration.html

Example of setting the TLS server address. Default is localhost.

```plaintext
example: tls-server-address=*
```

--------------------------------

### tls-server-ca-file example

Source: https://pgbackrest.org/configuration.html

Example of specifying the TLS server certificate authority file.

```plaintext
example: tls-server-ca-file=/path/to/server.ca
```

--------------------------------

### tablespace-map example

Source: https://pgbackrest.org/configuration.html

Example of mapping a tablespace to a new location during restore using the tablespace-map option.

```plaintext
example: tablespace-map=ts_01=/db/ts_01
```

--------------------------------

### repo-target-time example

Source: https://pgbackrest.org/configuration.html

Example of setting the repo-target-time option to a specific timestamp. The timestamp is compared with <= and milliseconds are truncated.

```plaintext
example: repo-target-time=2024-08-08 12:12:12+00
```

--------------------------------

### repo1-azure-key example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-key option. Specifies shared key or shared access signature depending on repo-azure-key-type.

```plaintext
example: repo1-azure-key=T+9+aov82qNhrcXSNGZCzm9mjd4d75/oxxOr6r1JVpgTLA==
```

--------------------------------

### Log Subprocesses Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-subprocess, which enables file logging for subprocesses. The default is n.

```plaintext
default: n
example: log-subprocess=y
```

--------------------------------

### pg1-database example

Source: https://pgbackrest.org/configuration.html

Example of setting the PostgreSQL database name. Default is postgres, and the PGDATABASE environment variable is ignored.

```plaintext
example: pg1-database=backupdb
```

--------------------------------

### db-exclude example

Source: https://pgbackrest.org/configuration.html

Example of excluding a database named db_main from restore. The option can be passed multiple times.

```plaintext
example: db-exclude=db_main
```

--------------------------------

### tls-server-auth example

Source: https://pgbackrest.org/configuration.html

Example of authorizing clients by CN for specific stanzas. Wildcards are not allowed for the client CN.

```plaintext
example: tls-server-auth=client-cn=stanza1,stanza2
```

--------------------------------

### Console Log Level Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-level-console, which sets the level for console logging. The default is warn.

```plaintext
default: warn
example: log-level-console=error
```

--------------------------------

### File Log Level Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-level-file, which sets the level for file logging. The default is info.

```plaintext
default: info
example: log-level-file=debug
```

--------------------------------

### archive-push-batch-size option example

Source: https://pgbackrest.org/configuration.html

Shows the default, allowed range, and an example for the archive-push-batch-size option, which limits the amount of WAL processed per asynchronous run.

```plaintext
default: 16GiB
allowed: [1MiB, 4PiB]
example: archive-push-batch-size=1GiB
```

--------------------------------

### archive-mode example

Source: https://pgbackrest.org/configuration.html

Example of setting archive-mode to off. The default is preserve. This option is not available on PostgreSQL < 12.

```plaintext
default: preserve
example: archive-mode=off
```

--------------------------------

### repo1-azure-container example

Source: https://pgbackrest.org/configuration.html

Configuration example for repo1-azure-container option. Specifies Azure container used to store the repository. It is usually best to specify a prefix like /repo.

```plaintext
example: repo1-azure-container=pg-backup
```

--------------------------------

### archive-async option example

Source: https://pgbackrest.org/configuration.html

Shows the default and an example for the archive-async option, which enables asynchronous operation for archive-push and archive-get commands.

```plaintext
default: n
example: archive-async=y
```

--------------------------------

### Integer option examples

Source: https://pgbackrest.org/configuration.html

Shows command-line and configuration file syntax for an Integer option, such as --compress-level=3 and pg1-port=5432.

```plaintext
Command line example: --compress-level=3
Configuration file example: pg1-port=5432
```

--------------------------------

### archive-get-queue-max option example

Source: https://pgbackrest.org/configuration.html

Shows the default, allowed range, and an example for the archive-get-queue-max option, which specifies the maximum size of the archive-get queue when archive-async is enabled.

```plaintext
default: 128MiB
allowed: [0B, 4PiB]
example: archive-get-queue-max=1GiB
```

--------------------------------

### restore_command override example

Source: https://pgbackrest.org/configuration.html

Example of overriding the restore_command option. pgBackRest generates this automatically, and setting it manually is discouraged.

```plaintext
example: recovery-option=primary_conninfo=db.mydomain.com
```

--------------------------------

### archive-push-queue-max option example

Source: https://pgbackrest.org/configuration.html

Shows the allowed range and an example for the archive-push-queue-max option, which sets the maximum size of the PostgreSQL archive queue.

```plaintext
allowed: [0B, 4PiB]
example: archive-push-queue-max=1TiB
```

--------------------------------

### Log Timestamp Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-timestamp, which enables timestamps in console and file logging. The default is y.

```plaintext
default: y
example: log-timestamp=n
```

--------------------------------

### pg-version-force example

Source: https://pgbackrest.org/configuration.html

Configuration example for pg-version-force option. Forces PostgreSQL version instead of auto-detection. Useful for forks or development versions. Warning: pg_control and WAL headers are read with expected format for specified version.

```plaintext
example: pg-version-force=15
```

--------------------------------

### archive-header-check example

Source: https://pgbackrest.org/configuration.html

Configuration example for archive-header-check option. Default is y. Set to n to disable the check, e.g., if WAL is encrypted.

```plaintext
default: y
example: archive-header-check=n
```

--------------------------------

### archive-missing-retry option example

Source: https://pgbackrest.org/configuration.html

Shows the default and an example for the archive-missing-retry option, which controls retrying missing WAL segments in asynchronous mode.

```plaintext
default: y
example: archive-missing-retry=n
```

--------------------------------

### TLSv1.2 Cipher Suites Example

Source: https://pgbackrest.org/configuration.html

Example configuration for tls-cipher-12, which sets the allowed TLSv1.2 cipher suites. If unset, the default of the underlying OpenSSL library applies.

```plaintext
example: tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL
```

--------------------------------

### archive-timeout option example

Source: https://pgbackrest.org/configuration.html

Shows the default, allowed range, and an example for the archive-timeout option, which sets the maximum time to wait for each WAL segment to reach the archive repository.

```plaintext
default: 1m
allowed: [100ms, 1d]
example: archive-timeout=30
```

--------------------------------

### Path option examples

Source: https://pgbackrest.org/configuration.html

Shows command-line and configuration file syntax for a Path option, such as --repo1-path=/var/lib/pgbackrest and repo1-path=/var/lib/pgbackrest.

```plaintext
Command line example: --repo1-path=/var/lib/pgbackrest
Configuration file example: repo1-path=/var/lib/pgbackrest
```

--------------------------------

### String option examples

Source: https://pgbackrest.org/configuration.html

Shows command-line and configuration file syntax for a String option, such as --stanza=demo and repo1-cipher-pass=zWaf6XtpjIVZC5444yXB...

```plaintext
Command line example: --stanza=demo
Configuration file example: repo1-cipher-pass=zWaf6XtpjIVZC5444yXB...
```

--------------------------------

### Size option example

Source: https://pgbackrest.org/configuration.html

Shows command-line syntax for a Size option, such as --repo1-retention-full=5GiB, and explains that sizes can be specified in bytes or with units like KiB, MiB, GiB, TiB, PiB.

```plaintext
Command line example: --repo1-retention-full=5GiB
```

--------------------------------

### Boolean option examples

Source: https://pgbackrest.org/configuration.html

Shows command-line and configuration file syntax for a Boolean option, including --start-fast, --no-start-fast, --start-fast=y, --start-fast=n, and start-fast=y, start-fast=n.

```plaintext
Command line examples: --start-fast, --no-start-fast, --start-fast=y, --start-fast=n
Configuration file examples: start-fast=y, start-fast=n
```

--------------------------------

### Backup from Standby Example

Source: https://pgbackrest.org/configuration.html

Enables backup from standby to reduce primary load. Requires both primary and standby hosts configured. Modes: y, prefer, n. Default is n.

```plaintext
default: n
example: backup-standby=y
```

--------------------------------

### tls-server-port example

Source: https://pgbackrest.org/configuration.html

Example of setting the TLS server port. Default is 8432, allowed range is 1 to 65535.

```plaintext
example: tls-server-port=8000
```

--------------------------------

### Std Error Log Level Example

Source: https://pgbackrest.org/configuration.html

Example configuration for log-level-stderr, which sets the level for stderr logging. The default is off.

```plaintext
default: off
example: log-level-stderr=error
```
Tokens:
Raw