db/pg_probackup
db/pg_probackup
1
0
Fork 0
mirror of https://github.com/postgrespro/pg_probackup.git synced 2025-04-07 07:19:51 +02:00
Code Issues Releases Activity

Fix and refactor large parts of the documentation

Browse Source 
A couple of issues have been found on the documentation after re-reading
it related mainly to paging.
This commit is contained in:
Michael Paquier 2014-01-12 03:25:54 +09:00
parent d274d27cfc
commit c7b758a93f
1 changed files with 28 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
doc/pg_rman.txt
View File

@ -25,6 +25,7 @@ It takes a physical online backup of whole database cluster, archive
WALs, and server logs. WALs, and server logs.
It proposes the following features: It proposes the following features:
- Backup while database runs including tablespaces with just one - Backup while database runs including tablespaces with just one
command command
- Recovery from backup with just one command, with customized targets - Recovery from backup with just one command, with customized targets
@ -35,8 +36,8 @@ It proposes the following features:
== COMMANDS == == COMMANDS ==
pg_rman supports the following commands. See also Options for details of pg_rman supports the following commands. See also OPTIONS for more
OPTIONS. details.
init:: init::
Initialize a backup catalog. Initialize a backup catalog.
@ -73,10 +74,8 @@ specify it in PGDATA environmental variable or -D/--pgdata option.
Backup target can be one of the following types also serverlogs can be added): Backup target can be one of the following types also serverlogs can be added):
- Full backup, backup a whole database cluster. - Full backup, backup a whole database cluster.
- Incremental backup, backup only files or pages modified after the last - Incremental backup, backup only files or pages modified after the last
verified backup. verified backup.
- Archive WAL backup, Backup only archive WAL files. - Archive WAL backup, Backup only archive WAL files.
It is recommended to verify backup files as soon as possible after backup. It is recommended to verify backup files as soon as possible after backup.
@ -100,7 +99,7 @@ target. If pg_control is not present, TimeLineID in the full backup used by
the restore will be a restore target. the restore will be a restore target.
== Examples == == EXAMPLES ==
To reduce the number of command line arguments, you can set BACKUP_PATH, To reduce the number of command line arguments, you can set BACKUP_PATH,
an environment variable, to the absolute path of the backup catalog and an environment variable, to the absolute path of the backup catalog and
@ -122,12 +121,14 @@ write default configuration into ${BACKUP_PATH}/pg_rman.ini.
This example takes a full backup of the whole database with server logs. This example takes a full backup of the whole database with server logs.
Then, it validates all unvalidated backups. Then, it validates all unvalidated backups.
$ pg_rman backup --backup-mode=full --with-serverlog $ pg_rman backup --backup-mode=full --with-serverlog
$ pg_rman validate $ pg_rman validate
=== RESTORE FROM A BACKUP === === RESTORE FROM A BACKUP ===
Here are some commands to restore from a backup: Here are some commands to restore from a backup:
$ pg_ctl stop -m immediate $ pg_ctl stop -m immediate
$ pg_rman restore $ pg_rman restore
$ pg_ctl start $ pg_ctl start
@ -143,27 +144,24 @@ Here are some commands to restore from a backup:
2013-12-25 03:02:25 FULL 1 0 0m 33MB 33MB ---- 64MB OK 2013-12-25 03:02:25 FULL 1 0 0m 33MB 33MB ---- 64MB OK
The fields are: The fields are:
- Start : start time of backup
- Mode: Mode of backup * Start: start time of backup
-- FULL for a full backup * Mode: Mode of backup: FULL (full), INCR (incremental) or ARCH (archive)
-- INCR for an incremental backup * Current TLI: current timeline of backup
-- ARCH for archive backup * Parent TLI: parent timeline of backup
- Current TLI: current timeline of backup * Time: total time necessary to take this backup
- Parent TLI: parent timeline of backup * Data: size of data files
- Time : total time necessary to take this backup * WAL: size of read WAL archive files
- Total : Total size of backup * Log: size of read server log files
- Data : size of data files * Backup: size of backup (= written size)
- WAL : size of read WAL archive files * Status: status of backup. Possible values are:
- Log : size of read server log files - OK : backup is done and validated.
- Backup: size of backup (= written size) - DONE : backup is done, but not validated yet.
- Status: status of backup. Possible values are: - RUNNING : backup is running
-- OK : backup is done and validated. - DELETING : backup is being deleted.
-- DONE : backup is done, but not validated yet. - DELETED : backup has been deleted.
-- RUNNING : backup is running - ERROR : backup is unavailable because some errors occur during backup.
-- DELETING : backup is being deleted. - CORRUPT : backup is unavailable because it is broken.
-- DELETED : backup has been deleted.
-- ERROR : backup is unavailable because some errors occur during backup.
-- CORRUPT : backup is unavailable because it is broken.
When a date is specified, more details about a backup is retrieved: When a date is specified, more details about a backup is retrieved:
@ -196,7 +194,7 @@ the specified date.
== OPTIONS == == OPTIONS ==
pg_rman accepts the following command line parameters. Some of them can pg_rman accepts the following command line parameters. Some of them can
be also sepcified as environment variables. See also Parameters for the be also sepcified as environment variables. See also PARAMETERS for the
details. details.
=== COMMON OPTIONS === === COMMON OPTIONS ===
@ -228,16 +226,12 @@ absolute paths; relative paths are not allowed.
=== BACKUP OPTIONS === === BACKUP OPTIONS ===
-b { full | incremental | archive } --backup-mode={ full | incremental | archive }:: -b { full | incremental | archive } / --backup-mode={ full | incremental | archive }::
Specify backup target files. Available options are: "full" backup, Specify backup target files. Available options are: "full" backup,
"incremental" backup, and "archive" backup. Abbreviated forms "incremental" backup, and "archive" backup. Abbreviated forms
(prefix match) are also available. For example, -b f means "full" (prefix match) are also available. For example, -b f means "full"
backup. backup.
full : Whole database backup and archive backup
incremental : Incremental backup and archive backup
archive : Only archive backup
-s / --with-serverlog:: -s / --with-serverlog::
Backup server log files if specified. Backup server log files if specified.
@ -438,7 +432,7 @@ pg_rman returns exit codes for each error status.
26 ERROR_PID_BROKEN postmaster.pid is broken 26 ERROR_PID_BROKEN postmaster.pid is broken
== AUTHOR == == AUTHOR ==
pg_rman was originally written by NTT, and maintained in some way by Michael pg_rman was originally written by NTT, mainly Itagaki Takahiro, and maintained
Paquier. in some way by Michael Paquier.
Please report bug reports at <https://github.com/michaelpq/pg_rman>. Please report bug reports at <https://github.com/michaelpq/pg_rman>.