To manage backup data, <application>pg_probackup</application> creates a

special <emphasis>backup catalog</emphasis>. This directory

stores all backup files with additional meta information, as

well as <acronym>WAL</acronym> archives required for point-in-time recovery. To avoid

well as <acronym>WAL</acronym> archives required for<link linkend="continuous-archiving">point-in-time recovery</link>. To avoid

conflicts, <application>pg_probackup</application> does not allow storing

backups for different clusters in a single backup catalog.

</para>

</listitem>

</itemizedlist>

<para>

The backup catalog mustbe accessible from the file

The backup catalog mustbelong to the file

system of the database server. The user launching

<application>pg_probackup</application> must have full access to the

contents of the backup catalog. If you specify the path to the

<listitem>

<para>

Create the <literal>backup</literal> role with the

<link linkend="role-attributes"><literal>REPLICATION</literal>privilege</link>.

<link linkend="role-attributes"><literal>LOGIN</literal> and <literal>REPLICATION</literal>privileges</link>.

</para>

<programlisting>

CREATE ROLE backup WITH LOGIN REPLICATION;

<itemizedlist spacing="compact">

<listitem>

<para>

Make sure the <literal>max_wal_senders</literal>

Make sure the <varname>max_wal_senders</varname>

parameter is set high enough to leave at least one

session available for the backup process.

</para>

</listitem>

<listitem>

<para>

Set the <literal>wal_level</literal> parameter to be

Set the <varname>wal_level</varname> parameter to be

<literal>replica</literal> or higher.

</para>

</listitem>

<listitem>

<para>

Set <literal>archive_mode</literal> to

<literal>'on'</literal>.

<literal>on</literal>.

</para>

</listitem>

<listitem>

<para>

Set <literal>archive_command</literal> to

<literal>'test ! -fbackup\_dir/wal/%f &amp;&amp; cp %pbackup\_dir/wal/%f';</literal>

where <literal>backup_dir</literal> is the initialized

Set <varname>archive_command</varname> to

<literal>test ! -fbackup_dir/wal/%f &amp;&amp; cp %pbackup_dir/wal/%f</literal>

where <replaceable>backup_dir</replaceable> is the initialized

backup catalog.

</para>

</listitem>

<itemizedlist spacing="compact">

<listitem>

<para>

Set the <literal>max_wal_senders</literal> and

<literal>hot_standby</literal> parameters in

Set the <varname>max_wal_senders</varname> and

<varname>hot_standby</varname> parameters in

<filename>postgresql.conf</filename>.

</para>

</listitem>

<listitem>

<para>

On the master server, enable

<literal>full_page_writes</literal> in

<varname>full_page_writes</varname> in

<filename>postgresql.conf</filename>.

</para>

</listitem>

<listitem>

<para>All <acronym>WAL</acronym> records required

for the backup must contain sufficient full-page writes. This

requires you to enable <literal>full_page_writes</literal> on

requires you to enable <varname>full_page_writes</varname> on

the master, and not to use a tool like

<literal>pg_compresslog</literal> as

<literal>archive_command</literal> to remove full-page writes

<application>pg_compresslog</application> as

<varname>archive_command</varname> to remove full-page writes

from <acronym>WAL</acronym> files.

</para>

</listitem>

<listitem>

<para>

In <filename>postgresql.conf</filename>, set

<literal>ptrack_enable</literal> to <literal>'on'</literal>.

<varname>ptrack_enable</varname> to <literal>on</literal>.

</para>

</listitem>

<listitem>

[-C] [--stream [-S <replaceable>slot-name</replaceable>]] [--backup-pg-log]

-archive-timeout=<replaceable>timeout</replaceable>] [--delete-expired]

[-d <replaceable>dbname</replaceable>] [-h <replaceable>host</replaceable>] [-p <replaceable>port</replaceable>] [-U <replaceable>username</replaceable>] [-w]

[-j <replaceable>num-threads</replaceable>][--progress] [-q] [-v]

[-j <replaceable>num_threads</replaceable>][--progress] [-q] [-v]

</programlisting>

<para>

Creates a backup copy of the <productname>&productname;</productname> instance.

pg_probackup restore -B <replaceable>backupdir</replaceable>

[-D <replaceable>datadir</replaceable>]

