2011-01-23 12:21:23 +01:00
|
|
|
<!--
|
|
|
|
doc/src/sgml/ref/pg_basebackup.sgml
|
|
|
|
PostgreSQL documentation
|
|
|
|
-->
|
|
|
|
|
|
|
|
<refentry id="app-pgbasebackup">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="app-pgbasebackup">
|
|
|
|
<primary>pg_basebackup</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<refmeta>
|
2020-07-10 16:51:29 +02:00
|
|
|
<refentrytitle><application>pg_basebackup</application></refentrytitle>
|
2011-01-23 12:21:23 +01:00
|
|
|
<manvolnum>1</manvolnum>
|
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>pg_basebackup</refname>
|
|
|
|
<refpurpose>take a base backup of a <productname>PostgreSQL</productname> cluster</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<cmdsynopsis>
|
|
|
|
<command>pg_basebackup</command>
|
2017-10-09 03:44:17 +02:00
|
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
2011-01-23 12:21:23 +01:00
|
|
|
</cmdsynopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
2020-06-07 13:10:18 +02:00
|
|
|
<title>Description</title>
|
2011-01-23 12:21:23 +01:00
|
|
|
<para>
|
|
|
|
<application>pg_basebackup</application> is used to take base backups of
|
|
|
|
a running <productname>PostgreSQL</productname> database cluster. These
|
|
|
|
are taken without affecting other clients to the database, and can be used
|
2017-11-23 15:39:47 +01:00
|
|
|
both for point-in-time recovery (see <xref linkend="continuous-archiving"/>)
|
2011-01-23 12:21:23 +01:00
|
|
|
and as the starting point for a log shipping or streaming replication standby
|
2017-11-23 15:39:47 +01:00
|
|
|
servers (see <xref linkend="warm-standby"/>).
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>pg_basebackup</application> makes a binary copy of the database
|
2014-03-25 11:16:57 +01:00
|
|
|
cluster files, while making sure the system is put in and
|
2011-01-23 12:21:23 +01:00
|
|
|
out of backup mode automatically. Backups are always taken of the entire
|
2014-03-25 11:16:57 +01:00
|
|
|
database cluster; it is not possible to back up individual databases or
|
2011-01-23 12:21:23 +01:00
|
|
|
database objects. For individual database backups, a tool such as
|
2017-11-23 15:39:47 +01:00
|
|
|
<xref linkend="app-pgdump"/> must be used.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The backup is made over a regular <productname>PostgreSQL</productname>
|
2012-01-14 17:22:16 +01:00
|
|
|
connection, and uses the replication protocol. The connection must be made
|
2020-05-05 07:16:01 +02:00
|
|
|
with a user having <literal>REPLICATION</literal> permissions
|
|
|
|
(see <xref linkend="role-attributes"/>) or a superuser,
|
2012-01-14 17:22:16 +01:00
|
|
|
and <filename>pg_hba.conf</filename> must explicitly permit the replication
|
|
|
|
connection. The server must also be configured
|
2017-11-23 15:39:47 +01:00
|
|
|
with <xref linkend="guc-max-wal-senders"/> set high enough to leave at least
|
2017-01-04 10:40:38 +01:00
|
|
|
one session available for the backup and one for WAL streaming (if used).
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2011-05-19 00:14:45 +02:00
|
|
|
There can be multiple <command>pg_basebackup</command>s running at the same time, but it is
|
2011-01-31 17:13:01 +01:00
|
|
|
better from a performance point of view to take only one backup, and copy
|
2011-01-31 21:51:51 +01:00
|
|
|
the result.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
2012-01-25 19:02:04 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>pg_basebackup</application> can make a base backup from
|
2020-06-15 19:12:58 +02:00
|
|
|
not only the primary but also the standby. To take a backup from the standby,
|
2012-01-25 19:02:04 +01:00
|
|
|
set up the standby so that it can accept replication connections (that is, set
|
2017-11-23 15:39:47 +01:00
|
|
|
<varname>max_wal_senders</varname> and <xref linkend="guc-hot-standby"/>,
|
2012-01-25 19:02:04 +01:00
|
|
|
and configure <link linkend="auth-pg-hba-conf">host-based authentication</link>).
|
2020-06-15 19:12:58 +02:00
|
|
|
You will also need to enable <xref linkend="guc-full-page-writes"/> on the primary.
|
2012-01-25 19:02:04 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Note that there are some limitations in an online backup from the standby:
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The backup history file is not created in the database cluster backed up.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
If you are using <literal>-X none</literal>, there is no guarantee that all
|
2017-01-04 10:40:38 +01:00
|
|
|
WAL files required for the backup are archived at the end of backup.
|
2012-01-25 19:02:04 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-06-15 19:12:58 +02:00
|
|
|
If the standby is promoted to the primary during online backup, the backup fails.
|
2012-01-25 19:02:04 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
All WAL records required for the backup must contain sufficient full-page writes,
|
2020-06-15 19:12:58 +02:00
|
|
|
which requires you to enable <varname>full_page_writes</varname> on the primary and
|
2017-10-09 03:44:17 +02:00
|
|
|
not to use a tool like <application>pg_compresslog</application> as
|
|
|
|
<varname>archive_command</varname> to remove full-page writes from WAL files.
|
2012-01-25 19:02:04 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
</para>
|
2020-03-03 04:03:43 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
Whenever <application>pg_basebackup</application> is taking a base
|
|
|
|
backup, the <structname>pg_stat_progress_basebackup</structname>
|
|
|
|
view will report the progress of the backup.
|
|
|
|
See <xref linkend="basebackup-progress-reporting"/> for details.
|
|
|
|
</para>
|
2011-01-23 12:21:23 +01:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The following command-line options control the location and format of the
|
|
|
|
output.
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-D <replaceable class="parameter">directory</replaceable></option></term>
|
|
|
|
<term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Directory to write the output to.
|
2012-07-25 21:00:00 +02:00
|
|
|
<application>pg_basebackup</application> will create the directory and
|
|
|
|
any parent directories if necessary. The directory may already exist,
|
|
|
|
but it is an error if the directory already exists and is not empty.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
When the backup is in tar mode, and the directory is specified as
|
|
|
|
<literal>-</literal> (dash), the tar file will be written to
|
|
|
|
<literal>stdout</literal>.
|
|
|
|
</para>
|
|
|
|
<para>
|
2012-05-20 00:15:55 +02:00
|
|
|
This option is required.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-F <replaceable class="parameter">format</replaceable></option></term>
|
|
|
|
<term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Selects the format for the output. <replaceable>format</replaceable>
|
|
|
|
can be one of the following:
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>p</literal></term>
|
|
|
|
<term><literal>plain</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Write the output as plain files, with the same layout as the
|
|
|
|
current data directory and tablespaces. When the cluster has
|
|
|
|
no additional tablespaces, the whole database will be placed in
|
|
|
|
the target directory. If the cluster contains additional
|
|
|
|
tablespaces, the main data directory will be placed in the
|
|
|
|
target directory, but all other tablespaces will be placed
|
|
|
|
in the same absolute path as they have on the server.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
This is the default format.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>t</literal></term>
|
|
|
|
<term><literal>tar</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Write the output as tar files in the target directory. The main
|
|
|
|
data directory will be written to a file named
|
|
|
|
<filename>base.tar</filename>, and all other tablespaces will
|
2011-05-19 00:14:45 +02:00
|
|
|
be named after the tablespace OID.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
If the value <literal>-</literal> (dash) is specified as
|
|
|
|
target directory, the tar contents will be written to
|
|
|
|
standard output, suitable for piping to for example
|
|
|
|
<productname>gzip</productname>. This is only possible if
|
2017-05-12 17:49:56 +02:00
|
|
|
the cluster has no additional tablespaces and WAL
|
|
|
|
streaming is not used.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2011-08-07 09:49:45 +02:00
|
|
|
</variablelist></para>
|
2011-01-23 12:21:23 +01:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-02-27 22:55:57 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-r <replaceable class="parameter">rate</replaceable></option></term>
|
|
|
|
<term><option>--max-rate=<replaceable class="parameter">rate</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The maximum transfer rate of data transferred from the server. Values are
|
2017-10-09 03:44:17 +02:00
|
|
|
in kilobytes per second. Use a suffix of <literal>M</literal> to indicate megabytes
|
|
|
|
per second. A suffix of <literal>k</literal> is also accepted, and has no effect.
|
2014-02-27 22:55:57 +01:00
|
|
|
Valid values are between 32 kilobytes per second and 1024 megabytes per second.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
The purpose is to limit the impact of <application>pg_basebackup</application>
|
|
|
|
on the running server.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
This option always affects transfer of the data directory. Transfer of
|
|
|
|
WAL files is only affected if the collection method is <literal>fetch</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2013-01-05 16:54:06 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-R</option></term>
|
|
|
|
<term><option>--write-recovery-conf</option></term>
|
|
|
|
<listitem>
|
|
|
|
|
|
|
|
<para>
|
2018-11-25 16:31:16 +01:00
|
|
|
Create <filename>standby.signal</filename> and append connection settings
|
|
|
|
to <filename>postgresql.auto.conf</filename> in the output
|
2015-07-22 03:06:45 +02:00
|
|
|
directory (or into the base archive file when using tar format) to
|
|
|
|
ease setting up a standby server.
|
2018-11-25 16:31:16 +01:00
|
|
|
The <filename>postgresql.auto.conf</filename> file will record the connection
|
2015-07-22 03:06:45 +02:00
|
|
|
settings and, if specified, the replication slot
|
|
|
|
that <application>pg_basebackup</application> is using, so that the
|
|
|
|
streaming replication will use the same settings later on.
|
2013-01-05 16:54:06 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2014-02-22 19:38:06 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-T <replaceable class="parameter">olddir</replaceable>=<replaceable class="parameter">newdir</replaceable></option></term>
|
|
|
|
<term><option>--tablespace-mapping=<replaceable class="parameter">olddir</replaceable>=<replaceable class="parameter">newdir</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Relocate the tablespace in directory <replaceable>olddir</replaceable>
|
|
|
|
to <replaceable>newdir</replaceable> during the backup. To be
|
|
|
|
effective, <replaceable>olddir</replaceable> must exactly match the
|
|
|
|
path specification of the tablespace as it is currently defined. (But
|
|
|
|
it is not an error if there is no tablespace
|
|
|
|
in <replaceable>olddir</replaceable> contained in the backup.)
|
|
|
|
Both <replaceable>olddir</replaceable>
|
|
|
|
and <replaceable>newdir</replaceable> must be absolute paths. If a
|
|
|
|
path happens to contain a <literal>=</literal> sign, escape it with a
|
|
|
|
backslash. This option can be specified multiple times for multiple
|
|
|
|
tablespaces. See examples below.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
If a tablespace is relocated in this way, the symbolic links inside
|
|
|
|
the main data directory are updated to point to the new location. So
|
|
|
|
the new data directory is ready to be used for a new server instance
|
|
|
|
with all tablespaces in the updated locations.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2013-11-27 06:00:16 +01:00
|
|
|
<varlistentry>
|
2017-02-09 22:42:51 +01:00
|
|
|
<term><option>--waldir=<replaceable class="parameter">waldir</replaceable></option></term>
|
2013-11-27 06:00:16 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
Specifies the location for the write-ahead log directory.
|
2017-02-09 22:42:51 +01:00
|
|
|
<replaceable>waldir</replaceable> must be an absolute path.
|
2017-05-12 17:49:56 +02:00
|
|
|
The write-ahead log directory can only be specified when
|
2013-11-27 06:00:16 +01:00
|
|
|
the backup is in plain mode.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-30 21:30:09 +01:00
|
|
|
<varlistentry>
|
2012-06-10 13:43:51 +02:00
|
|
|
<term><option>-X <replaceable class="parameter">method</replaceable></option></term>
|
2017-02-09 22:42:51 +01:00
|
|
|
<term><option>--wal-method=<replaceable class="parameter">method</replaceable></option></term>
|
2011-01-30 21:30:09 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
Includes the required write-ahead log files (WAL files) in the
|
|
|
|
backup. This will include all write-ahead logs generated during
|
2017-01-04 10:40:38 +01:00
|
|
|
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.
|
2011-01-30 21:30:09 +01:00
|
|
|
</para>
|
2011-10-26 20:13:33 +02:00
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
The following methods for collecting the write-ahead logs are
|
2011-10-26 20:13:33 +02:00
|
|
|
supported:
|
|
|
|
|
|
|
|
<variablelist>
|
2017-01-04 10:40:38 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>n</literal></term>
|
|
|
|
<term><literal>none</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
Don't include write-ahead log in the backup.
|
2017-01-04 10:40:38 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-10-26 20:13:33 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>f</literal></term>
|
|
|
|
<term><literal>fetch</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
The write-ahead log files are collected at the end of the backup.
|
2011-10-26 20:13:33 +02:00
|
|
|
Therefore, it is necessary for the
|
2020-07-20 06:30:18 +02:00
|
|
|
<xref linkend="guc-wal-keep-size"/> parameter to be set high
|
2011-10-26 20:13:33 +02:00
|
|
|
enough that the log is not removed before the end of the backup.
|
|
|
|
If the log has been rotated when it's time to transfer it, the
|
|
|
|
backup will fail and be unusable.
|
|
|
|
</para>
|
2016-10-23 15:16:31 +02:00
|
|
|
<para>
|
2019-01-29 10:42:41 +01:00
|
|
|
When tar format mode is used, the write-ahead log files will be
|
|
|
|
written to the <filename>base.tar</filename> file.
|
2016-10-23 15:16:31 +02:00
|
|
|
</para>
|
2011-10-26 20:13:33 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>s</literal></term>
|
|
|
|
<term><literal>stream</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-05-12 17:49:56 +02:00
|
|
|
Stream the write-ahead log while the backup is created. This will
|
2011-10-26 20:13:33 +02:00
|
|
|
open a second connection to the server and start streaming the
|
2017-05-12 17:49:56 +02:00
|
|
|
write-ahead log in parallel while running the backup. Therefore,
|
2015-06-11 03:34:03 +02:00
|
|
|
it will use up two connections configured by the
|
2017-11-23 15:39:47 +01:00
|
|
|
<xref linkend="guc-max-wal-senders"/> parameter. As long as the
|
2017-05-12 17:49:56 +02:00
|
|
|
client can keep up with write-ahead log received, using this mode
|
2020-06-15 19:12:58 +02:00
|
|
|
requires no extra write-ahead logs to be saved on the primary.
|
2011-10-26 20:13:33 +02:00
|
|
|
</para>
|
2016-10-23 15:16:31 +02:00
|
|
|
<para>
|
2019-01-29 10:42:41 +01:00
|
|
|
When tar format mode is used, the write-ahead log files will be
|
2019-04-08 22:27:35 +02:00
|
|
|
written to a separate file named <filename>pg_wal.tar</filename>
|
2019-01-29 10:42:41 +01:00
|
|
|
(if the server is a version earlier than 10, the file will be named
|
|
|
|
<filename>pg_xlog.tar</filename>).
|
2016-10-23 15:16:31 +02:00
|
|
|
</para>
|
2017-01-04 10:40:38 +01:00
|
|
|
<para>
|
|
|
|
This value is the default.
|
|
|
|
</para>
|
2011-10-26 20:13:33 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2020-06-07 14:54:28 +02:00
|
|
|
</variablelist></para>
|
2011-01-30 21:30:09 +01:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-05-30 00:02:02 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-z</option></term>
|
|
|
|
<term><option>--gzip</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables gzip compression of tar file output, with the default
|
|
|
|
compression level. Compression is only available when using
|
2016-10-23 15:16:31 +02:00
|
|
|
the tar format, and the suffix <filename>.gz</filename> will
|
|
|
|
automatically be added to all tar filenames.
|
2011-05-30 00:02:02 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-Z <replaceable class="parameter">level</replaceable></option></term>
|
|
|
|
<term><option>--compress=<replaceable class="parameter">level</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2011-05-30 00:02:02 +02:00
|
|
|
Enables gzip compression of tar file output, and specifies the
|
2016-08-01 10:36:14 +02:00
|
|
|
compression level (0 through 9, 0 being no compression and 9 being best
|
2011-05-30 00:02:02 +02:00
|
|
|
compression). Compression is only available when using the tar
|
2016-10-23 15:16:31 +02:00
|
|
|
format, and the suffix <filename>.gz</filename> will
|
|
|
|
automatically be added to all tar filenames.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
The following command-line options control the generation of the
|
|
|
|
backup and the running of the program.
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-c <replaceable class="parameter">fast|spread</replaceable></option></term>
|
2011-01-30 21:30:09 +01:00
|
|
|
<term><option>--checkpoint=<replaceable class="parameter">fast|spread</replaceable></option></term>
|
2011-01-23 12:21:23 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-11-23 15:39:47 +01:00
|
|
|
Sets checkpoint mode to fast (immediate) or spread (default) (see <xref linkend="backup-lowlevel-base-backup"/>).
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2017-09-26 22:07:52 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-C</option></term>
|
|
|
|
<term><option>--create-slot</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2018-09-16 17:35:34 +02:00
|
|
|
This option causes creation of a replication slot named by the
|
|
|
|
<literal>--slot</literal> option before starting the backup.
|
|
|
|
An error is raised if the slot already exists.
|
2017-09-26 22:07:52 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-l <replaceable class="parameter">label</replaceable></option></term>
|
|
|
|
<term><option>--label=<replaceable class="parameter">label</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the label for the backup. If none is specified, a default value of
|
2012-03-01 20:16:24 +01:00
|
|
|
<quote><literal>pg_basebackup base backup</literal></quote> will be used.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2016-09-12 18:00:00 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-n</option></term>
|
2016-10-19 18:00:00 +02:00
|
|
|
<term><option>--no-clean</option></term>
|
2016-09-12 18:00:00 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
By default, when <command>pg_basebackup</command> aborts with an
|
|
|
|
error, it removes any directories it might have created before
|
|
|
|
discovering that it cannot finish the job (for example, data directory
|
2017-05-12 17:49:56 +02:00
|
|
|
and write-ahead log directory). This option inhibits tidying-up and is
|
2016-09-12 18:00:00 +02:00
|
|
|
thus useful for debugging.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Note that tablespace directories are not cleaned up either way.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2017-09-26 17:58:22 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-N</option></term>
|
|
|
|
<term><option>--no-sync</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
By default, <command>pg_basebackup</command> will wait for all files
|
|
|
|
to be written safely to disk. This option causes
|
|
|
|
<command>pg_basebackup</command> to return without waiting, which is
|
|
|
|
faster, but means that a subsequent operating system crash can leave
|
|
|
|
the base backup corrupt. Generally, this option is useful for testing
|
|
|
|
but should not be used when creating a production installation.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-P</option></term>
|
|
|
|
<term><option>--progress</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables progress reporting. Turning this on will deliver an approximate
|
|
|
|
progress report during the backup. Since the database may change during
|
|
|
|
the backup, this is only an approximation and may not end at exactly
|
2011-01-30 21:30:09 +01:00
|
|
|
<literal>100%</literal>. In particular, when WAL log is included in the
|
|
|
|
backup, the total amount of data cannot be estimated in advance, and
|
2011-08-17 11:01:06 +02:00
|
|
|
in this case the estimated target size will increase once it passes the
|
|
|
|
total estimate without WAL.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2016-09-29 18:00:00 +02:00
|
|
|
<varlistentry>
|
2017-09-26 17:58:22 +02:00
|
|
|
<term><option>-S <replaceable>slotname</replaceable></option></term>
|
|
|
|
<term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
|
2016-09-29 18:00:00 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-09-26 17:58:22 +02:00
|
|
|
This option can only be used together with <literal>-X
|
|
|
|
stream</literal>. It causes the WAL streaming to use the specified
|
|
|
|
replication slot. If the base backup is intended to be used as a
|
|
|
|
streaming replication standby using replication slots, it should then
|
|
|
|
use the same replication slot name
|
2018-11-25 16:31:16 +01:00
|
|
|
in <xref linkend="guc-primary-slot-name"/>. That way, it is ensured that
|
2017-09-26 17:58:22 +02:00
|
|
|
the server does not remove any necessary WAL data in the time between
|
|
|
|
the end of the base backup and the start of streaming replication.
|
|
|
|
</para>
|
2017-09-26 22:07:52 +02:00
|
|
|
<para>
|
|
|
|
The specified replication slot has to exist unless the
|
|
|
|
option <option>-C</option> is also used.
|
|
|
|
</para>
|
2017-09-26 17:58:22 +02:00
|
|
|
<para>
|
|
|
|
If this option is not specified and the server supports temporary
|
|
|
|
replication slots (version 10 and later), then a temporary replication
|
|
|
|
slot is automatically used for WAL streaming.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2018-05-21 16:01:49 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-v</option></term>
|
|
|
|
<term><option>--verbose</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables verbose mode. Will output some extra steps during startup and
|
|
|
|
shutdown, as well as show the exact file name that is currently being
|
|
|
|
processed if progress reporting is also enabled.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2017-09-26 17:58:22 +02:00
|
|
|
<varlistentry>
|
2020-06-07 14:07:33 +02:00
|
|
|
<term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term>
|
2017-09-26 17:58:22 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
Specifies the checksum algorithm that should be applied to each file
|
|
|
|
included in the backup manifest. Currently, the available
|
|
|
|
algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,
|
|
|
|
<literal>SHA224</literal>, <literal>SHA256</literal>,
|
|
|
|
<literal>SHA384</literal>, and <literal>SHA512</literal>.
|
|
|
|
The default is <literal>CRC32C</literal>.
|
2017-09-26 17:58:22 +02:00
|
|
|
</para>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
If <literal>NONE</literal> is selected, the backup manifest will
|
|
|
|
not contain any checksums. Otherwise, it will contain a checksum
|
|
|
|
of each file in the backup using the specified algorithm. In addition,
|
|
|
|
the manifest will always contain a <literal>SHA256</literal>
|
|
|
|
checksum of its own contents. The <literal>SHA</literal> algorithms
|
|
|
|
are significantly more CPU-intensive than <literal>CRC32C</literal>,
|
|
|
|
so selecting one of them may increase the time required to complete
|
|
|
|
the backup.
|
2017-09-26 17:58:22 +02:00
|
|
|
</para>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
Using a SHA hash function provides a cryptographically secure digest
|
|
|
|
of each file for users who wish to verify that the backup has not been
|
|
|
|
tampered with, while the CRC32C algorithm provides a checksum which is
|
|
|
|
much faster to calculate and good at catching errors due to accidental
|
|
|
|
changes but is not resistant to targeted modifications. Note that, to
|
|
|
|
be useful against an adversary who has access to the backup, the backup
|
|
|
|
manifest would need to be stored securely elsewhere or otherwise
|
|
|
|
verified not to have been modified since the backup was taken.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
<xref linkend="app-pgverifybackup" /> can be used to check the
|
|
|
|
integrity of a backup against the backup manifest.
|
2016-09-29 18:00:00 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2018-04-03 13:47:16 +02:00
|
|
|
<varlistentry>
|
2020-06-07 14:07:33 +02:00
|
|
|
<term><option>--manifest-force-encode</option></term>
|
2018-04-03 13:47:16 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
Forces all filenames in the backup manifest to be hex-encoded.
|
|
|
|
If this option is not specified, only non-UTF8 filenames are
|
|
|
|
hex-encoded. This option is mostly intended to test that tools which
|
|
|
|
read a backup manifest file properly handle this case.
|
2018-04-03 13:47:16 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2020-03-19 09:09:00 +01:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--no-estimate-size</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
This option prevents the server from estimating the total
|
|
|
|
amount of backup data that will be streamed, resulting in the
|
|
|
|
<literal>backup_total</literal> column in the
|
|
|
|
<structname>pg_stat_progress_basebackup</structname>
|
2020-03-24 02:43:41 +01:00
|
|
|
to be <literal>NULL</literal>.
|
2020-03-19 09:09:00 +01:00
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
Without this option, the backup will start by enumerating
|
|
|
|
the size of the entire database, and then go back and send
|
|
|
|
the actual contents. This may make the backup take slightly
|
|
|
|
longer, and in particular it will take longer before the first
|
|
|
|
data is sent. This option is useful to avoid such estimation
|
|
|
|
time if it's too long.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
This option is not allowed when using <option>--progress</option>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--no-manifest</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Disables generation of a backup manifest. If this option is not
|
|
|
|
specified, the server will generate and send a backup manifest
|
2020-04-12 17:26:05 +02:00
|
|
|
which can be verified using <xref linkend="app-pgverifybackup" />.
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
The manifest is a list of every file present in the backup with the
|
|
|
|
exception of any WAL files that may be included. It also stores the
|
|
|
|
size, last modification time, and an optional checksum for each file.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2020-06-07 14:07:33 +02:00
|
|
|
<term><option>--no-slot</option></term>
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
This option prevents the creation of a temporary replication slot
|
|
|
|
during the backup even if it's supported by the server.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
Temporary replication slots are created by default if no slot name
|
|
|
|
is given with the option <option>-S</option> when using log streaming.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
The main purpose of this option is to allow taking a base backup when
|
|
|
|
the server is out of free replication slots. Using replication slots
|
|
|
|
is almost always preferred, because it prevents needed WAL from being
|
|
|
|
removed by the server during the backup.
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2020-06-07 14:07:33 +02:00
|
|
|
<term><option>--no-verify-checksums</option></term>
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
Disables verification of checksums, if they are enabled on the server
|
|
|
|
the base backup is taken from.
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
</para>
|
|
|
|
<para>
|
2020-06-07 14:07:33 +02:00
|
|
|
By default, checksums are verified and checksum failures will result
|
|
|
|
in a non-zero exit status. However, the base backup will not be
|
|
|
|
removed in such a case, as if the <option>--no-clean</option> option
|
|
|
|
had been used. Checksum verifications failures will also be reported
|
|
|
|
in the <link linkend="monitoring-pg-stat-database-view">
|
|
|
|
<structname>pg_stat_database</structname></link> view.
|
Generate backup manifests for base backups, and validate them.
A manifest is a JSON document which includes (1) the file name, size,
last modification time, and an optional checksum for each file backed
up, (2) timelines and LSNs for whatever WAL will need to be replayed
to make the backup consistent, and (3) a checksum for the manifest
itself. By default, we use CRC-32C when checksumming data files,
because we are trying to detect corruption and user error, not foil an
adversary. However, pg_basebackup and the server-side BASE_BACKUP
command now have options to select a different algorithm, so users
wanting a cryptographic hash function can select SHA-224, SHA-256,
SHA-384, or SHA-512. Users not wanting file checksums at all can
disable them, or disable generating of the backup manifest altogether.
Using a cryptographic hash function in place of CRC-32C consumes
significantly more CPU cycles, which may slow down backups in some
cases.
A new tool called pg_validatebackup can validate a backup against the
manifest. If no checksums are present, it can still check that the
right files exist and that they have the expected sizes. If checksums
are present, it can also verify that each file has the expected
checksum. Additionally, it calls pg_waldump to verify that the
expected WAL files are present and parseable. Only plain format
backups can be validated directly, but tar format backups can be
validated after extracting them.
Robert Haas, with help, ideas, review, and testing from David Steele,
Stephen Frost, Andrew Dunstan, Rushabh Lathia, Suraj Kharage, Tushar
Ahuja, Rajkumar Raghuwanshi, Mark Dilger, Davinder Singh, Jeevan
Chalke, Amit Kapila, Andres Freund, and Noah Misch.
Discussion: http://postgr.es/m/CA+TgmoZV8dw1H2bzZ9xkKwdrk8+XYa+DC9H=F7heO2zna5T6qg@mail.gmail.com
2020-04-03 20:59:47 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2011-01-23 12:21:23 +01:00
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The following command-line options control the database connection parameters.
|
|
|
|
|
|
|
|
<variablelist>
|
2013-02-25 13:48:27 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-d <replaceable class="parameter">connstr</replaceable></option></term>
|
|
|
|
<term><option>--dbname=<replaceable class="parameter">connstr</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies parameters used to connect to the server, as a connection
|
2017-11-23 15:39:47 +01:00
|
|
|
string. See <xref linkend="libpq-connstring"/> for more information.
|
2013-02-25 13:48:27 +01:00
|
|
|
</para>
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
The option is called <literal>--dbname</literal> for consistency with other
|
2013-02-25 13:48:27 +01:00
|
|
|
client applications, but because <application>pg_basebackup</application>
|
|
|
|
doesn't connect to any particular database in the cluster, database
|
|
|
|
name in the connection string will be ignored.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></option></term>
|
|
|
|
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the host name of the machine on which the server is
|
|
|
|
running. If the value begins with a slash, it is used as the
|
|
|
|
directory for the Unix domain socket. The default is taken
|
|
|
|
from the <envar>PGHOST</envar> environment variable, if set,
|
|
|
|
else a Unix domain socket connection is attempted.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></option></term>
|
|
|
|
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the TCP port or local Unix domain socket file
|
|
|
|
extension on which the server is listening for connections.
|
|
|
|
Defaults to the <envar>PGPORT</envar> environment variable, if
|
|
|
|
set, or a compiled-in default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2012-08-24 06:06:59 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-s <replaceable class="parameter">interval</replaceable></option></term>
|
|
|
|
<term><option>--status-interval=<replaceable class="parameter">interval</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the number of seconds between status packets sent back to the
|
2012-11-08 09:25:58 +01:00
|
|
|
server. This allows for easier monitoring of the progress from server.
|
|
|
|
A value of zero disables the periodic status updates completely,
|
|
|
|
although an update will still be sent when requested by the server, to
|
|
|
|
avoid timeout disconnect. The default value is 10 seconds.
|
2012-08-24 06:06:59 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-U <replaceable>username</replaceable></option></term>
|
|
|
|
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
User name to connect as.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-w</option></term>
|
|
|
|
<term><option>--no-password</option></term>
|
2011-01-23 12:21:23 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Never issue a password prompt. If the server requires
|
|
|
|
password authentication and a password is not available by
|
|
|
|
other means such as a <filename>.pgpass</filename> file, the
|
|
|
|
connection attempt will fail. This option can be useful in
|
|
|
|
batch jobs and scripts where no user is present to enter a
|
|
|
|
password.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-W</option></term>
|
|
|
|
<term><option>--password</option></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Force <application>pg_basebackup</application> to prompt for a
|
|
|
|
password before connecting to a database.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
This option is never essential, since
|
2011-10-25 22:46:14 +02:00
|
|
|
<application>pg_basebackup</application> will automatically prompt
|
2011-01-23 12:21:23 +01:00
|
|
|
for a password if the server demands password authentication.
|
|
|
|
However, <application>pg_basebackup</application> will waste a
|
|
|
|
connection attempt finding out that the server wants a password.
|
2017-10-09 03:44:17 +02:00
|
|
|
In some cases it is worth typing <option>-W</option> to avoid the extra
|
2011-01-23 12:21:23 +01:00
|
|
|
connection attempt.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2012-06-18 01:44:00 +02:00
|
|
|
Other options are also available:
|
2011-01-23 12:21:23 +01:00
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-V</option></term>
|
|
|
|
<term><option>--version</option></term>
|
2011-01-23 12:21:23 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print the <application>pg_basebackup</application> version and exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-?</option></term>
|
|
|
|
<term><option>--help</option></term>
|
2011-01-23 12:21:23 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Show help about <application>pg_basebackup</application> command line
|
|
|
|
arguments, and exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Environment</title>
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
This utility, like most other <productname>PostgreSQL</productname> utilities,
|
|
|
|
uses the environment variables supported by <application>libpq</application>
|
2017-11-23 15:39:47 +01:00
|
|
|
(see <xref linkend="libpq-envars"/>).
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
<para>
|
|
|
|
The environment variable <envar>PG_COLOR</envar> specifies whether to use
|
2020-03-09 02:53:22 +01:00
|
|
|
color in diagnostic messages. Possible values are
|
|
|
|
<literal>always</literal>, <literal>auto</literal> and
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
<literal>never</literal>.
|
|
|
|
</para>
|
2011-01-23 12:21:23 +01:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Notes</title>
|
|
|
|
|
2017-02-26 21:27:51 +01:00
|
|
|
<para>
|
|
|
|
At the beginning of the backup, a checkpoint needs to be written on the
|
|
|
|
server the backup is taken from. Especially if the option
|
|
|
|
<literal>--checkpoint=fast</literal> is not used, this can take some time
|
|
|
|
during which <application>pg_basebackup</application> will be appear
|
|
|
|
to be idle.
|
|
|
|
</para>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
<para>
|
|
|
|
The backup will include all files in the data directory and tablespaces,
|
|
|
|
including the configuration files and any additional files placed in the
|
2016-09-28 18:00:00 +02:00
|
|
|
directory by third parties, except certain temporary files managed by
|
|
|
|
PostgreSQL. But only regular files and directories are copied, except that
|
|
|
|
symbolic links used for tablespaces are preserved. Symbolic links pointing
|
|
|
|
to certain directories known to PostgreSQL are copied as empty directories.
|
|
|
|
Other symbolic links and special device files are skipped.
|
2017-11-23 15:39:47 +01:00
|
|
|
See <xref linkend="protocol-replication"/> for the precise details.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2014-02-22 19:38:06 +01:00
|
|
|
Tablespaces will in plain format by default be backed up to the same path
|
|
|
|
they have on the server, unless the
|
2015-09-11 03:22:21 +02:00
|
|
|
option <literal>--tablespace-mapping</literal> is used. Without
|
2014-02-22 19:38:06 +01:00
|
|
|
this option, running a plain format base backup on the same host as the
|
|
|
|
server will not work if tablespaces are in use, because the backup would
|
|
|
|
have to be written to the same directory locations as the original
|
|
|
|
tablespaces.
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
Make pg_basebackup work with pre-9.3 servers, and add server version check.
A new 'starttli' field was added to the response of BASE_BACKUP command.
Make pg_basebackup tolerate the case that it's missing, so that it still
works with older servers.
Add an explicit check for the server version, so that you get a nicer error
message if you try to use it with a pre-9.1 server.
The streaming protocol message format changed in 9.3, so -X stream still won't
work with pre-9.3 servers. I added a version check to ReceiveXLogStream()
earlier, but write that slightly differently, so that in 9.4, it will still
work with a 9.3 server. (In 9.4, the error message needs to be adjusted to
"9.3 or above", though). Also, if the version check fails, don't retry.
2013-03-22 12:02:59 +01:00
|
|
|
|
2015-05-12 15:29:10 +02:00
|
|
|
<para>
|
|
|
|
When tar format mode is used, it is the user's responsibility to unpack each
|
2015-09-11 03:22:21 +02:00
|
|
|
tar file before starting the PostgreSQL server. If there are additional tablespaces, the
|
2015-05-12 15:29:10 +02:00
|
|
|
tar files for them need to be unpacked in the correct locations. In this
|
2015-09-11 03:22:21 +02:00
|
|
|
case the symbolic links for those tablespaces will be created by the server
|
2017-10-09 03:44:17 +02:00
|
|
|
according to the contents of the <filename>tablespace_map</filename> file that is
|
|
|
|
included in the <filename>base.tar</filename> file.
|
2015-05-12 15:29:10 +02:00
|
|
|
</para>
|
|
|
|
|
Make pg_basebackup work with pre-9.3 servers, and add server version check.
A new 'starttli' field was added to the response of BASE_BACKUP command.
Make pg_basebackup tolerate the case that it's missing, so that it still
works with older servers.
Add an explicit check for the server version, so that you get a nicer error
message if you try to use it with a pre-9.1 server.
The streaming protocol message format changed in 9.3, so -X stream still won't
work with pre-9.3 servers. I added a version check to ReceiveXLogStream()
earlier, but write that slightly differently, so that in 9.4, it will still
work with a 9.3 server. (In 9.4, the error message needs to be adjusted to
"9.3 or above", though). Also, if the version check fails, don't retry.
2013-03-22 12:02:59 +01:00
|
|
|
<para>
|
|
|
|
<application>pg_basebackup</application> works with servers of the same
|
2015-09-11 03:22:21 +02:00
|
|
|
or an older major version, down to 9.1. However, WAL streaming mode (<literal>-X
|
|
|
|
stream</literal>) only works with server version 9.3 and later, and tar format mode
|
|
|
|
(<literal>--format=tar</literal>) of the current version only works with server version 9.5
|
2015-05-12 15:29:10 +02:00
|
|
|
or later.
|
Make pg_basebackup work with pre-9.3 servers, and add server version check.
A new 'starttli' field was added to the response of BASE_BACKUP command.
Make pg_basebackup tolerate the case that it's missing, so that it still
works with older servers.
Add an explicit check for the server version, so that you get a nicer error
message if you try to use it with a pre-9.1 server.
The streaming protocol message format changed in 9.3, so -X stream still won't
work with pre-9.3 servers. I added a version check to ReceiveXLogStream()
earlier, but write that slightly differently, so that in 9.4, it will still
work with a 9.3 server. (In 9.4, the error message needs to be adjusted to
"9.3 or above", though). Also, if the version check fails, don't retry.
2013-03-22 12:02:59 +01:00
|
|
|
</para>
|
2015-05-12 15:29:10 +02:00
|
|
|
|
2018-04-07 23:45:39 +02:00
|
|
|
<para>
|
|
|
|
<application>pg_basebackup</application> will preserve group permissions in
|
|
|
|
both the <literal>plain</literal> and <literal>tar</literal> formats if group
|
|
|
|
permissions are enabled on the source cluster.
|
|
|
|
</para>
|
|
|
|
|
2011-01-23 12:21:23 +01:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
To create a base backup of the server at <literal>mydbserver</literal>
|
|
|
|
and store it in the local directory
|
|
|
|
<filename>/usr/local/pgsql/data</filename>:
|
2011-05-02 18:19:48 +02:00
|
|
|
<screen>
|
|
|
|
<prompt>$</prompt> <userinput>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</userinput>
|
|
|
|
</screen>
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2011-05-30 00:02:02 +02:00
|
|
|
To create a backup of the local server with one compressed
|
2011-01-23 12:21:23 +01:00
|
|
|
tar file for each tablespace, and store it in the directory
|
|
|
|
<filename>backup</filename>, showing a progress report while running:
|
2011-05-02 18:19:48 +02:00
|
|
|
<screen>
|
2011-05-30 00:02:02 +02:00
|
|
|
<prompt>$</prompt> <userinput>pg_basebackup -D backup -Ft -z -P</userinput>
|
2011-05-02 18:19:48 +02:00
|
|
|
</screen>
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
To create a backup of a single-tablespace local database and compress
|
|
|
|
this with <productname>bzip2</productname>:
|
2011-05-02 18:19:48 +02:00
|
|
|
<screen>
|
2017-01-04 10:40:38 +01:00
|
|
|
<prompt>$</prompt> <userinput>pg_basebackup -D - -Ft -X fetch | bzip2 > backup.tar.bz2</userinput>
|
2011-05-02 18:19:48 +02:00
|
|
|
</screen>
|
2011-05-10 21:37:50 +02:00
|
|
|
(This command will fail if there are multiple tablespaces in the
|
|
|
|
database.)
|
2011-01-23 12:21:23 +01:00
|
|
|
</para>
|
2014-02-22 19:38:06 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
To create a backup of a local database where the tablespace in
|
|
|
|
<filename>/opt/ts</filename> is relocated
|
|
|
|
to <filename>./backup/ts</filename>:
|
|
|
|
<screen>
|
|
|
|
<prompt>$</prompt> <userinput>pg_basebackup -D backup/data -T /opt/ts=$(pwd)/backup/ts</userinput>
|
2020-06-07 14:54:28 +02:00
|
|
|
</screen></para>
|
2011-01-23 12:21:23 +01:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
2017-11-23 15:39:47 +01:00
|
|
|
<member><xref linkend="app-pgdump"/></member>
|
2011-01-23 12:21:23 +01:00
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|