@@ -2239,7 +2239,7 @@ BACKUP INSTANCE 'node'
2239
2239
<para >
2240
2240
<literal >MERGED</literal > — the backup data files were
2241
2241
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.
2243
2243
</para >
2244
2244
</listitem >
2245
2245
<listitem >
@@ -3169,16 +3169,16 @@ ARCHIVE INSTANCE 'node'
3169
3169
pg_probackup merge -B <replaceable >backup_dir</replaceable > --instance <replaceable >instance_name</replaceable > -i <replaceable >backup_id</replaceable >
3170
3170
</programlisting >
3171
3171
<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
3182
3182
<link linkend =" pbk-remote-backup" >remote</link > mode.
3183
3183
</para >
3184
3184
<para >
@@ -3192,8 +3192,10 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
3192
3192
</programlisting >
3193
3193
<para >
3194
3194
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
3197
3199
restart the merge if it was interrupted.
3198
3200
</para >
3199
3201
</refsect2 >
@@ -3591,9 +3593,11 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> -b <replaceable>bac
3591
3593
<listitem >
3592
3594
<para >
3593
3595
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
3595
3597
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.
3597
3601
</para >
3598
3602
</listitem >
3599
3603
</varlistentry >
@@ -3627,7 +3631,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
3627
3631
[--force] [--no-sync]
3628
3632
[--restore-command=<replaceable >cmdline</replaceable >]
3629
3633
[--primary-conninfo=<replaceable >primary_conninfo</replaceable >]
3630
- [-S | --primary-slot-name=<replaceable >slotname </replaceable >]
3634
+ [-S | --primary-slot-name=<replaceable >slot_name </replaceable >]
3631
3635
[<replaceable >recovery_target_options</replaceable >] [<replaceable >logging_options</replaceable >] [<replaceable >remote_options</replaceable >]
3632
3636
[<replaceable >partial_restore_options</replaceable >] [<replaceable >remote_wal_archive_options</replaceable >]
3633
3637
</programlisting >
@@ -3672,7 +3676,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
3672
3676
Sets the
3673
3677
<ulink url =" https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-CONNINFO" >primary_conninfo</ulink >
3674
3678
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.
3676
3680
</para >
3677
3681
<para >
3678
3682
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
3688
3692
Sets the
3689
3693
<ulink url =" https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-SLOT-NAME" >primary_slot_name</ulink >
3690
3694
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.
3692
3696
</para >
3693
3697
</listitem >
3694
3698
</varlistentry >
@@ -3785,6 +3789,8 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
3785
3789
Do not sync restored files to disk. You can use this flag to speed
3786
3790
up restore process. Using this flag can result in data
3787
3791
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.
3788
3794
</para >
3789
3795
</listitem >
3790
3796
</varlistentry >
@@ -3912,12 +3918,12 @@ pg_probackup merge -B <replaceable>backup_dir</replaceable> --instance <replacea
3912
3918
[<replaceable >logging_options</replaceable >]
3913
3919
</programlisting >
3914
3920
<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.
3921
3927
</para >
3922
3928
<para >
3923
3929
For details, see the section
@@ -3981,24 +3987,25 @@ pg_probackup archive-push -B <replaceable>backup_dir</replaceable> --instance <r
3981
3987
with the <option >--overwrite</option > flag.
3982
3988
</para >
3983
3989
<para >
3984
- Every file is copied to a temporary file with the
3990
+ Each file is copied to a temporary file with the
3985
3991
<literal >.part</literal > suffix. If the temporary file already
3986
3992
exists, <application >pg_probackup</application > will wait
3987
3993
<option >archive_timeout</option > seconds before discarding it.
3988
3994
After the copy is done, atomic rename is performed.
3989
3995
This algorithm ensures that a failed <command >archive-push</command >
3990
3996
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
3992
3998
corruption.
3993
3999
</para >
3994
4000
<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.
3998
4005
</para >
3999
4006
<para >
4000
4007
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.
4002
4009
</para >
4003
4010
<para >
4004
4011
You can use <command >archive-push</command > in the
@@ -4104,7 +4111,7 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
4104
4111
<para >
4105
4112
Sets the number of parallel threads for <command >backup</command >,
4106
4113
<command >restore</command >, <command >merge</command >,
4107
- <command >validate</command >, <command >checkdb</command > and
4114
+ <command >validate</command >, <command >checkdb</command >, and
4108
4115
<command >archive-push</command > processes.
4109
4116
</para >
4110
4117
</listitem >
@@ -4766,11 +4773,11 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
4766
4773
</varlistentry >
4767
4774
4768
4775
<varlistentry >
4769
- <term ><option >--batch-size=batch_size</option ></term >
4776
+ <term ><option >--batch-size=< replaceable > batch_size</ replaceable > </option ></term >
4770
4777
<listitem >
4771
4778
<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.
4774
4781
</para >
4775
4782
</listitem >
4776
4783
</varlistentry >
@@ -4779,7 +4786,9 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
4779
4786
<term ><option >--archive-timeout=<replaceable >wait_time</replaceable ></option ></term >
4780
4787
<listitem >
4781
4788
<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.
4783
4792
</para >
4784
4793
</listitem >
4785
4794
</varlistentry >
@@ -4788,9 +4797,9 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
4788
4797
<term ><option >--no-ready-rename</option ></term >
4789
4798
<listitem >
4790
4799
<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.
4792
4801
This option should be used only if <parameter >archive_command</parameter >
4793
- contain multiple commands.
4802
+ contains multiple commands.
4794
4803
</para >
4795
4804
</listitem >
4796
4805
</varlistentry >
0 commit comments