Skip to content

Commit 84ad9d4

Browse files
author
Liudmila Mantrova
committed
DOC: fix grammar in new content
1 parent 3b2d152 commit 84ad9d4

File tree

1 file changed

+46
-37
lines changed

1 file changed

+46
-37
lines changed

doc/pgprobackup.xml

Lines changed: 46 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2239,7 +2239,7 @@ BACKUP INSTANCE 'node'
22392239
<para>
22402240
<literal>MERGED</literal> — the backup data files were
22412241
successfully merged, but its metadata is in the process
2242-
of been updated. Only full backup can have this status.
2242+
of being updated. Only full backups can have this status.
22432243
</para>
22442244
</listitem>
22452245
<listitem>
@@ -3169,16 +3169,16 @@ ARCHIVE INSTANCE 'node'
31693169
pg_probackup merge -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -i <replaceable>backup_id</replaceable>
31703170
</programlisting>
31713171
<para>
3172-
This command merges the specified incremental backup to its
3173-
parent full backup, together with all incremental backups
3174-
between them. If the specified backup ID belong to the full backup,
3175-
then it will be merged with the closest incremental backup.
3176-
Once the merge is complete, the incremental
3177-
backups are removed as redundant. Thus, the merge operation is
3178-
virtually equivalent to retaking a full backup and removing all
3179-
the outdated backups, but it allows to save much time,
3180-
especially for large data volumes, as well as I/O and network traffic
3181-
if you are using <application>pg_probackup</application> in the
3172+
This command merges backups that belong to a common incremental backup
3173+
chain. If you specify a full backup, it will be merged with its first
3174+
incremental backup. If you specify an incremental backup, it will be
3175+
merged to its parent full backup, together with all incremental backups
3176+
between them. Once the merge is complete, the full backup takes in all
3177+
the merged data, and the incremental backups are removed as redundant.
3178+
Thus, the merge operation is virtually equivalent to retaking a full
3179+
backup and removing all the outdated backups, but it allows to save much
3180+
time, especially for large data volumes, as well as I/O and network
3181+
traffic if you are using <application>pg_probackup</application> in the
31823182
<link linkend="pbk-remote-backup">remote</link> mode.
31833183
</para>
31843184
<para>
@@ -3192,8 +3192,10 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
31923192
</programlisting>
31933193
<para>
31943194
If the merge is still in progress, the backup status is
3195-
displayed as <literal>MERGING</literal> or, at the final stage,
3196-
<literal>MERGED</literal>. The merge is idempotent, so you can
3195+
displayed as <literal>MERGING</literal>. For full backups,
3196+
it can also be shown as <literal>MERGED</literal> while the
3197+
metadata is being updated at the final stage of the merge.
3198+
The merge is idempotent, so you can
31973199
restart the merge if it was interrupted.
31983200
</para>
31993201
</refsect2>
@@ -3591,9 +3593,11 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> -b <replaceable>bac
35913593
<listitem>
35923594
<para>
35933595
Do not sync backed up files to disk. You can use this flag to speed
3594-
up backup process. Using this flag can result in data
3596+
up the backup process. Using this flag can result in data
35953597
corruption in case of operating system or hardware crash.
3596-
Corruption can be detected by backup validation.
3598+
If you use this option, it is recommended to run the
3599+
<xref linkend="pbk-validate"/> command once the backup is complete
3600+
to detect possible issues.
35973601
</para>
35983602
</listitem>
35993603
</varlistentry>
@@ -3627,7 +3631,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
36273631
[--force] [--no-sync]
36283632
[--restore-command=<replaceable>cmdline</replaceable>]
36293633
[--primary-conninfo=<replaceable>primary_conninfo</replaceable>]
3630-
[-S | --primary-slot-name=<replaceable>slotname</replaceable>]
3634+
[-S | --primary-slot-name=<replaceable>slot_name</replaceable>]
36313635
[<replaceable>recovery_target_options</replaceable>] [<replaceable>logging_options</replaceable>] [<replaceable>remote_options</replaceable>]
36323636
[<replaceable>partial_restore_options</replaceable>] [<replaceable>remote_wal_archive_options</replaceable>]
36333637
</programlisting>
@@ -3672,7 +3676,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
36723676
Sets the
36733677
<ulink url="https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-CONNINFO">primary_conninfo</ulink>
36743678
parameter to the specified value.
3675-
This option will be ignored unless the <option>-R</option> flag if specified.
3679+
This option will be ignored unless the <option>-R</option> flag is specified.
36763680
</para>
36773681
<para>
36783682
Example: <literal>--primary-conninfo='host=192.168.1.50 port=5432 user=foo password=foopass'</literal>
@@ -3688,7 +3692,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
36883692
Sets the
36893693
<ulink url="https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-SLOT-NAME">primary_slot_name</ulink>
36903694
parameter to the specified value.
3691-
This option will be ignored unless the <option>-R</option> flag if specified.
3695+
This option will be ignored unless the <option>-R</option> flag is specified.
36923696
</para>
36933697
</listitem>
36943698
</varlistentry>
@@ -3785,6 +3789,8 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
37853789
Do not sync restored files to disk. You can use this flag to speed
37863790
up restore process. Using this flag can result in data
37873791
corruption in case of operating system or hardware crash.
3792+
If it happens, you have to run the <xref linkend="pbk-restore"/>
3793+
command again.
37883794
</para>
37893795
</listitem>
37903796
</varlistentry>
@@ -3912,12 +3918,12 @@ pg_probackup merge -B <replaceable>backup_dir</replaceable> --instance <replacea
39123918
[<replaceable>logging_options</replaceable>]
39133919
</programlisting>
39143920
<para>
3915-
Merges the specified incremental backup to its parent full
3916-
backup, together with all incremental backups between them, if
3917-
any. If the specified backup ID belong to the full backup,
3918-
then it will be merged with the closest incremental backup.
3919-
As a result, the full backup takes in all the merged
3920-
data, and the incremental backups are removed as redundant.
3921+
Merges backups that belong to a common incremental backup
3922+
chain. If you specify a full backup, it will be merged with its first
3923+
incremental backup. If you specify an incremental backup, it will be
3924+
merged to its parent full backup, together with all incremental backups
3925+
between them. Once the merge is complete, the full backup takes in all
3926+
the merged data, and the incremental backups are removed as redundant.
39213927
</para>
39223928
<para>
39233929
For details, see the section
@@ -3981,24 +3987,25 @@ pg_probackup archive-push -B <replaceable>backup_dir</replaceable> --instance <r
39813987
with the <option>--overwrite</option> flag.
39823988
</para>
39833989
<para>
3984-
Every file is copied to a temporary file with the
3990+
Each file is copied to a temporary file with the
39853991
<literal>.part</literal> suffix. If the temporary file already
39863992
exists, <application>pg_probackup</application> will wait
39873993
<option>archive_timeout</option> seconds before discarding it.
39883994
After the copy is done, atomic rename is performed.
39893995
This algorithm ensures that a failed <command>archive-push</command>
39903996
will not stall continuous archiving and that concurrent archiving from
3991-
multiple sources into a single WAL archive have no risk of archive
3997+
multiple sources into a single WAL archive has no risk of archive
39923998
corruption.
39933999
</para>
39944000
<para>
3995-
To speed up archiving, especially in remote mode, <command>archive-push</command>
3996-
can be run on multiple threads using <option>-j num_threads</option> option.
3997-
Files can also be copied in batches using option <option>--batch-size</option>.
4001+
To speed up archiving, you can specify the <option>-j</option> option
4002+
to run <command>archive-push</command> on multiple threads.
4003+
If you provide the <option>--batch-size</option> option, WAL files
4004+
will be copied in batches of the specified size.
39984005
</para>
39994006
<para>
40004007
WAL segments copied to the archive are synced to disk unless
4001-
<option>--no-sync</option> flag is used.
4008+
the <option>--no-sync</option> flag is used.
40024009
</para>
40034010
<para>
40044011
You can use <command>archive-push</command> in the
@@ -4104,7 +4111,7 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
41044111
<para>
41054112
Sets the number of parallel threads for <command>backup</command>,
41064113
<command>restore</command>, <command>merge</command>,
4107-
<command>validate</command>, <command>checkdb</command> and
4114+
<command>validate</command>, <command>checkdb</command>, and
41084115
<command>archive-push</command> processes.
41094116
</para>
41104117
</listitem>
@@ -4766,11 +4773,11 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
47664773
</varlistentry>
47674774

