2017-05-03 13:14:48 +02:00
|
|
|
|
|
|
|
pg_probackup - utility to manage backup/recovery of PostgreSQL database.
|
|
|
|
|
2017-05-17 13:01:57 +02:00
|
|
|
pg_probackup help [COMMAND]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
|
|
|
pg_probackup version
|
|
|
|
|
2017-12-13 10:15:42 +02:00
|
|
|
pg_probackup init -B backup-path
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup set-config -B backup-path --instance=instance_name
|
2019-04-20 14:48:52 +02:00
|
|
|
[-D pgdata-path]
|
|
|
|
[--external-dirs=external-directories-paths]
|
2017-12-13 10:15:42 +02:00
|
|
|
[--log-level-console=log-level-console]
|
|
|
|
[--log-level-file=log-level-file]
|
2017-05-22 13:17:43 +02:00
|
|
|
[--log-filename=log-filename]
|
|
|
|
[--error-log-filename=error-log-filename]
|
|
|
|
[--log-directory=log-directory]
|
|
|
|
[--log-rotation-size=log-rotation-size]
|
|
|
|
[--log-rotation-age=log-rotation-age]
|
|
|
|
[--retention-redundancy=retention-redundancy]
|
2017-05-03 13:14:48 +02:00
|
|
|
[--retention-window=retention-window]
|
2017-06-20 12:57:23 +02:00
|
|
|
[--compress-algorithm=compress-algorithm]
|
|
|
|
[--compress-level=compress-level]
|
2018-09-06 19:46:32 +02:00
|
|
|
[--archive-timeout=timeout]
|
2019-04-20 14:48:52 +02:00
|
|
|
[-d dbname] [-h host] [-p port] [-U username]
|
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup show-config -B backup-path --instance=instance_name
|
2018-07-11 09:50:38 +02:00
|
|
|
[--format=format]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2017-06-20 12:57:23 +02:00
|
|
|
pg_probackup backup -B backup-path -b backup-mode --instance=instance_name
|
2019-04-20 14:48:52 +02:00
|
|
|
[-D pgdata-path] [-C]
|
|
|
|
[--stream [-S slot-name]] [--temp-slot]
|
|
|
|
[--backup-pg-log] [-j num-threads] [--progress]
|
|
|
|
[--no-validate] [--skip-block-validation]
|
|
|
|
[--external-dirs=external-directories-paths]
|
2018-04-11 18:47:19 +02:00
|
|
|
[--log-level-console=log-level-console]
|
|
|
|
[--log-level-file=log-level-file]
|
|
|
|
[--log-filename=log-filename]
|
|
|
|
[--error-log-filename=error-log-filename]
|
|
|
|
[--log-directory=log-directory]
|
|
|
|
[--log-rotation-size=log-rotation-size]
|
|
|
|
[--log-rotation-age=log-rotation-age]
|
2019-04-10 21:31:52 +02:00
|
|
|
[--delete-expired] [--delete-wal] [--merge-expired]
|
2018-04-11 18:47:19 +02:00
|
|
|
[--retention-redundancy=retention-redundancy]
|
|
|
|
[--retention-window=retention-window]
|
2018-01-18 03:35:27 +02:00
|
|
|
[--compress]
|
2017-06-20 12:57:23 +02:00
|
|
|
[--compress-algorithm=compress-algorithm]
|
|
|
|
[--compress-level=compress-level]
|
2019-04-20 14:48:52 +02:00
|
|
|
[--archive-timeout=archive-timeout]
|
2017-05-03 13:14:48 +02:00
|
|
|
[-d dbname] [-h host] [-p port] [-U username]
|
2018-04-11 18:47:19 +02:00
|
|
|
[-w --no-password] [-W --password]
|
2019-04-16 12:34:57 +02:00
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup restore -B backup-path --instance=instance_name
|
2019-04-10 21:31:52 +02:00
|
|
|
[-D pgdata-path] [-i backup-id] [-j num-threads]
|
2019-04-20 14:48:52 +02:00
|
|
|
[--recovery-target-time=time|--recovery-target-xid=xid
|
|
|
|
|--recovery-target-lsn=lsn [--recovery-target-inclusive=boolean]]
|
2019-04-12 13:48:53 +02:00
|
|
|
[--recovery-target-timeline=timeline]
|
|
|
|
[--recovery-target=immediate|latest]
|
|
|
|
[--recovery-target-name=target-name]
|
2018-04-11 18:47:19 +02:00
|
|
|
[--recovery-target-action=pause|promote|shutdown]
|
|
|
|
[--restore-as-replica]
|
2019-04-16 10:33:08 +02:00
|
|
|
[--no-validate] [--skip-block-validation]
|
2019-04-16 09:54:05 +02:00
|
|
|
[-T OLDDIR=NEWDIR] [--progress]
|
|
|
|
[--external-mapping=OLDDIR=NEWDIR]
|
2019-04-10 21:31:52 +02:00
|
|
|
[--skip-external-dirs]
|
2019-04-16 12:34:57 +02:00
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup validate -B backup-path [--instance=instance_name]
|
2019-03-04 18:02:29 +02:00
|
|
|
[-i backup-id] [--progress] [-j num-threads]
|
2019-04-20 14:48:52 +02:00
|
|
|
[--recovery-target-time=time|--recovery-target-xid=xid
|
|
|
|
|--recovery-target-lsn=lsn [--recovery-target-inclusive=boolean]]
|
2019-04-12 13:48:53 +02:00
|
|
|
[--recovery-target-timeline=timeline]
|
2018-07-11 09:50:38 +02:00
|
|
|
[--recovery-target-name=target-name]
|
2018-11-12 11:15:54 +02:00
|
|
|
[--skip-block-validation]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2019-04-20 14:48:52 +02:00
|
|
|
pg_probackup checkdb [-B backup-path] [--instance=instance_name]
|
|
|
|
[-D pgdata-path] [--progress] [-j num-threads]
|
|
|
|
[--amcheck] [--skip-block-validation]
|
|
|
|
[--heapallindexed]
|
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup show -B backup-path
|
2017-06-20 12:57:23 +02:00
|
|
|
[--instance=instance_name [-i backup-id]]
|
2018-07-11 09:50:38 +02:00
|
|
|
[--format=format]
|
2017-05-03 13:14:48 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup delete -B backup-path --instance=instance_name
|
2019-04-10 21:31:52 +02:00
|
|
|
[--wal] [-i backup-id | --expired | --merge-expired]
|
|
|
|
[--dry-run]
|
2016-12-09 20:30:22 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup merge -B backup-path --instance=instance_name
|
2019-04-10 21:31:52 +02:00
|
|
|
-i backup-id [--progress] [-j num-threads]
|
2018-08-02 10:57:39 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup add-instance -B backup-path -D pgdata-path
|
2017-06-20 12:57:23 +02:00
|
|
|
--instance=instance_name
|
2019-04-20 14:48:52 +02:00
|
|
|
[--external-dirs=external-directories-paths]
|
2019-04-16 12:34:57 +02:00
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2017-06-07 16:52:07 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup del-instance -B backup-path
|
2017-06-20 12:57:23 +02:00
|
|
|
--instance=instance_name
|
2017-06-07 16:52:07 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup archive-push -B backup-path --instance=instance_name
|
2018-01-17 19:51:43 +02:00
|
|
|
--wal-file-path=wal-file-path
|
|
|
|
--wal-file-name=wal-file-name
|
2019-04-20 14:48:52 +02:00
|
|
|
[--overwrite]
|
2018-09-06 19:46:32 +02:00
|
|
|
[--compress]
|
|
|
|
[--compress-algorithm=compress-algorithm]
|
|
|
|
[--compress-level=compress-level]
|
2019-04-16 12:34:57 +02:00
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2018-01-17 19:51:43 +02:00
|
|
|
|
2018-09-06 19:46:32 +02:00
|
|
|
pg_probackup archive-get -B backup-path --instance=instance_name
|
2018-01-17 19:51:43 +02:00
|
|
|
--wal-file-path=wal-file-path
|
|
|
|
--wal-file-name=wal-file-name
|
2019-04-16 12:34:57 +02:00
|
|
|
[--remote-proto] [--remote-host]
|
|
|
|
[--remote-port] [--remote-path] [--remote-user]
|
|
|
|
[--ssh-options]
|
2018-01-17 19:51:43 +02:00
|
|
|
|
2016-12-09 20:30:22 +02:00
|
|
|
Read the website for details. <https://github.com/postgrespro/pg_probackup>
|
|
|
|
Report bugs to <https://github.com/postgrespro/pg_probackup/issues>.
|