pgBackRest

https://pgbackrest.org
Admin
pgBackRest is a reliable backup and restore solution for PostgreSQL that seamlessly scales up to the...
Tokens:28,697
Snippets:276
Trust Score:9.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### tablespace-map command line example

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

Command line example showing how to specify multiple values for the tablespace-map option.

```plaintext
--tablespace-map=ts_01=/db/ts_01 --tablespace-map=ts_02=/db/ts_02
```

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

### tablespace-map configuration file example

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

Configuration file example showing how to specify multiple values for the tablespace-map option, each on its own line.

```plaintext
tablespace-map=ts_01=/db/ts_01
tablespace-map=ts_02=/db/ts_02
```

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

### tablespace-map-all example

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

Restores all tablespaces into the specified directory. The example shows the syntax for mapping all tablespaces to /data/tablespace.

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

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

### db-exclude configuration file example

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

Configuration file example showing how to specify multiple values for the db-exclude option, each on its own line.

```plaintext
db-exclude=db1
db-exclude=db2
db-exclude=db5
```

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

### tls-server-key-file example

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

Specifies the TLS server key file. The example shows the syntax for setting the key file path.

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

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

### recovery-option example

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

Sets an option in postgresql.auto.conf or recovery.conf. The example shows the syntax for setting the primary_conninfo option.

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

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

### tls-server-cert-file example

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

Specifies the TLS server certificate file. The example shows the syntax for setting the certificate file path.

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

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

### tls-server-auth example

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

Authorizes clients by their certificate CN. The example shows the syntax for authorizing a client for multiple stanzas.

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

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

### archive-push-batch-size option default and 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
```

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

### tablespace-map example

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

Restores a tablespace into the specified directory. The example shows the syntax for mapping the ts_01 tablespace to /db/ts_01.

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

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

### Per-command option configuration example

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

Shows how to set the process-max option independently for each command in the pgBackRest configuration file. Use this to optimize resource usage per command, e.g., more cores for backup and restore, fewer for archive operations. The example includes global defaults and command-specific overrides.

```ini
[global]
# used where not overridden
process-max=2

[global:backup]
# more cores for backup
process-max=4

[global:restore]
# all the cores for restore
process-max=8

[global:archive-push]
# more cores for archive-push
process-max=3

[global:archive-get]
# fewer cores for archive-get
process-max=1

```

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

### archive-async option default and example

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

Shows the default value 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
```

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

### archive-get-queue-max option default and 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
```

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

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

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

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

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

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

### Repository Path Option (--repo-path) default and example

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

Sets the path where backups and WAL archives are stored. The default is /var/lib/pgbackrest. The example shows the option syntax with a custom path.

```text
default: /var/lib/pgbackrest
example: repo1-path=/backup/db/backrest

```

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

### tls-server-ca-file example

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

Specifies the TLS server certificate authorities file. The example shows the syntax for setting the CA file path.

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

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

### tls-server-address default and example

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

Sets the IP address the TLS server listens on. The default is localhost, and the example shows the syntax for listening on all interfaces.

```plaintext
default: localhost
```

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

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

### archive-timeout option default and 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
```

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

### Archive Retention Type Option (--repo-retention-archive-type) default and example

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

Backup type for WAL retention. The default is full. The example shows the option syntax with a value of diff.

```text
default: full
example: repo1-retention-archive-type=diff

```

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

### tls-server-port default and example

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

Sets the TLS server port. The default is 8432, and the example shows the syntax for setting it to 8000.

```plaintext
default: 8432
```

```plaintext
allowed: [1, 65535]
```

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

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

### PostgreSQL Host Command Option (--pg-host-cmd)

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

Sets the pgBackRest command on the PostgreSQL host. Required only if the path differs from the local command; otherwise defaults to the local command path.

```text
default: [path of executed pgbackrest binary]
example: pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

```

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

### archive-missing-retry option default and example

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

Shows the default value 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
```

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

### PostgreSQL Host Key File Option (--pg-host-key-file)

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

Specifies the client key file used to prove the client certificate was sent by the owner.

```text
example: pg1-host-key-file=/path/to/client.key

```

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

### Full Retention Option (--repo-retention-full) allowed and example

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

Full backup retention count/time. The allowed range is 1 to 9999999. The example shows the option syntax with a value of 2.

```text
allowed: [1, 9999999]
example: repo1-retention-full=2

```

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

### PostgreSQL Host Option (--pg-host)

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

Sets the PostgreSQL host for remote backups when the host differs from the repository host.

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

```

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

### Differential Retention Option (--repo-retention-diff) allowed and example

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

Number of differential backups to retain. The allowed range is 1 to 9999999. The example shows the option syntax with a value of 3.

```text
allowed: [1, 9999999]
example: repo1-retention-diff=3

```

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

### SFTP Repository Private Key File Option (--repo-sftp-private-key-file)

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

Specifies the path to the SFTP private key file used for authentication.

```plaintext
example: repo1-sftp-private-key-file=~/.ssh/id_ed25519
```
Tokens:
Raw