aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/pg_basebackup.sgml
diff options
context:
space:
mode:
authorMagnus Hagander <magnus@hagander.net>2016-10-23 15:16:31 +0200
committerMagnus Hagander <magnus@hagander.net>2016-10-23 15:23:11 +0200
commit56c7d8d4552180fd66fe48423bb2a9bb767c2d87 (patch)
tree72a159d220c25c33363addd097ea719f8384dd52 /doc/src/sgml/ref/pg_basebackup.sgml
parent1885c88459698251eca64f095d9942c540ba0fa8 (diff)
downloadpostgresql-56c7d8d4552180fd66fe48423bb2a9bb767c2d87.tar.gz
postgresql-56c7d8d4552180fd66fe48423bb2a9bb767c2d87.zip
Allow pg_basebackup to stream transaction log in tar mode
This will write the received transaction log into a file called pg_wal.tar(.gz) next to the other tarfiles instead of writing it to base.tar. When using fetch mode, the transaction log is still written to base.tar like before, and when used against a pre-10 server, the file is named pg_xlog.tar. To do this, implement a new concept of a "walmethod", which is responsible for writing the WAL. Two implementations exist, one that writes to a plain directory (which is also used by pg_receivexlog) and one that writes to a tar file with optional compression. Reviewed by Michael Paquier
Diffstat (limited to 'doc/src/sgml/ref/pg_basebackup.sgml')
-rw-r--r--doc/src/sgml/ref/pg_basebackup.sgml18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 7cb690dded7..e66a7ae8eed 100644
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -180,7 +180,8 @@ PostgreSQL documentation
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
- the cluster has no additional tablespaces.
+ the cluster has no additional tablespaces and transaction
+ log streaming is not used.
</para>
</listitem>
</varlistentry>
@@ -323,6 +324,10 @@ PostgreSQL documentation
If the log has been rotated when it's time to transfer it, the
backup will fail and be unusable.
</para>
+ <para>
+ The transaction log files will be written to
+ the <filename>base.tar</filename> file.
+ </para>
</listitem>
</varlistentry>
@@ -339,6 +344,11 @@ PostgreSQL documentation
client can keep up with transaction log received, using this mode
requires no extra transaction logs to be saved on the master.
</para>
+ <para>
+ The transaction log files are written to a separate file
+ 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>
</listitem>
</varlistentry>
</variablelist>
@@ -353,7 +363,8 @@ PostgreSQL documentation
<para>
Enables gzip compression of tar file output, with the default
compression level. Compression is only available when using
- the tar format.
+ the tar format, and the suffix <filename>.gz</filename> will
+ automatically be added to all tar filenames.
</para>
</listitem>
</varlistentry>
@@ -366,7 +377,8 @@ PostgreSQL documentation
Enables gzip compression of tar file output, and specifies the
compression level (0 through 9, 0 being no compression and 9 being best
compression). Compression is only available when using the tar
- format.
+ format, and the suffix <filename>.gz</filename> will
+ automatically be added to all tar filenames.
</para>
</listitem>
</varlistentry>