You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/pg_probackup.md
+17-15
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ pg_probackup — backup and recovery manager for PostgreSQL.
6
6
```
7
7
pg_probackup [option...] init
8
8
pg_probackup [option...] backup
9
-
pg_probackup [option...] restore [backup_ID]
10
-
pg_probackup [option...] validate [backup_ID]
11
-
pg_probackup [option...] show [backup_ID]
12
-
pg_probackup [option...] delete backup_ID
13
-
pg_probackup [option...] delwal [backup_ID]
14
-
pg_probackup [option...] retention show|purge
9
+
pg_probackup [option...] restore [backup_ID]
10
+
pg_probackup [option...] validate [backup_ID]
11
+
pg_probackup [option...] show [backup_ID]
12
+
pg_probackup [option...] delete backup_ID
13
+
pg_probackup [option...] delwal [backup_ID]
14
+
pg_probackup [option...] retention show|purge
15
15
```
16
16
17
17
## Description
@@ -41,6 +41,10 @@ The same backup directory can be used simultaneously by several PostgreSQL serve
41
41
configured between them. Backups can be made from either primary or standby server, and managed in a
42
42
single backup strategy.
43
43
44
+
`pg_probackup` can restore data files from user tablespaces to their original directories
45
+
using symbolic links and `tablespace_map` file. You can change path to this directories
46
+
during restore using [`tablespace-mapping`](#restore-options) option.
47
+
44
48
## Usage
45
49
46
50
### Initial setup
@@ -299,20 +303,19 @@ A backup can be used to restore primary database server as well as standby. It d
299
303
300
304
It is possible to configure the backup retention policy. The retention policy
301
305
specifies specifies which backups must be kept to meet data recoverability
302
-
requirements. The policy can be configured using two parameters: redundancy and
303
-
window.
306
+
requirements. The policy can be configured using two parameters: `redundancy` and
307
+
`window`.
304
308
305
309
Redundancy parameter specifies how many full backups purge command should keep.
306
310
For example, you make a full backup on Sunday and an incremental backup every day.
307
311
If redundancy is 1, then this backup will become obsolete on next Sunday and will
308
312
be deleted with all its incremental backups when next full backup will be created.
309
313
310
-
Window parameter specifies the number of days of data recoverability. If window
311
-
is 14, then all full backups older than 14 days will be deleted with their
312
-
incremental backups.
314
+
Window parameter specifies the number of days of data recoverability. That is,
315
+
the earliest time to which you can recover your data.
313
316
314
317
This parameters can be used together. Backups are obsolete if they don't
315
-
meet both parameters. For example, you have retention is 1, window is 14 and
318
+
meet both parameters. For example, you have retention is 2, window is 14 and
316
319
two full backups are made 3 and 7 days ago. In this situation both backups aren't
317
320
obsolete and will be kept 14 days.
318
321
@@ -321,7 +324,7 @@ To delete obsolete backups execute the following command:
321
324
pg_probackup retention purge
322
325
```
323
326
Redundancy and window parameters values will be taken from command line options
324
-
or from pg_probackup.conf configuration file.
327
+
or from `pg_probackup.conf` configuration file.
325
328
326
329
## Additional Features
327
330
@@ -509,7 +512,6 @@ Currently pg\_probackup has the following restrictions:
509
512
* PostgreSQL 9.5 or higher versions are supported.
510
513
* Windows operating system is not supported.
511
514
* Incremental backups in PTRACK mode can be taken only on Postgres Pro server.
512
-
* Data files from user tablespaces are restored to the same absolute paths as they were during backup.
513
515
* Configuration files outside PostgreSQL data directory are not included in backup and should be backed up separately.
514
516
* Only full backups are supported when using [compressed tablespaces](https://postgrespro.com/docs/postgresproee/current/cfs.html) (Postgres Pro Enterprise feature).
515
517
@@ -525,4 +527,4 @@ pg\_probackup utility is based on pg\_arman, that was originally written by NTT
525
527
526
528
Features like parallel execution, incremental and autonomous backups are developed in Postgres Professional by Yury Zhuravlev (aka stalkerg).
527
529
528
-
Please report bugs and requests at https://github.com/postgrespro/pg\_probackup/issues .
530
+
Please report bugs and requests at https://github.com/postgrespro/pg_probackup/issues .
0 commit comments