1- #pg_arman(1)
1+ % PG_ARMAN(1)
2+ % Michael Paquier, Yury Zhuravlev
3+ % June 2016
24
3- ## NAME
5+ #NAME
46
57pg_arman - Backup and recovery manager for PostgreSQL
68
7- ## SYNOPSIS
9+ #SYNOPSIS
810```
911pg_arman [ OPTIONS ]
1012 { init |
@@ -19,7 +21,7 @@ DATE is the start time of the target backup in ISO-format:
1921(YYYY-MM-DD HH:MI: SS ). Prefix match is used to compare DATE and backup
2022files.
2123
22- ## DESCRIPTION
24+ #DESCRIPTION
2325
2426pg_arman is a utility program to backup and restore PostgreSQL database.
2527
@@ -32,7 +34,7 @@ It proposes the following features:
3234- Support for full and differential backup + ptrack differential backup
3335- Management of backups with integrated catalog
3436
35- ## COMMANDS
37+ #COMMANDS
3638
3739pg_arman supports the following commands. See also** OPTIONS** for more
3840details.
@@ -55,7 +57,7 @@ details.
5557* ** delete** :
5658Delete backup files.
5759
58- ### INITIALIZATION
60+ ##INITIALIZATION
5961
6062First, you need to create "a backup catalog" to store backup files and
6163their metadata. It is recommended to setup archive_mode and archive_command
@@ -68,7 +70,7 @@ specify it in PGDATA environmental variable or -D/--pgdata option.
6870$ pg_arman init -B /path/to/backup/
6971```
7072
71- ### BACKUP
73+ ##BACKUP
7274
7375Backup target can be one of the following types:
7476
@@ -85,7 +87,7 @@ For use it you need set ptrack_enable option to "on".
8587It is recommended to verify backup files as soon as possible after backup.
8688Unverified backup cannot be used in restore and in differential backups.
8789
88- ### RESTORE
90+ ##RESTORE
8991
9092PostgreSQL server should be stopped before performing a restore. If database
9193cluster still exists, restore command will save unarchived transaction log
@@ -103,7 +105,7 @@ target. If pg_control is not present, TimeLineID in the full backup used by
103105the restore will be a restore target.
104106
105107
106- ### EXAMPLES
108+ ##EXAMPLES
107109
108110To reduce the number of command line arguments, you can set BACKUP_PATH,
109111an environment variable, to the absolute path of the backup catalog and
@@ -117,7 +119,7 @@ KEEP_DATA_GENERATIONS = 3
117119KEEP_DATA_DAYS = 120
118120```
119121
120- ### TAKE A BACKUP
122+ ##TAKE A BACKUP
121123
122124This example takes a full backup of the whole database. Then, it validates
123125all unvalidated backups.
@@ -126,7 +128,7 @@ $ pg_arman backup --backup-mode=full
126128$ pg_arman validate
127129```
128130
129- ### RESTORE FROM A BACKUP
131+ ##RESTORE FROM A BACKUP
130132
131133Here are some commands to restore from a backup:
132134
@@ -136,7 +138,7 @@ $ pg_arman restore
136138$ pg_ctl start
137139```
138140
139- ### SHOW A BACKUP
141+ ##SHOW A BACKUP
140142```
141143$ pg_arman show
142144===================================================================================
@@ -193,13 +195,13 @@ the specified date. This command also cleans up in the WAL archive the
193195WAL segments that are no longer needed to restore from the remaining
194196backups.
195197
196- ### OPTIONS
198+ ##OPTIONS
197199
198200pg_arman accepts the following command line parameters. Some of them can
199201be also specified as environment variables. See also* PARAMETERS* for the
200202details.
201203
202- ### COMMON OPTIONS
204+ ##COMMON OPTIONS
203205As a general rule, paths for data location need to be specified as
204206absolute paths; relative paths are not allowed.
205207
@@ -219,7 +221,7 @@ absolute paths; relative paths are not allowed.
219221 parameters and required resources. The option is typically used with
220222 --verbose option to verify the operation.
221223
222- ### BACKUP OPTIONS
224+ ##BACKUP OPTIONS
223225
224226** -b** BACKUPMODE /** --backup-mode** =BACKUPMODE:
225227 Specify backup target files. Available options are: "full",
@@ -246,7 +248,7 @@ absolute paths; relative paths are not allowed.
246248** --stream** :
247249 Enable stream replication for save WAL during backup process.
248250
249- ### RESTORE OPTIONS
251+ ##RESTORE OPTIONS
250252
251253The parameters whose name start are started with --recovery refer to
252254the same parameters as the ones in recovery.confin recovery.conf.
@@ -274,12 +276,13 @@ the same parameters as the ones in recovery.confin recovery.conf.
274276 backup with** --stream** option. This option will disable all** --recovery-**
275277 options.
276278
277- ### CATALOG OPTIONS
279+ ##CATALOG OPTIONS
278280
279281** -a** /** --show-all** :
280282 Show all existing backups, including the deleted ones.
281283
282- ###CONNECTION OPTIONS
284+ ##CONNECTION OPTIONS
285+
283286Parameters to connect PostgreSQL server.
284287
285288** -d** DBNAME /** --dbname** =DBNAME:
@@ -312,7 +315,7 @@ Parameters to connect PostgreSQL server.
312315 if the server wants a password. In some cases it is worth typing -W
313316 to avoid the extra connection attempt.
314317
315- ### GLOBAL OPTIONS
318+ ##GLOBAL OPTIONS
316319
317320** --help** :
318321 Print help, then exit.
@@ -323,7 +326,7 @@ Parameters to connect PostgreSQL server.
323326** -v** /** --verbose** :
324327 If specified, pg_arman works in verbose mode.
325328
326- ## PARAMETERS
329+ #PARAMETERS
327330
328331Some of parameters can be specified as command line arguments, environment
329332variables or in configuration file as follows:
@@ -357,7 +360,7 @@ line and configuration file for security reason.
357360This utility, like most other PostgreSQL utilities, also uses the
358361environment variables supported by libpq (see Environment Variables).
359362
360- ## RESTRICTIONS
363+ #RESTRICTIONS
361364
362365pg_arman has the following restrictions.
363366
@@ -370,29 +373,29 @@ pg_arman has the following restrictions.
370373 WAL directory or archived WAL directory, the backup or restore will fail
371374 depending on the backup mode selected.
372375
373- ## DETAILS
376+ #DETAILS
374377
375- ### RECOVERY TO POINT-IN-TIME
378+ ##RECOVERY TO POINT-IN-TIME
376379pg_arman can recover to point-in-time if timeline, transaction ID, or
377380timestamp is specified in recovery.conf. xlogdump is a contrib module of
378381PostgreSQL core that allows checking in the content of WAL files and
379382determine when to recover. This might help.
380383
381- ### CONFIGURATION FILE
384+ ##CONFIGURATION FILE
382385Setting parameters in configuration file is done as "name=value". Quotes
383386are required if the value contains whitespaces. Comments should start with
384387"#" and are automatically ignored. Whitespaces and tabs are ignored
385388excluding values.
386389
387- ### RESTRICTIONS
390+ ##RESTRICTIONS
388391* In order to work, the PostgreSQL instance on which backups are taken need
389392to have data checksums enabled or to enable wal_log_hints.
390393* pg_arman is aimed at working with PostgreSQL 9.5 and newer versions.
391394* For ptrack feature you need special version of Postgres and set wal_level to
392395archive or hot_standby and ptrack_enable.
393396* For stream feature you need configure streaming replication in your postgres.
394397
395- ### EXIT CODE
398+ ##EXIT CODE
396399pg_arman returns exit codes for each error status.
397400
398401```
@@ -403,7 +406,7 @@ Code Name Description
4034063 PANIC Unknown critical condition
404407```
405408
406- ## AUTHOR ##
409+ #AUTHORS
407410pg_arman is a fork of pg_arman that was originally written by NTT, now
408411developed and maintained by Michael Paquier.
409412Threads, WAL diff, ptrack diff, stream WAL and some other features developed by