Skip to content

Commit 2b74971

Browse files
author
Oleg Gurev
committed
[PBCKP-818] Add id's for programlisting section
- to use with automatet listings update
1 parent d29b005 commit 2b74971

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

doc/pgprobackup.xml

+30-30
Original file line numberDiff line numberDiff line change
@@ -529,14 +529,14 @@ doc/src/sgml/pgprobackup.sgml
529529
</step>
530530
<stepid="pbk-init-the-backup-catalog">
531531
<para>Initialize the backup catalog:</para>
532-
<programlisting>
532+
<programlistingid="pbk-init-the-backup-catalog-listing">
533533
backup_user@backup_host:~$ pg_probackup-16 init -B /mnt/backups
534534
INFO: Backup catalog '/mnt/backups' successfully initialized
535535
</programlisting>
536536
</step>
537537
<stepid="pbk-add-instance-to-backup-catalog">
538538
<para>Add a backup instance called <literal>mydb</literal> to the backup catalog:</para>
539-
<programlisting>
539+
<programlistingid="pbk-add-instance-to-backup-catalog-listing">
540540
backup_user@backup_host:~$ pg_probackup-16 add-instance \
541541
-B /mnt/backups \
542542
-D /var/lib/postgresql/16/main \
@@ -548,7 +548,7 @@ INFO: Instance 'mydb' successfully initialized
548548
</step>
549549
<stepid="pbk-make-full-backup">
550550
<para>Make a FULL backup:</para>
551-
<programlisting>
551+
<programlistingid="pbk-make-full-backup-listing">
552552
backup_user@backup_host:~$ pg_probackup-16 backup \
553553
-B /mnt/backups \
554554
-b FULL \
@@ -580,7 +580,7 @@ INFO: Backup S6OBFN completed
580580
</step>
581581
<stepid="pbk-list-backups">
582582
<para>List the backups of the instance:</para>
583-
<programlisting>
583+
<programlistingid="pbk-list-backups-listing">
584584
backup_user@backup_host:~$ pg_probackup-16 show -B /mnt/backups --instance=mydb
585585
================================================================================================================================
586586
Instance Version ID Recovery Time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -590,7 +590,7 @@ backup_user@backup_host:~$ pg_probackup-16 show -B /mnt/backups --instance=mydb
590590
</step>
591591
<stepid="pbk-make-incremental-backup-in-delta-mode">
592592
<para>Make an incremental backup in the DELTA mode:</para>
593-
<programlisting>
593+
<programlistingid="pbk-make-incremental-backup-in-delta-mode-listing">
594594
backup_user@backup_host:~$ pg_probackup-16 backup \
595595
-B /mnt/backups \
596596
-b delta \
@@ -625,7 +625,7 @@ INFO: Backup S6OBLG completed
625625
<stepid="pbk-save-config-parameters">
626626
<para>Add or modify some parameters in the <application>pg_probackup</application>
627627
configuration file, so that you do not have to specify them each time on the command line:</para>
628-
<programlisting>
628+
<programlistingid="pbk-save-config-parameters-listing">
629629
backup_user@backup_host:~$ pg_probackup-16 set-config \
630630
-B /mnt/backups \
631631
--instance=mydb \
@@ -637,7 +637,7 @@ backup_user@backup_host:~$ pg_probackup-16 set-config \
637637
</step>
638638
<stepid="pbk-print-instance-config">
639639
<para>Check the configuration of the instance:</para>
640-
<programlisting>
640+
<programlistingid="pbk-print-instance-config-listing">
641641
backup_user@backup_host:~$ pg_probackup-16 show-config -B /mnt/backups --instance=mydb
642642
# Backup instance information
643643
pgdata = /var/lib/postgresql/16/main
@@ -678,7 +678,7 @@ remote-user = postgres
678678
<stepid="pbk-make-another-incremental-backup-in-delta-mode-using-saved-parameters">
679679
<para>Make another incremental backup in the DELTA mode, omitting
680680
the parameters stored in the configuration file earlier:</para>
681-
<programlisting>
681+
<programlistingid="pbk-make-another-incremental-backup-in-delta-mode-using-saved-parameters-listing">
682682
backup_user@backup_host:~$ pg_probackup-16 backup -B /mnt/backups --instance=mydb -b delta --stream
683683
INFO: Backup start, pg_probackup version: 2.5.13, instance: mydb, backup ID: S6OBQO, backup mode: DELTA, wal mode: STREAM, remote: true, compress-algorithm: none, compress-level: 1
684684
INFO: Database backup start
@@ -704,7 +704,7 @@ INFO: Backup S6OBQO completed
704704
</step>
705705
<stepid="pbk-list-backups-again">
706706
<para>List the backups of the instance again:</para>
707-
<programlisting>
707+
<programlistingid="pbk-list-backups-again-listing">
708708
backup_user@backup_host:~$ pg_probackup-16 show -B /mnt/backups --instance=mydb
709709
==================================================================================================================================
710710
Instance Version ID Recovery Time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -716,7 +716,7 @@ backup_user@backup_host:~$ pg_probackup-16 show -B /mnt/backups --instance=mydb
716716
</step>
717717
<stepid="pbk-quickstart-restore">
718718
<para>Restore the data from the latest available backup to an arbitrary location:</para>
719-
<programlisting>
719+
<programlistingid="pbk-quickstart-restore-listing">
720720
backup_user@backup_host:~$ pg_probackup-16 restore -B /mnt/backups -D /var/lib/postgresql/16/staging --instance=mydb
721721
INFO: Validating parents for backup S6OBQO
722722
INFO: Validating backup S6OBFN
@@ -2110,7 +2110,7 @@ pg_probackup validate -B <replaceable>backup_dir</replaceable> --instance <repla
21102110
from a backup copy with the <literal>PT8XFX</literal> backup ID up to the
21112111
specified timestamp, run this command:
21122112
</para>
2113-
<programlisting>
2113+
<programlistingid="pbk-validating-backups-listing">
21142114
pg_probackup validate -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -i PT8XFX --recovery-target-time="2017-05-18 14:18:11+03"
21152115
</programlisting>
21162116
<para>
@@ -2305,7 +2305,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
23052305
Suppose you want to return an old master as replica after switchover
23062306
using incremental restore in LSN mode:
23072307
</para>
2308-
<programlisting>
2308+
<programlistingid="pbk-incremental-restore-listing">
23092309
=============================================================================================================================================
23102310
Instance Version ID Recovery Time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status
23112311
=============================================================================================================================================
@@ -2788,7 +2788,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable>
27882788
<application>pg_probackup</application> displays the list of all the available backups.
27892789
For example:
27902790
</para>
2791-
<programlisting>
2791+
<programlistingid="pbk-viewing-backup-info-listing-1">
27922792
BACKUP INSTANCE 'node'
27932793
======================================================================================================================================
27942794
Instance Version ID Recovery time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -2952,7 +2952,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
29522952
<para>
29532953
The sample output is as follows:
29542954
</para>
2955-
<programlisting>
2955+
<programlistingid="pbk-viewing-backup-info-listing-2">
29562956
#Configuration
29572957
backup-mode = FULL
29582958
stream = false
@@ -3096,7 +3096,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
30963096
<para>
30973097
The sample output is as follows:
30983098
</para>
3099-
<programlisting>
3099+
<programlistingid="pbk-viewing-backup-info-listing-3">
31003100
[
31013101
{
31023102
"instance": "node",
@@ -3145,7 +3145,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> [--instance <replacea
31453145
<application>pg_probackup</application> displays the list of all the available WAL files
31463146
grouped by timelines. For example:
31473147
</para>
3148-
<programlisting>
3148+
<programlistingid="pbk-viewing-wal-archive-information-listing-1">
31493149
ARCHIVE INSTANCE 'node'
31503150
===================================================================================================================================
31513151
TLI Parent TLI Switchpoint Min Segno Max Segno N segments Size Zratio N backups Status
@@ -3243,7 +3243,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> [--instance <replacea
32433243
<para>
32443244
The sample output is as follows:
32453245
</para>
3246-
<programlisting>
3246+
<programlistingid="pbk-viewing-wal-archive-information-listing-2">
32473247
[
32483248
{
32493249
"instance": "replica",
@@ -3599,7 +3599,7 @@ pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance <replace
35993599
to <literal>7</literal>, and you have the following backups
36003600
available on April 10, 2019:
36013601
</para>
3602-
<programlisting>
3602+
<programlistingid="pbk-retention-policy-listing-1">
36033603
BACKUP INSTANCE 'node'
36043604
===================================================================================================================================
36053605
Instance Version ID Recovery time Mode WAL TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -3613,25 +3613,25 @@ BACKUP INSTANCE 'node'
36133613
node 10 P7XDFT 2019-03-29 05:26:25+03 FULL STREAM 1/0 11s 200MB 16MB 1.0 0/D000028 0/D000198 OK
36143614
</programlisting>
36153615
<para>
3616-
Even though <literal>P7XDHB</literal> and <literal>P7XDHU</literal> backups are outside the
3616+
Even though <literalid="pbk-retention-policy-backup2-1">P7XDHB</literal> and <literalid="pbk-retention-policy-backup3-1">P7XDHU</literal> backups are outside the
36173617
retention window, they cannot be removed as it invalidates the
3618-
succeeding incremental backups <literal>P7XDJA</literal> and <literal>P7XDQV</literal> that are
3618+
succeeding incremental backups <literalid="pbk-retention-policy-backup4-1">P7XDJA</literal> and <literalid="pbk-retention-policy-backup5">P7XDQV</literal> that are
36193619
still required, so, if you run the
36203620
<xreflinkend="pbk-delete"/> command with the
3621-
<option>--delete-expired</option> flag, only the <literal>P7XDFT</literal> full
3621+
<option>--delete-expired</option> flag, only the <literalid="pbk-retention-policy-backup1">P7XDFT</literal> full
36223622
backup will be removed.
36233623
</para>
36243624
<para>
3625-
With the <option>--merge-expired</option> option, the <literal>P7XDJA</literal>
3626-
backup is merged with the underlying <literal>P7XDHU</literal> and <literal>P7XDHB</literal> backups
3625+
With the <option>--merge-expired</option> option, the <literalid="pbk-retention-policy-backup4-2">P7XDJA</literal>
3626+
backup is merged with the underlying <literalid="pbk-retention-policy-backup3-2">P7XDHU</literal> and <literalid="pbk-retention-policy-backup2-2">P7XDHB</literal> backups
36273627
and becomes a full one, so there is no need to keep these
36283628
expired backups anymore:
36293629
</para>
36303630
<programlisting>
36313631
pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance <replaceable>node</replaceable> --delete-expired --merge-expired
36323632
pg_probackup show -B <replaceable>backup_dir</replaceable>
36333633
</programlisting>
3634-
<programlisting>
3634+
<programlistingid="pbk-retention-policy-listing-2">
36353635
BACKUP INSTANCE 'node'
36363636
==================================================================================================================================
36373637
Instance Version ID Recovery time Mode WAL TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -3688,7 +3688,7 @@ pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceab
36883688
<para>
36893689
If the backup is pinned, it has the <literal>expire-time</literal>
36903690
attribute that displays its expiration time:
3691-
<programlisting>
3691+
<programlistingid="pbk-backup-pinning-listing">
36923692
...
36933693
recovery-time = '2017-05-16 12:57:31'
36943694
expire-time = '2020-01-01 00:00:00+03'
@@ -3766,7 +3766,7 @@ pg_probackup set-backup -B <replaceable>backup_dir</replaceable> --instance <rep
37663766
<programlisting>
37673767
pg_probackup show -B <replaceable>backup_dir</replaceable> --instance <replaceable>node</replaceable>
37683768
</programlisting>
3769-
<programlisting>
3769+
<programlistingid="pbk-wal-archive-retention-policy-listing-1">
37703770
BACKUP INSTANCE 'node'
37713771
====================================================================================================================================
37723772
Instance Version ID Recovery Time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status
@@ -3786,7 +3786,7 @@ BACKUP INSTANCE 'node'
37863786
<programlisting>
37873787
pg_probackup show -B <replaceable>backup_dir</replaceable> --instance node --archive
37883788
</programlisting>
3789-
<programlisting>
3789+
<programlistingid="pbk-wal-archive-retention-policy-listing-2">
37903790
ARCHIVE INSTANCE 'node'
37913791
===============================================================================================================================
37923792
TLI Parent TLI Switchpoint Min Segno Max Segno N segments Size Zratio N backups Status
@@ -3800,7 +3800,7 @@ ARCHIVE INSTANCE 'node'
38003800
<programlisting>
38013801
pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance node --delete-wal
38023802
</programlisting>
3803-
<programlisting>
3803+
<programlistingid="pbk-wal-archive-retention-policy-listing-3">
38043804
ARCHIVE INSTANCE 'node'
38053805
===============================================================================================================================
38063806
TLI Parent TLI Switchpoint Min Segno Max Segno N segments Size Zratio N backups Status
@@ -3815,7 +3815,7 @@ ARCHIVE INSTANCE 'node'
38153815
<programlisting>
38163816
pg_probackup delete -B <replaceable>backup_dir</replaceable> --instance node --delete-wal --wal-depth=1
38173817
</programlisting>
3818-
<programlisting>
3818+
<programlistingid="pbk-wal-archive-retention-policy-listing-4">
38193819
ARCHIVE INSTANCE 'node'
38203820
================================================================================================================================
38213821
TLI Parent TLI Switchpoint Min Segno Max Segno N segments Size Zratio N backups Status
@@ -3829,7 +3829,7 @@ ARCHIVE INSTANCE 'node'
38293829
<programlisting>
38303830
pg_probackup backup -B <replaceable>backup_dir</replaceable> --instance node -b DELTA --wal-depth=1 --delete-wal
38313831
</programlisting>
3832-
<programlisting>
3832+
<programlistingid="pbk-wal-archive-retention-policy-listing-5">
38333833
ARCHIVE INSTANCE 'node'
38343834
===============================================================================================================================
38353835
TLI Parent TLI Switchpoint Min Segno Max Segno N segments Size Zratio N backups Status

0 commit comments

Comments
 (0)
close