Skip to content

Commit 1102e57

Browse files
committed
[Issue #169] Documentation update
1 parent 9d45033 commit 1102e57

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

doc/pgprobackup.xml

+40-4
Original file line numberDiff line numberDiff line change
@@ -2242,6 +2242,13 @@ BACKUP INSTANCE 'node'
22422242
<literal>MERGING</literal> — the backup is being merged.
22432243
</para>
22442244
</listitem>
2245+
<listitem>
2246+
<para>
2247+
<literal>MERGED</literal> — the backup data files were
2248+
successfully merged, but its metadata is in the process
2249+
of been updated. Only full backup can have this status.
2250+
</para>
2251+
</listitem>
22452252
<listitem>
22462253
<para>
22472254
<literal>DELETING</literal> — the backup files are being deleted.
@@ -3146,7 +3153,9 @@ pg_probackup merge -B <replaceable>backup_dir</replaceable> --instance <replacea
31463153
<para>
31473154
This command merges the specified incremental backup to its
31483155
parent full backup, together with all incremental backups
3149-
between them. Once the merge is complete, the incremental
3156+
between them. If the specified backup ID belong to the full backup,
3157+
then it will be merged with the closest incremental backup.
3158+
Once the merge is complete, the incremental
31503159
backups are removed as redundant. Thus, the merge operation is
31513160
virtually equivalent to retaking a full backup and removing all
31523161
the outdated backups, but it allows to save much time,
@@ -3165,7 +3174,8 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
31653174
</programlisting>
31663175
<para>
31673176
If the merge is still in progress, the backup status is
3168-
displayed as <literal>MERGING</literal>. The merge is idempotent, so you can
3177+
displayed as <literal>MERGING</literal> or, at the final stage,
3178+
<literal>MERGED</literal>. The merge is idempotent, so you can
31693179
restart the merge if it was interrupted.
31703180
</para>
31713181
</refsect2>
@@ -3404,6 +3414,7 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> -b <replaceable>bac
34043414
[--no-validate] [--skip-block-validation]
34053415
[-w --no-password] [-W --password]
34063416
[--archive-timeout=<replaceable>timeout</replaceable>] [--external-dirs=<replaceable>external_directory_path</replaceable>]
3417+
[--no-sync]
34073418
[<replaceable>connection_options</replaceable>] [<replaceable>compression_options</replaceable>] [<replaceable>remote_options</replaceable>]
34083419
[<replaceable>retention_options</replaceable>] [<replaceable>pinning_options</replaceable>] [<replaceable>logging_options</replaceable>]
34093420
</programlisting>
@@ -3556,6 +3567,18 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> -b <replaceable>bac
35563567
</para>
35573568
</listitem>
35583569
</varlistentry>
3570+
3571+
<varlistentry>
3572+
<term><option>--no-sync</option></term>
3573+
<listitem>
3574+
<para>
3575+
Do not sync backed up files to disk. You can use this flag to speed
3576+
up backup process. Using this flag can result in data
3577+
corruption in case of operating system or hardware crash.
3578+
Corruption can be detected by backup validation.
3579+
</para>
3580+
</listitem>
3581+
</varlistentry>
35593582
</variablelist>
35603583
</para>
35613584

@@ -3583,7 +3606,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
35833606
[-j <replaceable>num_threads</replaceable>] [--progress]
35843607
[-T <replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable>] [--external-mapping=<replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable>] [--skip-external-dirs]
35853608
[-R | --restore-as-replica] [--no-validate] [--skip-block-validation] [--force]
3586-
[--restore-command=<replaceable>cmdline</replaceable>]
3609+
[--restore-command=<replaceable>cmdline</replaceable>] [--no-sync]
35873610
[<replaceable>recovery_target_options</replaceable>] [<replaceable>logging_options</replaceable>] [<replaceable>remote_options</replaceable>]
35883611
[<replaceable>partial_restore_options</replaceable>] [<replaceable>remote_wal_archive_options</replaceable>]
35893612
</programlisting>
@@ -3705,6 +3728,17 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
37053728
</para>
37063729
</listitem>
37073730
</varlistentry>
3731+
3732+
<varlistentry>
3733+
<term><option>--no-sync</option></term>
3734+
<listitem>
3735+
<para>
3736+
Do not sync restored files to disk. You can use this flag to speed
3737+
up restore process. Using this flag can result in data
3738+
corruption in case of operating system or hardware crash.
3739+
</para>
3740+
</listitem>
3741+
</varlistentry>
37083742
</variablelist>
37093743
</para>
37103744
<para>
@@ -3831,7 +3865,9 @@ pg_probackup merge -B <replaceable>backup_dir</replaceable> --instance <replacea
38313865
<para>
38323866
Merges the specified incremental backup to its parent full
38333867
backup, together with all incremental backups between them, if
3834-
any. As a result, the full backup takes in all the merged
3868+
any. If the specified backup ID belong to the full backup,
3869+
then it will be merged with the closest incremental backup.
3870+
As a result, the full backup takes in all the merged
38353871
data, and the incremental backups are removed as redundant.
38363872
</para>
38373873
<para>

0 commit comments

Comments
 (0)