Skip to content

Commit d42e720

Browse files
committed
[Issue #171] documentation
1 parent d46e96b commit d42e720

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

doc/pgprobackup.xml

+19-2
Original file line numberDiff line numberDiff line change
@@ -1634,13 +1634,14 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
16341634
<para>
16351635
If you restore <link linkend="pbk-archive-mode">ARCHIVE</link> backups,
16361636
perform <link linkend="pbk-performing-point-in-time-pitr-recovery">PITR</link>,
1637-
or specify the <literal>--restore-as-replica</literal> option with the
1637+
or specify the <literal>--restore-as-replica</literal> flag with the
16381638
<literal>restore</literal> command to set up a standby server,
16391639
<application>pg_probackup</application> creates a recovery configuration
16401640
file once all data files are copied into the target directory. This file
16411641
includes the minimal settings required for recovery, except for the password in the
16421642
<ulink url="https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-CONNINFO">primary_conninfo</ulink>
1643-
parameter; you have to add the password manually, if required.
1643+
parameter; you have to add the password manually or use
1644+
the <literal>--primary-conninfo</literal> option, if required.
16441645
For <productname>PostgreSQL</productname> 11 or lower,
16451646
recovery settings are written into the <filename>recovery.conf</filename>
16461647
file. Starting from <productname>PostgreSQL</productname> 12,
@@ -3584,6 +3585,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
35843585
[-T <replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable>] [--external-mapping=<replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable>] [--skip-external-dirs]
35853586
[-R | --restore-as-replica] [--no-validate] [--skip-block-validation] [--force]
35863587
[--restore-command=<replaceable>cmdline</replaceable>]
3588+
[--primary-conninfo=<replaceable>primary_conninfo</replaceable>]
35873589
[<replaceable>recovery_target_options</replaceable>] [<replaceable>logging_options</replaceable>] [<replaceable>remote_options</replaceable>]
35883590
[<replaceable>partial_restore_options</replaceable>] [<replaceable>remote_wal_archive_options</replaceable>]
35893591
</programlisting>
@@ -3621,6 +3623,21 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
36213623
</listitem>
36223624
</varlistentry>
36233625

3626+
<varlistentry>
3627+
<term><option>--primary-conninfo=<replaceable>primary_conninfo</replaceable></option></term>
3628+
<listitem>
3629+
<para>
3630+
Sets the
3631+
<ulink url="https://postgrespro.com/docs/postgresql/current/runtime-config-replication.html#GUC-PRIMARY-CONNINFO">primary_conninfo</ulink>
3632+
parameter to the specified value.
3633+
This option will be ignored if used without the <option>-R</option> flag.
3634+
</para>
3635+
<para>
3636+
Example: <literal>--primary-conninfo='host=192.168.1.50 port=5432 user=foo password=foopass'</literal>
3637+
</para>
3638+
</listitem>
3639+
</varlistentry>
3640+
36243641
<varlistentry>
36253642
<term><option>-T <replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable></option></term>
36263643
<term><option>--tablespace-mapping=<replaceable>OLDDIR</replaceable>=<replaceable>NEWDIR</replaceable></option></term>

0 commit comments

Comments
 (0)