[ -i <replaceable>backup_id</replaceable> | [{--time=<replaceable>time</replaceable> | --xid=<replaceable>xid</replaceable> } [--inclusive=<replaceable>boolean</replaceable>]]][--timeline=<replaceable>timeline</replaceable>] [-T OLDDIR=<replaceable>NEWDIR</replaceable>]

[-j <replaceable>num-threads</replaceable>] [--progress] [-q] [-v]

[-j <replaceable>num_threads</replaceable>] [--progress] [-q] [-v]

</programlisting>

<para>

Restores the <productname>&productname;</productname> instance from a backup copy

[-D <replaceable>datadir</replaceable>]

[ -i <replaceable>backup_id</replaceable> | [{--time=<replaceable>time</replaceable> | --xid=<replaceable>xid</replaceable> } [--inclusive=<replaceable>boolean</replaceable>]]]

[--timeline=<replaceable>timeline</replaceable>]

[-j <replaceable>num-threads</replaceable>] [--progress] [-q] [-v]

[-j <replaceable>num_threads</replaceable>] [--progress] [-q] [-v]

</programlisting>

<para>

Verifies that all files in the backup are present and not corrupted.

Deletes the specified backup files from the <replaceable>backupdir</replaceable> backup catalog:

<itemizedlist spacing="compact">

<listitem>

<para>The <option>backup-id</option> option removes the specified backup copy.

<para>The <option>-i</option> option removes the specified backup copy.

</para>

</listitem>

<listitem>

pg_probackup version

</programlisting>

<para>

Shows the current version of<application>pg_probackup</application>.

Prints<application>pg_probackup</application> version.

</para>

</listitem>

</varlistentry>

Autonomous backups include all the <acronym>WAL</acronym> segments required to restore the

cluster to a consistent state at the time the backup was taken. To restore a cluster

from an incremental autonomous backup, <application>pg_probackup</application> still

requiresa full backup and all theprevious incrementedbackups.

requiresthe full backup and all theincrementalbackups it depends on.

</para>

<para>

</para>

<para>For example, to check that you can restore the

database cluster from a backup copy up to the specified

<literal>xid</literal> transaction ID, run this command:

<replaceable>xid</replaceable> transaction ID, run this command:

</para>

<programlisting>

pg_probackup validate --xid=xid

pg_probackup validate --xid=<replaceable>xid</replaceable>

</programlisting>

<para>

If validation completes successfully,

<xref linkend="recovery-target-inclusive"> parameter defines whether the recovery

target is included into the backup. You can explicitly include or

exclude the recovery target using the

<option>--inclusive='<replaceable>boolean</replaceable>'</option> option.

<option>--inclusive=<replaceable>boolean</replaceable></option> option.

</para>

<para>

To restore the cluster state at the exact time, specify the

tablespaces. For example:

</para>

<programlisting>

pg_probackup restore -D <replaceable>datadir</replaceable> -j 4 -i <replaceable>backup_id</replaceable> -T <replaceable>/tmp/tblspc1</replaceable>=<replaceable>/tmp/tblspc1_new</replaceable> -T <replaceable>/tmp/tblspc2</replaceable>=<replaceable>/tmp/tblspc2_new</replaceable>

pg_probackup restore -D <replaceable>datadir</replaceable> -j 4 -i <replaceable>backup_id</replaceable> -T <replaceable>/tmp/tablespace1</replaceable>=<replaceable>/tmp/tablespace1_new</replaceable> -T <replaceable>/tmp/tablespace2</replaceable>=<replaceable>/tmp/tablespace2_new</replaceable>

</programlisting>

<para>

Once the <literal>restore</literal> command is complete, start the

command line option. For example, to create a backup using four parallel threads, run:

<programlisting>

pg_probackup backup -b full -j 4

</programlisting>

</programlisting>

</para>

<note>

<link linkend="pg-probackup-retention-opts">retention options</link> using the

<xref linkend="pg-probackup-set-config"> command:</para>

<programlisting>

pg_probackup set-config -B <replaceable>backupdir</replaceable> [<replaceable>connection-options</replaceable>] [<replaceable>retention-options</replaceable>]

pg_probackup set-config -B <replaceable>backupdir</replaceable> [<replaceable>connection_options</replaceable>] [<replaceable>retention_options</replaceable>]

