database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

Make wal streaming the default mode for pg_basebackup

Browse Source 
Since streaming is now supported for all output formats, make this the
default as this is what most people want.

To get the old behavior, the parameter -X none can be specified to turn
it off.

This also removes the parameter -x for fetch, now requiring -X fetch to
be specified to use that.

Reviewed by Vladimir Rusinov, Michael Paquier and Simon Riggs
This commit is contained in:
Magnus Hagander
2017-01-04 10:40:38 +01:00
parent 1d25779284
commit 9a4d51077c
4 changed files with 52 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/src/sgml/ref/pg_basebackup.sgml
View File

@ -56,7 +56,7 @@ PostgreSQL documentation
and <filename>pg_hba.conf</filename> must explicitly permit the replication
connection. The server must also be configured
with <xref linkend="guc-max-wal-senders"> set high enough to leave at least
one session available for the backup.
one session available for the backup and one for WAL streaming (if used).
</para>
<para>
@ -85,10 +85,8 @@ PostgreSQL documentation
</listitem>
<listitem>
<para>
There is no guarantee that all WAL files required for the backup are archived
at the end of backup. If you are planning to use the backup for an archive
recovery and want to ensure that all required files are available at that moment,
you need to include them into the backup by using the <literal>-x</> option.
If you are using <literal>-X none</>, there is no guarantee that all
WAL files required for the backup are archived at the end of backup.
</para>
</listitem>
<listitem>
@ -284,17 +282,6 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option></term>
<term><option>--xlog</option></term>
<listitem>
<para>
Using this option is equivalent of using <literal>-X</literal> with
method <literal>fetch</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-X <replaceable class="parameter">method</replaceable></option></term>
<term><option>--xlog-method=<replaceable class="parameter">method</replaceable></option></term>
@ -302,16 +289,26 @@ PostgreSQL documentation
<para>
Includes the required transaction log files (WAL files) in the
backup. This will include all transaction logs generated during
the backup. If this option is specified, it is possible to start
a postmaster directly in the extracted directory without the need
to consult the log archive, thus making this a completely standalone
backup.
the backup. Unless the method <literal>none</literal> is specified,
it is possible to start a postmaster directly in the extracted
directory without the need to consult the log archive, thus
making this a completely standalone backup.
</para>
<para>
The following methods for collecting the transaction logs are
supported:
<variablelist>
<varlistentry>
<term><literal>n</literal></term>
<term><literal>none</literal></term>
<listitem>
<para>
Don't include transaction log in the backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>f</literal></term>
<term><literal>fetch</literal></term>
@ -349,6 +346,9 @@ PostgreSQL documentation
named <filename>pg_wal.tar</filename> (if the server is a version
earlier than 10, the file will be named <filename>pg_xlog.tar</filename>).
</para>
<para>
This value is the default.
</para>
</listitem>
</varlistentry>
</variablelist>
@ -699,7 +699,7 @@ PostgreSQL documentation
To create a backup of a single-tablespace local database and compress
this with <productname>bzip2</productname>:
<screen>
<prompt>$</prompt> <userinput>pg_basebackup -D - -Ft | bzip2 &gt; backup.tar.bz2</userinput>
<prompt>$</prompt> <userinput>pg_basebackup -D - -Ft -X fetch | bzip2 &gt; backup.tar.bz2</userinput>
</screen>
(This command will fail if there are multiple tablespaces in the
database.)