From 64bb67505954c5fdb71283892dc53c8ebb150d9c Mon Sep 17 00:00:00 2001 From: harryfrzz Date: Sun, 12 Oct 2025 16:17:33 +0530 Subject: [PATCH 1/6] pg_basebackup: add page --- 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 00000000000000..7ef0e61a3d14bc --- /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}} -D {{/path/to/backup_dir}}` + +- Take a backup with progress shown: + +`pg_basebackup -h {{host}} -D {{/path/to/backup_dir}} -P` + +- Create a compressed backup (gzip) in tar format: + +`pg_basebackup -D {{/path/to/backup_dir}} -Ft -z` + +- Create an incremental backup using a previous manifest file: + +`pg_basebackup -D {{/path/to/backup_dir}} -i {{/path/to/old_manifest}}` + +- Write a recovery configuration for setting up a standby: + +`pg_basebackup -D {{/path/to/backup_dir}} -R` + +- Relocate a tablespace during backup: + +`pg_basebackup -D {{/path/to/backup_dir}} -T {{/old/tablespace}}={{/new/tablespace}}` + +- Limit transfer rate to reduce server load: + +`pg_basebackup -D {{/path/to/backup_dir}} --max-rate={{100M}}` + +- Stream WAL logs while taking the backup: + +`pg_basebackup -D {{/path/to/backup_dir}} -X stream` From 5b10ccd1f9ffd4a52bb90dc6cf23fb2e87301e94 Mon Sep 17 00:00:00 2001 From: harryfrzz Date: Sun, 12 Oct 2025 18:05:38 +0530 Subject: [PATCH 2/6] fix: added long command options --- pages/common/pg_basebackup.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md index 7ef0e61a3d14bc..bf1bd8f032650d 100644 --- a/pages/common/pg_basebackup.md +++ b/pages/common/pg_basebackup.md @@ -6,32 +6,32 @@ - Take a base backup from a remote PostgreSQL server: -`pg_basebackup -h {{host}} -D {{/path/to/backup_dir}}` +`pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{/path/to/backup_dir}}` - Take a backup with progress shown: -`pg_basebackup -h {{host}} -D {{/path/to/backup_dir}} -P` +`pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-P|--progress]}}` - Create a compressed backup (gzip) in tar format: -`pg_basebackup -D {{/path/to/backup_dir}} -Ft -z` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} t {{[-z|--gzip]}}` - Create an incremental backup using a previous manifest file: -`pg_basebackup -D {{/path/to/backup_dir}} -i {{/path/to/old_manifest}}` +`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 {{/path/to/backup_dir}} -R` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-R|--write-recovery-conf]}}` - Relocate a tablespace during backup: -`pg_basebackup -D {{/path/to/backup_dir}} -T {{/old/tablespace}}={{/new/tablespace}}` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-T|--tablespace-mapping]}} {{/old/tablespace}}={{/new/tablespace}}` - Limit transfer rate to reduce server load: -`pg_basebackup -D {{/path/to/backup_dir}} --max-rate={{100M}}` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[--max-rate]}} {{100M}}` - Stream WAL logs while taking the backup: -`pg_basebackup -D {{/path/to/backup_dir}} -X stream` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-X|--wal-method]}} stream` From 3108b76ea12e644bb09399983c27f4651db65680 Mon Sep 17 00:00:00 2001 From: Harikrishna C Date: Sun, 12 Oct 2025 06:52:01 -0700 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Dylan <145150333+dmmqz@users.noreply.github.com> --- pages/common/pg_basebackup.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md index bf1bd8f032650d..4a7bb1ce9c99a4 100644 --- a/pages/common/pg_basebackup.md +++ b/pages/common/pg_basebackup.md @@ -6,32 +6,32 @@ - Take a base backup from a remote PostgreSQL server: -`pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{/path/to/backup_dir}}` +`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]}}` +`pg_basebackup {{[-h|--host]}} {{host}} {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-P|--progress]}}` -- Create a compressed backup (gzip) in tar format: +- Create a compressed backup (`gzip`) in tar format: `pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} t {{[-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}}` +`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]}}` +`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]}} {{/old/tablespace}}={{/new/tablespace}}` +`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}} {{[--max-rate]}} {{100M}}` +`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` +`pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-X|--wal-method]}} stream` From 47abeb4ccc9a92513e972d7407f28d691b5476cf Mon Sep 17 00:00:00 2001 From: harryfrzz Date: Sun, 12 Oct 2025 19:24:07 +0530 Subject: [PATCH 4/6] Fixed formatting issue --- pages/common/pg_basebackup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md index 4a7bb1ce9c99a4..695f905f0338aa 100644 --- a/pages/common/pg_basebackup.md +++ b/pages/common/pg_basebackup.md @@ -14,7 +14,7 @@ - Create a compressed backup (`gzip`) in tar format: -`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} t {{[-z|--gzip]}}` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} {{t}} {{[-z|--gzip]}}` - Create an incremental backup using a previous manifest file: From c978ba26c52b3d058e6eb865c4a57cf010b7d8ba Mon Sep 17 00:00:00 2001 From: Harikrishna C Date: Sun, 12 Oct 2025 07:03:17 -0700 Subject: [PATCH 5/6] Update pages/common/pg_basebackup.md Co-authored-by: Dylan <145150333+dmmqz@users.noreply.github.com> --- pages/common/pg_basebackup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md index 695f905f0338aa..106d283c13f312 100644 --- a/pages/common/pg_basebackup.md +++ b/pages/common/pg_basebackup.md @@ -14,7 +14,7 @@ - Create a compressed backup (`gzip`) in tar format: -`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} {{t}} {{[-z|--gzip]}}` +`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}` - Create an incremental backup using a previous manifest file: From 07a7af3c5635d94611e25c3ca9e0c5f4b7cb0838 Mon Sep 17 00:00:00 2001 From: Harikrishna C Date: Mon, 13 Oct 2025 07:04:22 -0700 Subject: [PATCH 6/6] Update pages/common/pg_basebackup.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- pages/common/pg_basebackup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/pg_basebackup.md b/pages/common/pg_basebackup.md index 106d283c13f312..3b90f2921cd7dd 100644 --- a/pages/common/pg_basebackup.md +++ b/pages/common/pg_basebackup.md @@ -14,7 +14,7 @@ - Create a compressed backup (`gzip`) in tar format: -`pg_basebackup {{[-D|--pgdata]}} {{/path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}` +`pg_basebackup {{[-D|--pgdata]}} {{path/to/backup_dir}} {{[-F|--format]}} {{[t|tar]}} {{[-z|--gzip]}}` - Create an incremental backup using a previous manifest file: