Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit a4ddadd

Browse filesBrowse files
gsmolkgsmolk
committed
[Issue #355] documentation update
1 parent 82af8f3 commit a4ddadd
Copy full SHA for a4ddadd

File tree

1 file changed

+21
-21
lines changed
Filter options

1 file changed

+21
-21
lines changed

‎doc/pgprobackup.xml

Copy file name to clipboardExpand all lines: doc/pgprobackup.xml
+21-21Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ ALTER ROLE backup WITH REPLICATION;
794794
parameter, as follows:
795795
</para>
796796
<programlisting>
797-
archive_command = '<replaceable>install_dir</replaceable>/pg_probackup archive-push -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --wal-file-name=%f [<replaceable>remote_options</replaceable>]'
797+
archive_command = '"<replaceable>install_dir</replaceable>/pg_probackup" archive-push -B "<replaceable>backup_dir</replaceable>" --instance <replaceable>instance_name</replaceable> --wal-file-name=%f [<replaceable>remote_options</replaceable>]'
798798
</programlisting>
799799
</listitem>
800800
</itemizedlist>
@@ -1588,7 +1588,7 @@ pg_probackup validate -B <replaceable>backup_dir</replaceable> --instance <repla
15881588
specified timestamp, run this command:
15891589
</para>
15901590
<programlisting>
1591-
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'
1591+
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"
15921592
</programlisting>
15931593
<para>
15941594
If you specify the <replaceable>backup_id</replaceable> of an incremental backup,
@@ -1915,7 +1915,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
19151915
timestamp format. For example:
19161916
</para>
19171917
<programlisting>
1918-
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target-time='2017-05-18 14:18:11+03'
1918+
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target-time="2017-05-18 14:18:11+03"
19191919
</programlisting>
19201920
</listitem>
19211921
<listitem>
@@ -1942,7 +1942,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
19421942
point, use <option>--recovery-target-name</option> option:
19431943
</para>
19441944
<programlisting>
1945-
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target-name='before_app_upgrade'
1945+
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target-name="before_app_upgrade"
19461946
</programlisting>
19471947
</listitem>
19481948
<listitem>
@@ -1952,7 +1952,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
19521952
with <literal>latest</literal> value:
19531953
</para>
19541954
<programlisting>
1955-
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target='latest'
1955+
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --recovery-target="latest"
19561956
</programlisting>
19571957
</listitem>
19581958
<listitem>
@@ -2079,14 +2079,14 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
20792079
Provided arguments will be used to construct the <command>restore_command</command>:
20802080
</para>
20812081
<programlisting>
2082-
restore_command = '<replaceable>install_dir</replaceable>/pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --wal-file-path=%p --wal-file-name=%f --remote-host=192.168.0.3 --remote-port=2303 --remote-user=backup'
2082+
restore_command = '"<replaceable>install_dir</replaceable>/pg_probackup" archive-get -B "<replaceable>backup_dir</replaceable>" --instance <replaceable>instance_name</replaceable> --wal-file-path=%p --wal-file-name=%f --remote-host=192.168.0.3 --remote-port=2303 --remote-user=backup'
20832083
</programlisting>
20842084
<para>
20852085
Alternatively, you can use the <option>--restore-command</option>
20862086
option to provide the entire <parameter>restore_command</parameter>:
20872087
</para>
20882088
<programlisting>
2089-
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --remote-user=postgres --remote-host=192.168.0.2 --remote-port=2302 --restore-command='<replaceable>install_dir</replaceable>/pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --wal-file-path=%p --wal-file-name=%f --remote-host=192.168.0.3 --remote-port=2303 --remote-user=backup'
2089+
pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> --remote-user=postgres --remote-host=192.168.0.2 --remote-port=2302 --restore-command='"<replaceable>install_dir</replaceable>/pg_probackup" archive-get -B "<replaceable>backup_dir</replaceable>" --instance <replaceable>instance_name</replaceable> --wal-file-path=%p --wal-file-name=%f --remote-host=192.168.0.3 --remote-port=2303 --remote-user=backup'
20902090
</programlisting>
20912091
<note>
20922092
<para>
@@ -3134,7 +3134,7 @@ pg_probackup set-backup -B <replaceable>backup_dir</replaceable> --instance <rep
31343134
using the <option>--expire-time</option> option. For example:
31353135
</para>
31363136
<programlisting>
3137-
pg_probackup set-backup -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -i <replaceable>backup_id</replaceable> --expire-time='2020-01-01 00:00:00+03'
3137+
pg_probackup set-backup -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -i <replaceable>backup_id</replaceable> --expire-time="2020-01-01 00:00:00+03"
31383138
</programlisting>
31393139
<para>
31403140
Alternatively, you can use the <option>--ttl</option> and
@@ -3144,7 +3144,7 @@ pg_probackup set-backup -B <replaceable>backup_dir</replaceable> --instance <rep
31443144
</para>
31453145
<programlisting>
31463146
pg_probackup backup -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -b FULL --ttl=30d
3147-
pg_probackup backup -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -b FULL --expire-time='2020-01-01 00:00:00+03'
3147+
pg_probackup backup -B <replaceable>backup_dir</replaceable> --instance <replaceable>instance_name</replaceable> -b FULL --expire-time="2020-01-01 00:00:00+03"
31483148
</programlisting>
31493149
<para>
31503150
To check if the backup is pinned,
@@ -3868,7 +3868,7 @@ pg_probackup restore -B <replaceable>backup_dir</replaceable> --instance <replac
38683868
This option will be ignored unless the <option>-R</option> flag is specified.
38693869
</para>
38703870
<para>
3871-
Example: <literal>--primary-conninfo='host=192.168.1.50 port=5432 user=foo password=foopass'</literal>
3871+
Example: <literal>--primary-conninfo="host=192.168.1.50 port=5432 user=foo password=foopass"</literal>
38723872
</para>
38733873
</listitem>
38743874
</varlistentry>
@@ -4469,7 +4469,7 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
44694469
If the time zone offset is not specified, the local time zone is used.
44704470
</para>
44714471
<para>
4472-
Example: <literal>--recovery-target-time='2020-01-01 00:00:00+03'</literal>
4472+
Example: <literal>--recovery-target-time="2020-01-01 00:00:00+03"</literal>
44734473
</para>
44744474
</listitem>
44754475
</varlistentry>
@@ -4659,7 +4659,7 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
46594659
If the time zone offset is not specified, the local time zone is used.
46604660
</para>
46614661
<para>
4662-
Example: <literal>--expire-time='2020-01-01 00:00:00+03'</literal>
4662+
Example: <literal>--expire-time="2020-01-01 00:00:00+03"</literal>
46634663
</para>
46644664
</listitem>
46654665
</varlistentry>
@@ -5202,7 +5202,7 @@ pg_probackup archive-get -B <replaceable>backup_dir</replaceable> --instance <re
52025202
Provides a string of SSH command-line options. For example,
52035203
the following options can be used to set <parameter>keep-alive</parameter> for SSH
52045204
connections opened by <application>pg_probackup</application>:
5205-
<literal>--ssh-options='-o ServerAliveCountMax=5 -o ServerAliveInterval=60'</literal>.
5205+
<literal>--ssh-options="-o ServerAliveCountMax=5 -o ServerAliveInterval=60"</literal>.
52065206
For the full list of possible options, see
52075207
<ulink url="https://man.openbsd.org/ssh_config.5">ssh_config
52085208
manual page</ulink>.
@@ -5555,14 +5555,14 @@ INFO: Backup catalog '/mnt/backups' successfully inited
55555555
<step id="pbk-add-instance-pg-11-to-backup-catalog">
55565556
<title>Add instance <literal>pg-11</literal> to the backup catalog:</title>
55575557
<programlisting>
5558-
[backupman@backup_host]$ pg_probackup-11 add-instance -B /mnt/backups --instance 'pg-11' --remote-host=postgres_host --remote-user=postgres -D /var/lib/postgresql/11/main
5558+
[backupman@backup_host]$ pg_probackup-11 add-instance -B /mnt/backups --instance pg-11 --remote-host=postgres_host --remote-user=postgres -D /var/lib/postgresql/11/main
55595559
INFO: Instance 'node' successfully inited
55605560
</programlisting>
55615561
</step>
55625562
<step id="pbk-take-full-backup">
55635563
<title>Take a FULL backup:</title>
55645564
<programlisting>
5565-
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance 'pg-11' -b FULL --stream --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
5565+
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance pg-11 -b FULL --stream --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
55665566
INFO: Backup start, pg_probackup version: 2.2.0, instance: node, backup ID: PZ7YK2, backup mode: FULL, wal mode: STREAM, remote: true, compress-algorithm: none, compress-level: 1
55675567
INFO: Start transferring data files
55685568
INFO: Data files are transferred
@@ -5577,7 +5577,7 @@ INFO: Backup PZ7YK2 completed
55775577
<step id="pbk-lets-take-a-look-at-the-backup-catalog">
55785578
<title>Let's take a look at the backup catalog:</title>
55795579
<programlisting>
5580-
[backupman@backup_host] pg_probackup-11 show -B /mnt/backups --instance 'pg-11'
5580+
[backupman@backup_host] pg_probackup-11 show -B /mnt/backups --instance pg-11
55815581

55825582
BACKUP INSTANCE 'pg-11'
55835583
==================================================================================================================================
@@ -5589,7 +5589,7 @@ BACKUP INSTANCE 'pg-11'
55895589
<step id="pbk-take-incremental-backup-in-delta-mode">
55905590
<title>Take an incremental backup in the DELTA mode:</title>
55915591
<programlisting>
5592-
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance 'pg-11' -b delta --stream --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
5592+
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance pg-11 -b delta --stream --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
55935593
INFO: Backup start, pg_probackup version: 2.2.0, instance: node, backup ID: PZ7YMP, backup mode: DELTA, wal mode: STREAM, remote: true, compress-algorithm: none, compress-level: 1
55945594
INFO: Parent backup: PZ7YK2
55955595
INFO: Start transferring data files
@@ -5606,14 +5606,14 @@ INFO: Backup PZ7YMP completed
56065606
<title>Let's add some parameters to <application>pg_probackup</application>
56075607
configuration file, so that you can omit them from the command line:</title>
56085608
<programlisting>
5609-
[backupman@backup_host] pg_probackup-11 set-config -B /mnt/backups --instance 'pg-11' --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
5609+
[backupman@backup_host] pg_probackup-11 set-config -B /mnt/backups --instance pg-11 --remote-host=postgres_host --remote-user=postgres -U backup -d backupdb
56105610
</programlisting>
56115611
</step>
56125612
<step id="pbk-take-another-incremental-backup-in-delta-mode-omitting-some-of-the-previous-parameters">
56135613
<title>Take another incremental backup in the DELTA mode, omitting
56145614
some of the previous parameters:</title>
56155615
<programlisting>
5616-
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance 'pg-11' -b delta --stream
5616+
[backupman@backup_host] pg_probackup-11 backup -B /mnt/backups --instance pg-11 -b delta --stream
56175617
INFO: Backup start, pg_probackup version: 2.2.0, instance: node, backup ID: PZ7YR5, backup mode: DELTA, wal mode: STREAM, remote: true, compress-algorithm: none, compress-level: 1
56185618
INFO: Parent backup: PZ7YMP
56195619
INFO: Start transferring data files
@@ -5629,7 +5629,7 @@ INFO: Backup PZ7YR5 completed
56295629
<step id="pbk-lets-take-a-look-at-instance-config">
56305630
<title>Let's take a look at the instance configuration:</title>
56315631
<programlisting>
5632-
[backupman@backup_host] pg_probackup-11 show-config -B /mnt/backups --instance 'pg-11'
5632+
[backupman@backup_host] pg_probackup-11 show-config -B /mnt/backups --instance pg-11
56335633

56345634
# Backup instance information
56355635
pgdata = /var/lib/postgresql/11/main
@@ -5668,7 +5668,7 @@ remote-host = postgres_host
56685668
<step id="pbk-lets-take-a-look-at-the-backup-catalog-1">
56695669
<title>Let's take a look at the backup catalog:</title>
56705670
<programlisting>
5671-
[backupman@backup_host] pg_probackup-11 show -B /mnt/backups --instance 'pg-11'
5671+
[backupman@backup_host] pg_probackup-11 show -B /mnt/backups --instance pg-11
56725672

56735673
====================================================================================================================================
56745674
Instance Version ID Recovery Time Mode WAL Mode TLI Time Data WAL Zratio Start LSN Stop LSN Status

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.