47684775
<varlistentry>
4769-
<term><option>--batch-size=batch_size</option></term>
4776+
<term><option>--batch-size=<replaceable>batch_size</replaceable></option></term>
47704777
<listitem>
47714778
<para>
4772-
Sets the maximum number of files to be copied into archive by signle
4773-
<command>archive-push</command> process.
4779+
Sets the maximum number of files that can be copied into the archive
4780+
by a single <command>archive-push</command> process.
47744781
</para>
47754782
</listitem>
47764783
</varlistentry>
@@ -4779,7 +4786,9 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
47794786
<term><option>--archive-timeout=<replaceable>wait_time</replaceable></option></term>
47804787
<listitem>
47814788
<para>
4782-
Sets the timeout for considering existing <literal>.part</literal> file to be stale. By default <application>pg_probackup</application> waits 300 seconds.
4789+
Sets the timeout for considering existing <literal>.part</literal>
4790+
files to be stale. By default, <application>pg_probackup</application>
4791+
waits 300 seconds.
47834792
</para>
47844793
</listitem>
47854794
</varlistentry>
@@ -4788,9 +4797,9 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
47884797
<term><option>--no-ready-rename</option></term>
47894798
<listitem>
47904799
<para>
4791-
Do not rename status files in <literal>archive_status</literal> directory.
4800+
Do not rename status files in the <literal>archive_status</literal> directory.
47924801
This option should be used only if <parameter>archive_command</parameter>
4793-
contain multiple commands.
4802+
contains multiple commands.
47944803
</para>
47954804
</listitem>
47964805
</varlistentry>

0 commit comments

Comments
 (0)