aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2014-05-14 22:26:49 -0400
committerPeter Eisentraut <peter_e@gmx.net>2014-05-14 22:26:49 -0400
commit4773c70aa4c938c367ee179f7301f70a4efabc0e (patch)
tree43f283465419550a087da59faf708f7f95547d2d
parentc424c049189f758920b1a3bb961bc05c93a900df (diff)
downloadpostgresql-4773c70aa4c938c367ee179f7301f70a4efabc0e.tar.gz
postgresql-4773c70aa4c938c367ee179f7301f70a4efabc0e.zip
doc: Clarify what files pg_basebackup omits from data directory
-rw-r--r--doc/src/sgml/protocol.sgml17
-rw-r--r--doc/src/sgml/ref/pg_basebackup.sgml6
2 files changed, 21 insertions, 2 deletions
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index c37113cb35b..3a2421bf458 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1997,12 +1997,29 @@ The commands accepted in walsender mode are:
</listitem>
<listitem>
<para>
+ various temporary files created during the operation of the PostgreSQL server
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<filename>pg_xlog</>, including subdirectories. If the backup is run
with WAL files included, a synthesized version of <filename>pg_xlog</filename> will be
included, but it will only contain the files necessary for the
backup to work, not the rest of the contents.
</para>
</listitem>
+ <listitem>
+ <para>
+ <filename>pg_replslot</> is copied as an empty directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Files other than regular files and directories, such as symbolic
+ links and special device files, are skipped. (Symbolic links
+ in <filename>pg_tblspc</filename> are maintained.)
+ </para>
+ </listitem>
</itemizedlist>
Owner, group and file mode are set if the underlying file system on
the server supports it.
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 97b0af987ab..10c1743754c 100644
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -571,8 +571,10 @@ PostgreSQL documentation
<para>
The backup will include all files in the data directory and tablespaces,
including the configuration files and any additional files placed in the
- directory by third parties. Only regular files and directories are allowed
- in the data directory, no symbolic links or special device files.
+ directory by third parties. But only regular files and directories are
+ copied. Symbolic links (other than those used for tablespaces) and special
+ device files are skipped. (See <xref linkend="protocol-replication"> for
+ the precise details.)
</para>
<para>