</programlisting>

<para>where:

<itemizedlist spacing="compact">

<listitem>

<para><replaceable>connection-options</replaceable> are:

<para><replaceable>connection_options</replaceable> are:

[-d <replaceable>dbname</replaceable>] [-h <replaceable>host</replaceable>] [-p <replaceable>port</replaceable>] [-U <replaceable>username</replaceable>]

</para>

</listitem>

<listitem>

<para><replaceable>retention-options</replaceable> are:

<para><replaceable>retention_options</replaceable> are:

[--retention-redundancy=<replaceable>redundancy</replaceable>]

[--retention-window=<replaceable>window</replaceable>]

</para>

<itemizedlist spacing="compact">

<listitem><para>

<option>retention-redundancy</option> &mdash; specifies the number of full backup

copies to keep in thedata directory.</para>

copies to keep in thebackup catalog.</para>

</listitem>

<listitem><para><option>retention-window</option> &mdash; defines the earliest point in time for which <application>pg_probackup</application> can complete the recovery. This option is set in the number of days from the current moment. For example, if <option>window</option>=7, <application>pg_probackup</application> must keep at least one full backup copy that is older than seven days, with all the corresponding <acronym>WAL</acronym> files.</para></listitem>

<listitem><para><option>retention-window</option> &mdash; defines the earliest point in time for which <application>pg_probackup</application> can complete the recovery. This option is set in the number of days from the current moment. For example, if <option>retention-window</option>=7, <application>pg_probackup</application> must keep at least one full backup copy that is older than seven days, with all the corresponding <acronym>WAL</acronym> files.</para></listitem>

</itemizedlist>

<para>If both <option>retention-redundancy</option> and <option>retention-window</option>

options are set, <application>pg_probackup</application> keeps backup copies

that satisfy both conditions. For example, if you set <option>redundancy</option>=2 and <option>window</option>=7, <application>pg_probackup</application> cleans up the backup directory to keep only two full backup copies if at least one of them is older than seven days.

that satisfy both conditions. For example, if you set <option>retention-redundancy</option>=2 and <option>retention-window</option>=7, <application>pg_probackup</application> cleans up the backup directory to keep only two full backup copies if at least one of them is older than seven days.

</para>

<para>

To clean up the backup catalog in accordance with retention policy, run:

Alternatively, you can configure backup retention policy

and use the <literal>--delete-expired</literal>

option together with the <literal>backup</literal> command to

remove the outdated backupcopy once the new backup is created.</para>

remove the outdated backupcopies once the new backup is created.</para>

</refsect2>

</refsect1>

</para>

</listitem>

<listitem>

<para>Time &mdash; the time it took topeform the backup.

<para>Time &mdash; the time it took toperform the backup.

</para>

</listitem>

<listitem>

To get more detailed information about the backup, run the <command>show</command> with the backup ID:

</para>

<programlisting>

pg_probackup show -i <replaceable>backup_id</replaceable>

pg_probackup show -i <replaceable>backup_id</replaceable>

</programlisting>

<para>

The sample output is as follows:

command:

</para>

<programlisting>

pg_probackup delete -ibackup-id

pg_probackup delete -i<replaceable>backup_id</replaceable>

</programlisting>

<para>

This command will delete the backup with the specified

</para>

<note>

<para>

In this case the next <literal>PTRACK</literal> backup will not be correct as some

changes since the last retained backup will be lost. Either FULL

backup or incremental PAGE backup (given that all necessary WAL

In this case, the next <literal>PTRACK</literal> backup will be incomplete as some

changes since the last retained backup will be lost. Either a full

backup or an incremental <literal>PAGE</literal> backup

(if all the necessary <acronym>WAL</acronym>

files are still present in the archive) must be taken then.

</para>

</note>

of the remaining backups, use the <literal>--wal</literal> option:

</para>

<programlisting>

pg_probackup delete --wal

pg_probackup delete --wal

</programlisting>

<para>

To delete backups that are expired according to the current

retention policy, use the

<literal>--expired</literal> option:

</para>

<programlisting>

pg_probackup delete --expired

pg_probackup delete --expired

</programlisting>

<para>For details, see <xref linkend="pg-probackup-retention-policy">.</para>

</refsect2>