db/pg_probackup
db/pg_probackup
1
0
Fork 0
mirror of https://github.com/postgrespro/pg_probackup.git synced 2025-01-09 14:45:47 +02:00
Code Issues Releases Activity

[Issue #79]: remove partial validate from documentation

Browse Source
This commit is contained in:
Grigory Smolkin 2019-08-31 03:28:42 +03:00
parent d8b8b0898e
commit eb9436bc19
1 changed files with 1 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation.md
View File

@ -29,7 +29,6 @@ Current version - 2.1.5
* [External directories](#external-directories)
* [Verifying a Cluster](#verifying-a-cluster)
* [Validating a Backup](#validating-a-backup)
* [Partial Validation](#partial-validation)
* [Restoring a Cluster](#restoring-a-cluster)
* [Partial Restore](#partial-restore)
* [Performing Point-in-Time (PITR) Recovery](#performing-point-in-time-pitr-recovery)
@ -522,26 +521,6 @@ If *backup_id* belong to incremental backup, then all its parents starting from
If you omit all the parameters, all backups are validated.
#### Partial Validation
If you have enabled [partial restore](#setting-up-partial-restore) before taking backups, you can validate or exclude from validation the arbitraty number of specific databases using [partial restore options](#partial-restore-options) with the [validate](#validate) command.
To validate only one or more databases, run the `validate` command with the following options:
pg_probackup validate -B backup_dir --instance instance_name -i backup_id --db-include=database_name
The option `--db-include` can be specified multiple times. For example, to validate only databases "db1" and "db2", run the following command:
pg_probackup validate -B backup_dir --instance instance_name -i backup_id --db-include=db1 --db-include=db2
To exclude one or more specific databases from validation, run the following options:
pg_probackup validate -B backup_dir --instance instance_name -i backup_id --db-exclude=database_name
The option `--db-exclude` can be specified multiple times. For example, to exclude the databases "db1" and "db2" from validation, run the following command:
pg_probackup validate -B backup_dir --instance instance_name -i backup_id --db-exclude=db1 --db-exclude=db2
### Restoring a Cluster
To restore the database cluster from a backup, run the restore command with at least the following options:
@ -1115,12 +1094,9 @@ For details on usage, see the section [Verifying a Cluster](#verifying-a-cluster
[-j num_threads] [--progress]
[--skip-block-validation]
[recovery_target_options] [logging_options]
[partial_restore_options]
Verifies that all the files required to restore the cluster are present and not corrupted. If *instance_name* is not specified, pg_probackup validates all backups available in the backup catalog. If you specify the *instance_name* without any additional options, pg_probackup validates all the backups available for this backup instance. If you specify the *instance_name* with a [recovery target options](#recovery-target-options) and/or a *backup_id*, pg_probackup checks whether it is possible to restore the cluster using these options.
If you specify the [partial restore options](#partial-restore-options) and a *backup_id*, pg_probackup checks whether it is possible to restore the cluster using these options.
For details, see the section [Validating a Backup](#validating-a-backup).
#### merge
@ -1408,7 +1384,7 @@ Specifies a string of SSH command-line options. For example, the following optio
#### Partial Restore Options
This section describes the options related to partial restore of cluster from backup. These options can be used with [restore](#restore) and [validate](#validate) commands.
This section describes the options related to partial restore of cluster from backup. These options can be used with [restore](#restore) command.
--db-exclude=dbname
Specifies database name to exclude from restore. All other databases in the cluster will be restored as usual, including `template0` and `template1`. This option can be specified multiple times for multiple databases.