Skip to content

Commit 7e59a19

Browse files
committed
[DOC] {PBCKP-320] Remove duplicate descriptions of backup/catchup modes [skip-travis]
1 parent 3b2efe6 commit 7e59a19

File tree

1 file changed

+23
-98
lines changed

1 file changed

+23
-98
lines changed

doc/pgprobackup.xml

Lines changed: 23 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ doc/src/sgml/pgprobackup.sgml
312312
</para>
313313
<itemizedlist spacing="compact">
314314
<listitem>
315-
<para>
315+
<para id="pbk-modes-full">
316316
FULL backups contain all the data files required to restore
317317
the database cluster.
318318
</para>
@@ -328,7 +328,7 @@ doc/src/sgml/pgprobackup.sgml
328328
</para>
329329
<itemizedlist spacing="compact">
330330
<listitem>
331-
<para>
331+
<para id="pbk-modes-delta">
332332
DELTA backup. In this mode, <application>pg_probackup</application> reads all data
333333
files in the data directory and copies only those pages
334334
that have changed since the previous backup. This
@@ -337,7 +337,7 @@ doc/src/sgml/pgprobackup.sgml
337337
</para>
338338
</listitem>
339339
<listitem>
340-
<para>
340+
<para id="pbk-modes-page">
341341
PAGE backup. In this mode, <application>pg_probackup</application> scans all WAL
342342
files in the archive from the moment the previous full or
343343
incremental backup was taken. Newly created backups
@@ -352,7 +352,7 @@ doc/src/sgml/pgprobackup.sgml
352352
</para>
353353
</listitem>
354354
<listitem>
355-
<para>
355+
<para id="pbk-modes-ptrack">
356356
PTRACK backup. In this mode, <productname>PostgreSQL</productname> tracks page
357357
changes on the fly. Continuous archiving is not necessary
358358
for it to operate. Each time a relation page is updated,
@@ -443,7 +443,7 @@ doc/src/sgml/pgprobackup.sgml
443443
parameters and have the same major release number.
444444
Depending on cluster configuration, <productname>PostgreSQL</productname> itself may
445445
apply additional restrictions, such as CPU architecture
446-
or <application>libc</application>/<application>libicu</application> versions.
446+
or <application>libc</application>/<application>icu</application> versions.
447447
</para>
448448
</listitem>
449449
</itemizedlist>
@@ -1274,36 +1274,11 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> --instance <replace
12741274
<para>
12751275
Where <replaceable>backup_mode</replaceable> can take one of the
12761276
following values:
1277+
<literal><link linkend="pbk-modes-full">FULL</link></literal>,
1278+
<literal><link linkend="pbk-modes-delta">DELTA</link></literal>,
1279+
<literal><link linkend="pbk-modes-page">PAGE</link></literal>, and
1280+
<literal><link linkend="pbk-modes-ptrack">PTRACK</link></literal>.
12771281
</para>
1278-
<itemizedlist spacing="compact">
1279-
<listitem>
1280-
<para>
1281-
FULL — creates a full backup that contains all the data
1282-
files of the cluster to be restored.
1283-
</para>
1284-
</listitem>
1285-
<listitem>
1286-
<para>
1287-
DELTA — reads all data files in the data directory and
1288-
creates an incremental backup for pages that have changed
1289-
since the previous backup.
1290-
</para>
1291-
</listitem>
1292-
<listitem>
1293-
<para>
1294-
PAGE — creates an incremental backup based on the WAL
1295-
files that have been generated since the previous full or
1296-
incremental backup was taken. Only changed blocks are read
1297-
from data files.
1298-
</para>
1299-
</listitem>
1300-
<listitem>
1301-
<para>
1302-
PTRACK — creates an incremental backup tracking page
1303-
changes on the fly.
1304-
</para>
1305-
</listitem>
1306-
</itemizedlist>
13071282
<para>
13081283
When restoring a cluster from an incremental backup,
13091284
<application>pg_probackup</application> relies on the parent full backup and all the
@@ -3532,25 +3507,25 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable> --source-pgdata=
35323507
</programlisting>
35333508
<para>
35343509
Where <replaceable>catchup_mode</replaceable> can take one of the
3535-
following values: <literal>FULL</literal>, <literal>DELTA</literal>, or <literal>PTRACK</literal>.
3510+
following values:
35363511
</para>
35373512
<itemizedlist spacing="compact">
35383513
<listitem>
3539-
<para>
3540-
FULL — creates a full copy of the <productname>PostgreSQL</productname> instance.
3514+
<para id="pbk-catchup-modes-full">
3515+
<literal>FULL</literal> — creates a full copy of the <productname>PostgreSQL</productname> instance.
35413516
The data directory of the destination instance must be empty for this mode.
35423517
</para>
35433518
</listitem>
35443519
<listitem>
3545-
<para>
3546-
DELTA — reads all data files in the data directory and
3520+
<para id="pbk-catchup-modes-delta">
3521+
<literal>DELTA</literal> — reads all data files in the data directory and
35473522
creates an incremental copy for pages that have changed
35483523
since the destination instance was shut down.
35493524
</para>
35503525
</listitem>
35513526
<listitem>
3552-
<para>
3553-
PTRACK — tracking page changes on the fly,
3527+
<para id="pbk-catchup-modes-ptrack">
3528+
<literal>PTRACK</literal> — tracking page changes on the fly,
35543529
only reads and copies pages that have changed since the point of divergence
35553530
of the source and destination instances.
35563531
<warning>
@@ -3817,35 +3792,10 @@ pg_probackup backup -B <replaceable>backup_dir</replaceable> -b <replaceable>bac
38173792
<listitem>
38183793
<para>
38193794
Specifies the backup mode to use. Possible values are:
3820-
3821-
<itemizedlist spacing="compact">
3822-
<listitem>
3823-
<para>
3824-
<literal>FULL</literal> — creates a full backup that contains all the data
3825-
files of the cluster to be restored.
3826-
</para>
3827-
</listitem>
3828-
<listitem>
3829-
<para>
3830-
<literal>DELTA</literal> — reads all data files in the data directory and
3831-
creates an incremental backup for pages that have changed
3832-
since the previous backup.
3833-
</para>
3834-
</listitem>
3835-
<listitem>
3836-
<para>
3837-
<literal>PAGE</literal> — creates an incremental PAGE backup based on the WAL
3838-
files that have changed since the previous full or
3839-
incremental backup was taken.
3840-
</para>
3841-
</listitem>
3842-
<listitem>
3843-
<para>
3844-
<literal>PTRACK</literal> — creates an incremental PTRACK backup tracking
3845-
page changes on the fly.
3846-
</para>
3847-
</listitem>
3848-
</itemizedlist>
3795+
<literal><link linkend="pbk-modes-full">FULL</link></literal>,
3796+
<literal><link linkend="pbk-modes-delta">DELTA</link></literal>,
3797+
<literal><link linkend="pbk-modes-page">PAGE</link></literal>, and
3798+
<literal><link linkend="pbk-modes-ptrack">PTRACK</link></literal>.
38493799
</para>
38503800
</listitem>
38513801
</varlistentry>
@@ -4540,34 +4490,9 @@ pg_probackup catchup -b <replaceable>catchup_mode</replaceable>
45404490
<listitem>
45414491
<para>
45424492
Specifies the catchup mode to use. Possible values are:
4543-
4544-
<itemizedlist spacing="compact">
4545-
<listitem>
4546-
<para>
4547-
<literal>FULL</literal> — creates a full copy of the <productname>PostgreSQL</productname> instance.
4548-
</para>
4549-
</listitem>
4550-
<listitem>
4551-
<para>
4552-
<literal>DELTA</literal> — reads all data files in the data directory and
4553-
creates an incremental copy for pages that have changed
4554-
since the destination instance was shut down.
4555-
</para>
4556-
</listitem>
4557-
<listitem>
4558-
<para>
4559-
<literal>PTRACK</literal> — tracking page changes on the fly,
4560-
only reads and copies pages that have changed since the point of divergence
4561-
of the source and destination instances.
4562-
<warning>
4563-
<para>
4564-
PTRACK catchup mode requires <application>PTRACK</application>
4565-
not earlier than 2.0 and hence, <productname>PostgreSQL</productname> not earlier than 11.
4566-
</para>
4567-
</warning>
4568-
</para>
4569-
</listitem>
4570-
</itemizedlist>
4493+
<literal><link linkend="pbk-catchup-modes-full">FULL</link></literal>,
4494+
<literal><link linkend="pbk-catchup-modes-delta">DELTA</link></literal>, and
4495+
<literal><link linkend="pbk-catchup-modes-ptrack">PTRACK</link></literal>.
45714496
</para>
45724497
</listitem>
45734498
</varlistentry>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy