pg_basebackup

all

Take a base backup of a running PostgreSQL cluster. Used for full or incremental backups, point-in-time recovery, or setting up replication standbys.

More info →

Options (11)

-h, --hostboolean

Take a base backup from a remote PostgreSQL server

Example: pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{path/to/backup_dir}}

-D, --pgdataboolean

Take a base backup from a remote PostgreSQL server

Example: pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{path/to/backup_dir}}

-P, --progressboolean

Take a backup with progress shown

Example: pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-P|--progress]}}

-F, --formatboolean

Create a compressed backup (`gzip`) in tar format

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}

boolean

Create a compressed backup (`gzip`) in tar format

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}

-z, --gzipboolean

Create a compressed backup (`gzip`) in tar format

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}

-i, --incrementalboolean

Create an incremental backup using a previous manifest file

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-i|--incremental]}} {{path/to/old_manifest}}

-R, --write-recovery-confboolean

Write a recovery configuration for setting up a standby

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-R|--write-recovery-conf]}}

-T, --tablespace-mappingboolean

Relocate a tablespace during backup

Example:

pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-T|--tablespace-mapping]}} {{path/to/old_tablespace}}={{path/to/new_tablespace}}

-r, --max-rateboolean

Limit transfer rate to reduce server load

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-r|--max-rate]}} {{100M}}

-X, --wal-methodboolean

Stream WAL logs while taking the backup

Example: pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-X|--wal-method]}} stream

Examples (8)

Take a base backup from a remote PostgreSQL server

pg_basebackup [-h|--host] host [-D|--pgdata] path/to/backup_dir

Take a backup with progress shown

pg_basebackup [-h|--host] host [-D|--pgdata] path/to/backup_dir [-P|--progress]

Create a compressed backup (`gzip`) in tar format

pg_basebackup [-D|--pgdata] path/to/backup_dir [-F|--format] [t|tar] [-z|--gzip]

Create an incremental backup using a previous manifest file

pg_basebackup [-D|--pgdata] path/to/backup_dir [-i|--incremental] path/to/old_manifest

Write a recovery configuration for setting up a standby

pg_basebackup [-D|--pgdata] path/to/backup_dir [-R|--write-recovery-conf]

Relocate a tablespace during backup

pg_basebackup [-D|--pgdata] path/to/backup_dir [-T|--tablespace-mapping] path/to/old_tablespace=path/to/new_tablespace

Limit transfer rate to reduce server load

pg_basebackup [-D|--pgdata] path/to/backup_dir [-r|--max-rate] 100M

Stream WAL logs while taking the backup

pg_basebackup [-D|--pgdata] path/to/backup_dir [-X|--wal-method] stream

made by @shridhargupta | data from tldr-pages