From 7030483528d89cbcefe5b2ffc6dfab80714b9df7 Mon Sep 17 00:00:00 2001 From: Harikrishna C Date: Wed, 15 Oct 2025 07:31:18 +0530 Subject: [PATCH] pg_basebackup: add page (#18698) Co-authored-by: Dylan <145150333+dmmqz@users.noreply.github.com> Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- pages/common/pg_basebackup.md | 37 +++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 pages/common/pg_basebackup.md diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md new file mode 100644 index 0000000000..3b90f2921c --- /dev/null +++ b/pages/common/pg_basebackup.md @@ -0,0 +1,37 @@ +# pg_basebackup + +> 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 information: . + +- 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`