Improve documentation of pg_restore's -l and -L switches to point out their

interactions with filtering switches, such as -n and -t.  Per a complaint
from Russell Smith.
This commit is contained in:
Tom Lane 2010-05-15 18:11:41 +00:00
parent ab9536b134
commit 00a80128ea

View File

@ -1,4 +1,4 @@
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.43 2003/09/23 22:48:53 tgl Exp $ --> <!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.43.2.1 2010/05/15 18:11:41 tgl Exp $ -->
<refentry id="APP-PGRESTORE"> <refentry id="APP-PGRESTORE">
<refmeta> <refmeta>
@ -156,10 +156,7 @@
<term><literal>t</></term> <term><literal>t</></term>
<listitem> <listitem>
<para> <para>
The archive is a <command>tar</command> archive. Using this The archive is a <command>tar</command> archive.
archive format allows reordering and/or exclusion of schema
elements at the time the database is restored. It is also
possible to limit which data is reloaded at restore time.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -169,10 +166,7 @@
<listitem> <listitem>
<para> <para>
The archive is in the custom format of The archive is in the custom format of
<application>pg_dump</application>. This is the most <application>pg_dump</application>.
flexible format in that it allows reordering of data load
as well as schema elements. This format is also compressed
by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -207,8 +201,9 @@
<listitem> <listitem>
<para> <para>
List the contents of the archive. The output of this operation List the contents of the archive. The output of this operation
can be used with the <option>-L</option> option to restrict can be used as input to the <option>-L</option> option. Note that
and reorder the items that are restored. if filtering switches such as <option>-n</> or <option>-t</> are
used with <option>-l</>, they will restrict the items listed.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -218,11 +213,18 @@
<term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term> <term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Restore elements in <REPLACEABLE Restore only those archive elements that are listed in <replaceable
CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the class="PARAMETER">list-file</replaceable>, and restore them in the
order they appear in the file. Lines can be moved and may also order they appear in the file. Note that
be commented out by placing a <literal>;</literal> at the if filtering switches such as <option>-n</> or <option>-t</> are
start of the line. (See below for examples.) used with <option>-L</>, they will further restrict the items restored.
</para>
<para>
<replaceable class="PARAMETER">list-file</> is normally created by
editing the output of a previous <option>-l</> operation.
Lines can be moved or removed, and can also
be commented out by placing a semicolon (<literal>;</literal>) at the
start of the line. See below for examples.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>