diff --git a/doc/pgprobackup.xml b/doc/pgprobackup.xml index fe5109e6..269c2f67 100644 --- a/doc/pgprobackup.xml +++ b/doc/pgprobackup.xml @@ -2242,6 +2242,13 @@ BACKUP INSTANCE 'node' MERGING — the backup is being merged. + + + MERGED — the backup data files were + successfully merged, but its metadata is in the process + of been updated. Only full backup can have this status. + + DELETING — the backup files are being deleted. @@ -3146,7 +3153,9 @@ pg_probackup merge -B backup_dir --instance This command merges the specified incremental backup to its parent full backup, together with all incremental backups - between them. Once the merge is complete, the incremental + between them. If the specified backup ID belong to the full backup, + then it will be merged with the closest incremental backup. + Once the merge is complete, the incremental backups are removed as redundant. Thus, the merge operation is virtually equivalent to retaking a full backup and removing all the outdated backups, but it allows to save much time, @@ -3165,7 +3174,8 @@ pg_probackup show -B backup_dir --instance If the merge is still in progress, the backup status is - displayed as MERGING. The merge is idempotent, so you can + displayed as MERGING or, at the final stage, + MERGED. The merge is idempotent, so you can restart the merge if it was interrupted. @@ -3404,6 +3414,7 @@ pg_probackup backup -B backup_dir -b bac [--no-validate] [--skip-block-validation] [-w --no-password] [-W --password] [--archive-timeout=timeout] [--external-dirs=external_directory_path] +[--no-sync] [connection_options] [compression_options] [remote_options] [retention_options] [pinning_options] [logging_options] @@ -3556,6 +3567,18 @@ pg_probackup backup -B backup_dir -b bac + + + + + + Do not sync backed up files to disk. You can use this flag to speed + up backup process. Using this flag can result in data + corruption in case of operating system or hardware crash. + Corruption can be detected by backup validation. + + + @@ -3583,7 +3606,7 @@ pg_probackup restore -B backup_dir --instance num_threads] [--progress] [-T OLDDIR=NEWDIR] [--external-mapping=OLDDIR=NEWDIR] [--skip-external-dirs] [-R | --restore-as-replica] [--no-validate] [--skip-block-validation] [--force] -[--restore-command=cmdline] +[--restore-command=cmdline] [--no-sync] [recovery_target_options] [logging_options] [remote_options] [partial_restore_options] [remote_wal_archive_options] @@ -3705,6 +3728,17 @@ pg_probackup restore -B backup_dir --instance + + + + + + Do not sync restored files to disk. You can use this flag to speed + up restore process. Using this flag can result in data + corruption in case of operating system or hardware crash. + + + @@ -3831,7 +3865,9 @@ pg_probackup merge -B backup_dir --instance Merges the specified incremental backup to its parent full backup, together with all incremental backups between them, if - any. As a result, the full backup takes in all the merged + any. If the specified backup ID belong to the full backup, + then it will be merged with the closest incremental backup. + As a result, the full backup takes in all the merged data, and the incremental backups are removed as redundant.