2020-05-15 14:52:24 +02:00
|
|
|
<!--
|
|
|
|
|
doc/src/sgml/ref/pg_restore.sgml
|
|
|
|
|
PostgreSQL documentation
|
|
|
|
|
-->
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2017-10-20 03:16:39 +02:00
|
|
|
<refentry id="app-pgrestore">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="app-pgrestore">
|
|
|
|
|
<primary>pg_restore</primary>
|
|
|
|
|
</indexterm>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<refmeta>
|
2020-07-10 16:51:29 +02:00
|
|
|
<refentrytitle><application>pg_restore</application></refentrytitle>
|
2000-12-26 00:15:27 +01:00
|
|
|
<manvolnum>1</manvolnum>
|
2000-10-12 16:09:37 +02:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
|
</refmeta>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<refnamediv>
|
2001-03-06 19:55:57 +01:00
|
|
|
<refname>pg_restore</refname>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<refpurpose>
|
2007-05-15 21:13:55 +02:00
|
|
|
restore a <productname>PostgreSQL</productname> database from an
|
|
|
|
|
archive file created by <application>pg_dump</application>
|
2000-10-12 16:09:37 +02:00
|
|
|
</refpurpose>
|
|
|
|
|
</refnamediv>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<refsynopsisdiv>
|
2001-03-06 19:55:57 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
|
<command>pg_restore</command>
|
2010-02-19 04:50:03 +01:00
|
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
2003-03-24 15:32:51 +01:00
|
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
2012-05-03 21:50:04 +02:00
|
|
|
<arg choice="opt"><replaceable>filename</replaceable></arg>
|
2001-03-06 19:55:57 +01:00
|
|
|
</cmdsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="app-pgrestore-description">
|
2002-10-12 01:03:48 +02:00
|
|
|
<title>Description</title>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
<application>pg_restore</application> is a utility for restoring a
|
2001-11-28 21:49:10 +01:00
|
|
|
<productname>PostgreSQL</productname> database from an archive
|
2017-11-23 15:39:47 +01:00
|
|
|
created by <xref linkend="app-pgdump"/> in one of the non-plain-text
|
2003-03-24 15:32:51 +01:00
|
|
|
formats. It will issue the commands necessary to reconstruct the
|
|
|
|
|
database to the state it was in at the time it was saved. The
|
|
|
|
|
archive files also allow <application>pg_restore</application> to
|
|
|
|
|
be selective about what is restored, or even to reorder the items
|
|
|
|
|
prior to being restored. The archive files are designed to be
|
|
|
|
|
portable across architectures.
|
2001-03-06 19:55:57 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2005-06-21 22:45:44 +02:00
|
|
|
<application>pg_restore</application> can operate in two modes.
|
2010-05-15 20:11:07 +02:00
|
|
|
If a database name is specified, <application>pg_restore</application>
|
|
|
|
|
connects to that database and restores archive contents directly into
|
2005-06-21 22:45:44 +02:00
|
|
|
the database. Otherwise, a script containing the SQL
|
|
|
|
|
commands necessary to rebuild the database is created and written
|
2010-05-15 20:11:07 +02:00
|
|
|
to a file or standard output. This script output is equivalent to
|
2005-06-21 22:45:44 +02:00
|
|
|
the plain text output format of <application>pg_dump</application>.
|
|
|
|
|
Some of the options controlling the output are therefore analogous to
|
2002-10-12 01:03:48 +02:00
|
|
|
<application>pg_dump</application> options.
|
2001-03-06 19:55:57 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Obviously, <application>pg_restore</application> cannot restore information
|
2003-03-24 15:32:51 +01:00
|
|
|
that is not present in the archive file. For instance, if the
|
2001-08-22 22:23:24 +02:00
|
|
|
archive was made using the <quote>dump data as
|
2003-03-24 15:32:51 +01:00
|
|
|
<command>INSERT</command> commands</quote> option,
|
2002-10-12 01:03:48 +02:00
|
|
|
<application>pg_restore</application> will not be able to load the data
|
2001-08-22 22:23:24 +02:00
|
|
|
using <command>COPY</command> statements.
|
2001-03-06 19:55:57 +01:00
|
|
|
</para>
|
2002-10-12 01:03:48 +02:00
|
|
|
</refsect1>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<refsect1 id="app-pgrestore-options">
|
|
|
|
|
<title>Options</title>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
<application>pg_restore</application> accepts the following command
|
2003-01-06 19:53:25 +01:00
|
|
|
line arguments.
|
2000-10-12 16:09:37 +02:00
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<term><replaceable class="parameter">filename</replaceable></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2011-01-23 22:10:15 +01:00
|
|
|
Specifies the location of the archive file (or directory, for a
|
|
|
|
|
directory-format archive) to be restored.
|
2001-11-27 00:09:21 +01:00
|
|
|
If not specified, the standard input is used.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-a</option></term>
|
|
|
|
|
<term><option>--data-only</option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
Restore only the data, not the schema (data definitions).
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
Table data, large objects, and sequence values are restored,
|
|
|
|
|
if present in the archive.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
|
2011-12-17 01:09:38 +01:00
|
|
|
<para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
This option is similar to, but for historical reasons not identical
|
2017-10-09 03:44:17 +02:00
|
|
|
to, specifying <option>--section=data</option>.
|
2011-12-17 01:09:38 +01:00
|
|
|
</para>
|
2000-10-12 16:09:37 +02:00
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-c</option></term>
|
|
|
|
|
<term><option>--clean</option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
Clean (drop) database objects before recreating them.
|
2017-10-09 03:44:17 +02:00
|
|
|
(Unless <option>--if-exists</option> is used,
|
2014-03-03 19:02:18 +01:00
|
|
|
this might generate some harmless error messages, if any objects
|
2012-10-20 22:58:32 +02:00
|
|
|
were not present in the destination database.)
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-C</option></term>
|
|
|
|
|
<term><option>--create</option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2012-10-20 22:58:32 +02:00
|
|
|
Create the database before restoring into it.
|
|
|
|
|
If <option>--clean</option> is also specified, drop and
|
|
|
|
|
recreate the target database before connecting to it.
|
|
|
|
|
</para>
|
|
|
|
|
|
Move handling of database properties from pg_dumpall into pg_dump.
This patch rearranges the division of labor between pg_dump and pg_dumpall
so that pg_dump itself handles all properties attached to a single
database. Notably, a database's ACL (GRANT/REVOKE status) and local GUC
settings established by ALTER DATABASE SET and ALTER ROLE IN DATABASE SET
can be dumped and restored by pg_dump. This is a long-requested
improvement.
"pg_dumpall -g" will now produce only role- and tablespace-related output,
nothing about individual databases. The total output of a regular
pg_dumpall run remains the same.
pg_dump (or pg_restore) will restore database-level properties only when
creating the target database with --create. This applies not only to
ACLs and GUCs but to the other database properties it already handled,
that is database comments and security labels. This is more consistent
and useful, but does represent an incompatibility in the behavior seen
without --create.
(This change makes the proposed patch to have pg_dump use "COMMENT ON
DATABASE CURRENT_DATABASE" unnecessary, since there is no case where
the command is issued that we won't know the true name of the database.
We might still want that patch as a feature in its own right, but pg_dump
no longer needs it.)
pg_dumpall with --clean will now drop and recreate the "postgres" and
"template1" databases in the target cluster, allowing their locale and
encoding settings to be changed if necessary, and providing a cleaner
way to set nondefault tablespaces for them than we had before. This
means that such a script must now always be started in the "postgres"
database; the order of drops and reconnects will not work otherwise.
Without --clean, the script will not adjust any database-level properties
of those two databases (including their comments, ACLs, and security
labels, which it formerly would try to set).
Another minor incompatibility is that the CREATE DATABASE commands in a
pg_dumpall script will now always specify locale and encoding settings.
Formerly those would be omitted if they matched the cluster's default.
While that behavior had some usefulness in some migration scenarios,
it also posed a significant hazard of unwanted locale/encoding changes.
To migrate to another locale/encoding, it's now necessary to use pg_dump
without --create to restore into a database with the desired settings.
Commit 4bd371f6f's hack to emit "SET default_transaction_read_only = off"
is gone: we now dodge that problem by the expedient of not issuing ALTER
DATABASE SET commands until after reconnecting to the target database.
Therefore, such settings won't apply during the restore session.
In passing, improve some shaky grammar in the docs, and add a note pointing
out that pg_dumpall's output can't be expected to load without any errors.
(Someday we might want to fix that, but this is not that patch.)
Haribabu Kommi, reviewed at various times by Andreas Karlsson,
Vaishnavi Prabakaran, and Robert Haas; further hacking by me.
Discussion: https://postgr.es/m/CAJrrPGcUurV0eWTeXODwsOYFN=Ekq36t1s0YnFYUNzsmRfdAyA@mail.gmail.com
2018-01-22 20:09:09 +01:00
|
|
|
<para>
|
|
|
|
|
With <option>--create</option>, <application>pg_restore</application>
|
|
|
|
|
also restores the database's comment if any, and any configuration
|
|
|
|
|
variable settings that are specific to this database, that is,
|
|
|
|
|
any <command>ALTER DATABASE ... SET ...</command>
|
|
|
|
|
and <command>ALTER ROLE ... IN DATABASE ... SET ...</command>
|
|
|
|
|
commands that mention this database.
|
|
|
|
|
Access privileges for the database itself are also restored,
|
|
|
|
|
unless <option>--no-acl</option> is specified.
|
|
|
|
|
</para>
|
|
|
|
|
|
2012-10-20 22:58:32 +02:00
|
|
|
<para>
|
|
|
|
|
When this option is used, the database named with <option>-d</option>
|
2017-10-09 03:44:17 +02:00
|
|
|
is used only to issue the initial <command>DROP DATABASE</command> and
|
|
|
|
|
<command>CREATE DATABASE</command> commands. All data is restored into the
|
2012-10-20 22:58:32 +02:00
|
|
|
database name that appears in the archive.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-d <replaceable class="parameter">dbname</replaceable></option></term>
|
|
|
|
|
<term><option>--dbname=<replaceable class="parameter">dbname</replaceable></option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
Connect to database <replaceable
|
|
|
|
|
class="parameter">dbname</replaceable> and restore directly
|
2020-10-03 04:19:31 +02:00
|
|
|
into the database. The <replaceable>dbname</replaceable> can
|
|
|
|
|
be a <link linkend="libpq-connstring">connection string</link>.
|
|
|
|
|
If so, connection string parameters will override any conflicting
|
|
|
|
|
command line options.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2004-08-20 06:20:23 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-e</option></term>
|
|
|
|
|
<term><option>--exit-on-error</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Exit if an error is encountered while sending SQL commands to
|
2009-01-05 17:54:37 +01:00
|
|
|
the database. The default is to continue and to display a count of
|
2004-08-20 06:20:23 +02:00
|
|
|
errors at the end of the restoration.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-f <replaceable>filename</replaceable></option></term>
|
|
|
|
|
<term><option>--file=<replaceable>filename</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2001-10-24 00:11:22 +02:00
|
|
|
Specify output file for generated script, or for the listing
|
2019-04-04 21:34:58 +02:00
|
|
|
when used with <option>-l</option>. Use <literal>-</literal>
|
|
|
|
|
for <systemitem>stdout</systemitem>.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-F <replaceable class="parameter">format</replaceable></option></term>
|
|
|
|
|
<term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
Specify format of the archive. It is not necessary to specify
|
|
|
|
|
the format, since <application>pg_restore</application> will
|
|
|
|
|
determine the format automatically. If specified, it can be
|
|
|
|
|
one of the following:
|
2000-10-20 15:44:39 +02:00
|
|
|
|
|
|
|
|
<variablelist>
|
2011-01-23 22:10:15 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><literal>c</literal></term>
|
|
|
|
|
<term><literal>custom</literal></term>
|
2011-01-23 22:10:15 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2011-05-25 20:53:26 +02:00
|
|
|
The archive is in the custom format of
|
|
|
|
|
<application>pg_dump</application>.
|
2011-01-23 22:10:15 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><literal>d</literal></term>
|
|
|
|
|
<term><literal>directory</literal></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2011-05-25 20:53:26 +02:00
|
|
|
The archive is a directory archive.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><literal>t</literal></term>
|
|
|
|
|
<term><literal>tar</literal></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2011-05-25 20:53:26 +02:00
|
|
|
The archive is a <command>tar</command> archive.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2011-08-07 09:49:45 +02:00
|
|
|
</variablelist></para>
|
2000-10-20 15:44:39 +02:00
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2002-07-13 02:55:53 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-I <replaceable class="parameter">index</replaceable></option></term>
|
|
|
|
|
<term><option>--index=<replaceable class="parameter">index</replaceable></option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2013-08-28 08:43:34 +02:00
|
|
|
Restore definition of named index only. Multiple indexes
|
2017-10-09 03:44:17 +02:00
|
|
|
may be specified with multiple <option>-I</option> switches.
|
2002-07-13 02:55:53 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2009-03-20 10:21:09 +01:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-j <replaceable class="parameter">number-of-jobs</replaceable></option></term>
|
|
|
|
|
<term><option>--jobs=<replaceable class="parameter">number-of-jobs</replaceable></option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
Cope with data-offset-less archive files during out-of-order restores.
pg_dump produces custom-format archive files that lack data offsets
when it is unable to seek its output. Up to now that's been a hazard
for pg_restore. But if pg_restore is able to seek in the archive
file, there is no reason to throw up our hands when asked to restore
data blocks out of order. Instead, whenever we are searching for a
data block, record the locations of the blocks we passed over (that
is, fill in the missing data-offset fields in our in-memory copy of
the TOC data). Then, when we hit a case that requires going
backwards, we can just seek back.
Also track the furthest point that we've searched to, and seek back
to there when beginning a search for a new data block. This avoids
possible O(N^2) time consumption, by ensuring that each data block
is examined at most twice. (On Unix systems, that's at most twice
per parallel-restore job; but since Windows uses threads here, the
threads can share block location knowledge, reducing the amount of
duplicated work.)
We can also improve the code a bit by using fseeko() to skip over
data blocks during the search.
This is all of some use even in simple restores, but it's really
significant for parallel pg_restore. In that case, we require
seekability of the input already, and we will very probably need
to do out-of-order restores.
Back-patch to v12, as this fixes a regression introduced by commit
548e50976. Before that, parallel restore avoided requesting
out-of-order restores, so it would work on a data-offset-less
archive. Now it will again.
Ideally this patch would include some test coverage, but there are
other open bugs that need to be fixed before we can extend our
coverage of parallel restore very much. Plan to revisit that later.
David Gilman and Tom Lane; reviewed by Justin Pryzby
Discussion: https://postgr.es/m/CALBH9DDuJ+scZc4MEvw5uO-=vRyR2=QF9+Yh=3hPEnKHWfS81A@mail.gmail.com
2020-07-17 19:03:50 +02:00
|
|
|
Run the most time-consuming steps
|
|
|
|
|
of <application>pg_restore</application> — those that load data,
|
|
|
|
|
create indexes, or create constraints — concurrently, using up
|
|
|
|
|
to <replaceable class="parameter">number-of-jobs</replaceable>
|
|
|
|
|
concurrent sessions. This option can dramatically reduce the time
|
2009-03-20 10:21:09 +01:00
|
|
|
to restore a large database to a server running on a
|
Cope with data-offset-less archive files during out-of-order restores.
pg_dump produces custom-format archive files that lack data offsets
when it is unable to seek its output. Up to now that's been a hazard
for pg_restore. But if pg_restore is able to seek in the archive
file, there is no reason to throw up our hands when asked to restore
data blocks out of order. Instead, whenever we are searching for a
data block, record the locations of the blocks we passed over (that
is, fill in the missing data-offset fields in our in-memory copy of
the TOC data). Then, when we hit a case that requires going
backwards, we can just seek back.
Also track the furthest point that we've searched to, and seek back
to there when beginning a search for a new data block. This avoids
possible O(N^2) time consumption, by ensuring that each data block
is examined at most twice. (On Unix systems, that's at most twice
per parallel-restore job; but since Windows uses threads here, the
threads can share block location knowledge, reducing the amount of
duplicated work.)
We can also improve the code a bit by using fseeko() to skip over
data blocks during the search.
This is all of some use even in simple restores, but it's really
significant for parallel pg_restore. In that case, we require
seekability of the input already, and we will very probably need
to do out-of-order restores.
Back-patch to v12, as this fixes a regression introduced by commit
548e50976. Before that, parallel restore avoided requesting
out-of-order restores, so it would work on a data-offset-less
archive. Now it will again.
Ideally this patch would include some test coverage, but there are
other open bugs that need to be fixed before we can extend our
coverage of parallel restore very much. Plan to revisit that later.
David Gilman and Tom Lane; reviewed by Justin Pryzby
Discussion: https://postgr.es/m/CALBH9DDuJ+scZc4MEvw5uO-=vRyR2=QF9+Yh=3hPEnKHWfS81A@mail.gmail.com
2020-07-17 19:03:50 +02:00
|
|
|
multiprocessor machine. This option is ignored when emitting a script
|
|
|
|
|
rather than connecting directly to a database server.
|
2009-03-20 10:21:09 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
Each job is one process or one thread, depending on the
|
|
|
|
|
operating system, and uses a separate connection to the
|
|
|
|
|
server.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
The optimal value for this option depends on the hardware
|
|
|
|
|
setup of the server, of the client, and of the network.
|
|
|
|
|
Factors include the number of CPU cores and the disk setup. A
|
|
|
|
|
good place to start is the number of CPU cores on the server,
|
|
|
|
|
but values larger than that can also lead to faster restore
|
|
|
|
|
times in many cases. Of course, values that are too high will
|
2010-02-19 04:50:03 +01:00
|
|
|
lead to decreased performance because of thrashing.
|
2009-03-20 10:21:09 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2013-06-16 02:38:18 +02:00
|
|
|
Only the custom and directory archive formats are supported
|
|
|
|
|
with this option.
|
|
|
|
|
The input must be a regular file or directory (not, for example, a
|
Cope with data-offset-less archive files during out-of-order restores.
pg_dump produces custom-format archive files that lack data offsets
when it is unable to seek its output. Up to now that's been a hazard
for pg_restore. But if pg_restore is able to seek in the archive
file, there is no reason to throw up our hands when asked to restore
data blocks out of order. Instead, whenever we are searching for a
data block, record the locations of the blocks we passed over (that
is, fill in the missing data-offset fields in our in-memory copy of
the TOC data). Then, when we hit a case that requires going
backwards, we can just seek back.
Also track the furthest point that we've searched to, and seek back
to there when beginning a search for a new data block. This avoids
possible O(N^2) time consumption, by ensuring that each data block
is examined at most twice. (On Unix systems, that's at most twice
per parallel-restore job; but since Windows uses threads here, the
threads can share block location knowledge, reducing the amount of
duplicated work.)
We can also improve the code a bit by using fseeko() to skip over
data blocks during the search.
This is all of some use even in simple restores, but it's really
significant for parallel pg_restore. In that case, we require
seekability of the input already, and we will very probably need
to do out-of-order restores.
Back-patch to v12, as this fixes a regression introduced by commit
548e50976. Before that, parallel restore avoided requesting
out-of-order restores, so it would work on a data-offset-less
archive. Now it will again.
Ideally this patch would include some test coverage, but there are
other open bugs that need to be fixed before we can extend our
coverage of parallel restore very much. Plan to revisit that later.
David Gilman and Tom Lane; reviewed by Justin Pryzby
Discussion: https://postgr.es/m/CALBH9DDuJ+scZc4MEvw5uO-=vRyR2=QF9+Yh=3hPEnKHWfS81A@mail.gmail.com
2020-07-17 19:03:50 +02:00
|
|
|
pipe or standard input). Also, multiple
|
2009-03-20 10:21:09 +01:00
|
|
|
jobs cannot be used together with the
|
|
|
|
|
option <option>--single-transaction</option>.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-l</option></term>
|
|
|
|
|
<term><option>--list</option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2017-08-11 21:52:39 +02:00
|
|
|
List the table of contents of the archive. The output of this operation
|
2010-05-15 20:11:07 +02:00
|
|
|
can be used as input to the <option>-L</option> option. Note that
|
2017-10-09 03:44:17 +02:00
|
|
|
if filtering switches such as <option>-n</option> or <option>-t</option> are
|
|
|
|
|
used with <option>-l</option>, they will restrict the items listed.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2001-03-06 06:22:50 +01:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-L <replaceable class="parameter">list-file</replaceable></option></term>
|
|
|
|
|
<term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term>
|
2001-03-06 06:22:50 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2010-05-15 20:11:07 +02:00
|
|
|
Restore only those archive elements that are listed in <replaceable
|
2017-10-09 04:00:57 +02:00
|
|
|
class="parameter">list-file</replaceable>, and restore them in the
|
2010-05-15 20:11:07 +02:00
|
|
|
order they appear in the file. Note that
|
2017-10-09 03:44:17 +02:00
|
|
|
if filtering switches such as <option>-n</option> or <option>-t</option> are
|
|
|
|
|
used with <option>-L</option>, they will further restrict the items restored.
|
2010-05-15 20:11:07 +02:00
|
|
|
</para>
|
2017-10-09 03:44:17 +02:00
|
|
|
<para><replaceable class="parameter">list-file</replaceable> is normally created by
|
|
|
|
|
editing the output of a previous <option>-l</option> operation.
|
2010-05-15 20:11:07 +02:00
|
|
|
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.
|
2001-03-06 06:22:50 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2009-02-02 21:07:37 +01:00
|
|
|
<varlistentry>
|
2016-09-20 18:00:00 +02:00
|
|
|
<term><option>-n <replaceable class="parameter">schema</replaceable></option></term>
|
2005-06-09 19:56:51 +02:00
|
|
|
<term><option>--schema=<replaceable class="parameter">schema</replaceable></option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2013-08-28 08:43:34 +02:00
|
|
|
Restore only objects that are in the named schema. Multiple schemas
|
2017-10-09 03:44:17 +02:00
|
|
|
may be specified with multiple <option>-n</option> switches. This can be
|
2005-11-01 22:09:51 +01:00
|
|
|
combined with the <option>-t</option> option to restore just a
|
|
|
|
|
specific table.
|
2005-06-09 19:56:51 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2016-09-20 18:00:00 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-N <replaceable class="parameter">schema</replaceable></option></term>
|
|
|
|
|
<term><option>--exclude-schema=<replaceable class="parameter">schema</replaceable></option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Do not restore objects that are in the named schema. Multiple schemas
|
2017-10-09 03:44:17 +02:00
|
|
|
to be excluded may be specified with multiple <option>-N</option> switches.
|
2016-09-20 18:00:00 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
When both <option>-n</option> and <option>-N</option> are given for the same
|
|
|
|
|
schema name, the <option>-N</option> switch wins and the schema is excluded.
|
2016-09-20 18:00:00 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-O</option></term>
|
|
|
|
|
<term><option>--no-owner</option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2003-09-24 00:48:53 +02:00
|
|
|
Do not output commands to set
|
2005-01-04 04:58:16 +01:00
|
|
|
ownership of objects to match the original database.
|
|
|
|
|
By default, <application>pg_restore</application> issues
|
2017-10-09 03:44:17 +02:00
|
|
|
<command>ALTER OWNER</command> or
|
2005-01-04 04:58:16 +01:00
|
|
|
<command>SET SESSION AUTHORIZATION</command>
|
|
|
|
|
statements to set ownership of created schema elements.
|
|
|
|
|
These statements will fail unless the initial connection to the
|
|
|
|
|
database is made by a superuser
|
|
|
|
|
(or the same user that owns all of the objects in the script).
|
|
|
|
|
With <option>-O</option>, any user name can be used for the
|
|
|
|
|
initial connection, and this user will own all the created objects.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-07-04 05:04:55 +02:00
|
|
|
<term><option>-P <replaceable class="parameter">function-name(argtype [, ...])</replaceable></option></term>
|
|
|
|
|
<term><option>--function=<replaceable class="parameter">function-name(argtype [, ...])</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2003-06-11 18:29:42 +02:00
|
|
|
Restore the named function only. Be careful to spell the function
|
2005-01-04 04:58:16 +01:00
|
|
|
name and arguments exactly as they appear in the dump file's table
|
2013-08-28 08:43:34 +02:00
|
|
|
of contents. Multiple functions may be specified with multiple
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>-P</option> switches.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-R</option></term>
|
|
|
|
|
<term><option>--no-reconnect</option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2003-09-24 00:48:53 +02:00
|
|
|
This option is obsolete but still accepted for backwards
|
2005-01-04 04:58:16 +01:00
|
|
|
compatibility.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-s</option></term>
|
|
|
|
|
<term><option>--schema-only</option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
Restore only the schema (data definitions), not data,
|
|
|
|
|
to the extent that schema entries are present in the archive.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
2011-12-17 01:09:38 +01:00
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
This option is the inverse of <option>--data-only</option>.
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
It is similar to, but for historical reasons not identical to,
|
|
|
|
|
specifying
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>--section=pre-data --section=post-data</option>.
|
2011-12-17 01:09:38 +01:00
|
|
|
</para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
(Do not confuse this with the <option>--schema</option> option, which
|
|
|
|
|
uses the word <quote>schema</quote> in a different meaning.)
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
</para>
|
2000-10-12 16:09:37 +02:00
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2000-10-20 15:44:39 +02:00
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-S <replaceable class="parameter">username</replaceable></option></term>
|
|
|
|
|
<term><option>--superuser=<replaceable class="parameter">username</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2002-05-11 00:36:27 +02:00
|
|
|
Specify the superuser user name to use when disabling triggers.
|
2017-10-09 03:44:17 +02:00
|
|
|
This is relevant only if <option>--disable-triggers</option> is used.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-t <replaceable class="parameter">table</replaceable></option></term>
|
|
|
|
|
<term><option>--table=<replaceable class="parameter">table</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2015-07-03 00:13:34 +02:00
|
|
|
Restore definition and/or data of only the named table.
|
2017-10-09 03:44:17 +02:00
|
|
|
For this purpose, <quote>table</quote> includes views, materialized views,
|
2015-07-03 00:13:34 +02:00
|
|
|
sequences, and foreign tables. Multiple tables
|
2017-10-09 03:44:17 +02:00
|
|
|
can be selected by writing multiple <option>-t</option> switches.
|
2015-07-03 00:13:34 +02:00
|
|
|
This option can be combined with the <option>-n</option> option to
|
|
|
|
|
specify table(s) in a particular schema.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<note>
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
When <option>-t</option> is specified, <application>pg_restore</application>
|
2015-07-03 00:13:34 +02:00
|
|
|
makes no attempt to restore any other database objects that the
|
|
|
|
|
selected table(s) might depend upon. Therefore, there is no
|
|
|
|
|
guarantee that a specific-table restore into a clean database will
|
|
|
|
|
succeed.
|
|
|
|
|
</para>
|
|
|
|
|
</note>
|
|
|
|
|
|
|
|
|
|
<note>
|
|
|
|
|
<para>
|
|
|
|
|
This flag does not behave identically to the <option>-t</option>
|
|
|
|
|
flag of <application>pg_dump</application>. There is not currently
|
2017-10-09 03:44:17 +02:00
|
|
|
any provision for wild-card matching in <application>pg_restore</application>,
|
|
|
|
|
nor can you include a schema name within its <option>-t</option>.
|
Clean up some aspects of pg_dump/pg_restore item-selection logic.
Ensure that CREATE DATABASE and related commands are issued when, and
only when, --create is specified. Previously there were scenarios
where using selective-dump switches would prevent --create from having
any effect. For example, it would fail to do anything in pg_restore
if the archive file had been made by a selective dump, because there
would be no TOC entry for the database.
Since we don't issue \connect either if we don't issue CREATE DATABASE,
this could result in unexpectedly restoring objects into the wrong
database.
Also fix pg_restore's selective restore logic so that when an object is
selected to be restored, we also restore its ACL, comment, and security
label if any. Previously there was no way to get the latter properties
except through tedious mucking about with a -L file. If, for some
reason, you don't want these properties, you can match the old behavior
by adding --no-acl etc.
While at it, try to make _tocEntryRequired() a little better organized
and better documented.
Discussion: https://postgr.es/m/32668.1516848577@sss.pgh.pa.us
2018-01-25 20:26:07 +01:00
|
|
|
And, while <application>pg_dump</application>'s <option>-t</option>
|
|
|
|
|
flag will also dump subsidiary objects (such as indexes) of the
|
|
|
|
|
selected table(s),
|
|
|
|
|
<application>pg_restore</application>'s <option>-t</option>
|
|
|
|
|
flag does not include such subsidiary objects.
|
2015-07-03 00:13:34 +02:00
|
|
|
</para>
|
|
|
|
|
</note>
|
|
|
|
|
|
|
|
|
|
<note>
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
In versions prior to <productname>PostgreSQL</productname> 9.6, this flag
|
2015-07-03 00:13:34 +02:00
|
|
|
matched only tables, not any other type of relation.
|
|
|
|
|
</para>
|
|
|
|
|
</note>
|
2000-10-20 15:44:39 +02:00
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-T <replaceable class="parameter">trigger</replaceable></option></term>
|
|
|
|
|
<term><option>--trigger=<replaceable class="parameter">trigger</replaceable></option></term>
|
2000-10-20 15:44:39 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2013-08-28 08:43:34 +02:00
|
|
|
Restore named trigger only. Multiple triggers may be specified with
|
2017-10-09 03:44:17 +02:00
|
|
|
multiple <option>-T</option> switches.
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-v</option></term>
|
|
|
|
|
<term><option>--verbose</option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2020-09-17 18:52:18 +02:00
|
|
|
Specifies verbose mode. This will cause
|
|
|
|
|
<application>pg_restore</application> to output detailed object
|
|
|
|
|
comments and start/stop times to the output file, and progress
|
|
|
|
|
messages to standard error.
|
|
|
|
|
Repeating the option causes additional debug-level messages
|
|
|
|
|
to appear on standard error.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2010-02-19 15:36:45 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-V</option></term>
|
|
|
|
|
<term><option>--version</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Print the <application>pg_restore</application> version and exit.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-x</option></term>
|
|
|
|
|
<term><option>--no-privileges</option></term>
|
|
|
|
|
<term><option>--no-acl</option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
Prevent restoration of access privileges (grant/revoke commands).
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2011-05-25 20:53:26 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>-1</option></term>
|
|
|
|
|
<term><option>--single-transaction</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Execute the restore as a single transaction (that is, wrap the
|
2017-10-09 03:44:17 +02:00
|
|
|
emitted commands in <command>BEGIN</command>/<command>COMMIT</command>). This
|
2011-05-25 20:53:26 +02:00
|
|
|
ensures that either all the commands complete successfully, or no
|
|
|
|
|
changes are applied. This option implies
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>--exit-on-error</option>.
|
2011-05-25 20:53:26 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2002-05-11 00:36:27 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>--disable-triggers</option></term>
|
2002-05-11 00:36:27 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2012-11-12 04:50:24 +01:00
|
|
|
This option is relevant only when performing a data-only restore.
|
2005-01-04 04:58:16 +01:00
|
|
|
It instructs <application>pg_restore</application> to execute commands
|
|
|
|
|
to temporarily disable triggers on the target tables while
|
|
|
|
|
the data is reloaded. Use this if you have referential
|
|
|
|
|
integrity checks or other triggers on the tables that you
|
|
|
|
|
do not want to invoke during data reload.
|
2002-05-11 00:36:27 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2002-11-15 04:11:18 +01:00
|
|
|
Presently, the commands emitted for
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>--disable-triggers</option> must be done as superuser. So you
|
|
|
|
|
should also specify a superuser name with <option>-S</option> or,
|
2012-11-15 06:04:23 +01:00
|
|
|
preferably, run <application>pg_restore</application> as a
|
2017-10-09 03:44:17 +02:00
|
|
|
<productname>PostgreSQL</productname> superuser.
|
2002-05-11 00:36:27 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>--enable-row-security</option></term>
|
2015-09-18 02:56:58 +02:00
|
|
|
<listitem>
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
<para>
|
|
|
|
|
This option is relevant only when restoring the contents of a table
|
2015-09-18 02:56:58 +02:00
|
|
|
which has row security. By default, <application>pg_restore</application> will set
|
2017-11-23 15:39:47 +01:00
|
|
|
<xref linkend="guc-row-security"/> to off, to ensure
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
that all data is restored in to the table. If the user does not have
|
|
|
|
|
sufficient privileges to bypass row security, then an error is thrown.
|
|
|
|
|
This parameter instructs <application>pg_restore</application> to set
|
2017-11-23 15:39:47 +01:00
|
|
|
<xref linkend="guc-row-security"/> to on instead, allowing the user to attempt to restore
|
2015-09-18 02:56:58 +02:00
|
|
|
the contents of the table with row security enabled. This might still
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
fail if the user does not have the right to insert the rows from the
|
|
|
|
|
dump into the table.
|
|
|
|
|
</para>
|
2015-07-03 00:13:34 +02:00
|
|
|
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
<para>
|
2015-09-18 02:56:58 +02:00
|
|
|
Note that this option currently also requires the dump be in <command>INSERT</command>
|
2016-12-23 02:56:50 +01:00
|
|
|
format, as <command>COPY FROM</command> does not support row security.
|
Code review for row security.
Buildfarm member tick identified an issue where the policies in the
relcache for a relation were were being replaced underneath a running
query, leading to segfaults while processing the policies to be added
to a query. Similar to how TupleDesc RuleLocks are handled, add in a
equalRSDesc() function to check if the policies have actually changed
and, if not, swap back the rsdesc field (using the original instead of
the temporairly built one; the whole structure is swapped and then
specific fields swapped back). This now passes a CLOBBER_CACHE_ALWAYS
for me and should resolve the buildfarm error.
In addition to addressing this, add a new chapter in Data Definition
under Privileges which explains row security and provides examples of
its usage, change \d to always list policies (even if row security is
disabled- but note that it is disabled, or enabled with no policies),
rework check_role_for_policy (it really didn't need the entire policy,
but it did need to be using has_privs_of_role()), and change the field
in pg_class to relrowsecurity from relhasrowsecurity, based on
Heikki's suggestion. Also from Heikki, only issue SET ROW_SECURITY in
pg_restore when talking to a 9.5+ server, list Bypass RLS in \du, and
document --enable-row-security options for pg_dump and pg_restore.
Lastly, fix a number of minor whitespace and typo issues from Heikki,
Dimitri, add a missing #include, per Peter E, fix a few minor
variable-assigned-but-not-used and resource leak issues from Coverity
and add tab completion for role attribute bypassrls as well.
2014-09-24 22:32:22 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2006-08-01 20:21:44 +02:00
|
|
|
<varlistentry>
|
2014-03-03 19:02:18 +01:00
|
|
|
<term><option>--if-exists</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2020-09-01 00:33:37 +02:00
|
|
|
Use conditional commands (i.e., add an <literal>IF EXISTS</literal>
|
Clean up some aspects of pg_dump/pg_restore item-selection logic.
Ensure that CREATE DATABASE and related commands are issued when, and
only when, --create is specified. Previously there were scenarios
where using selective-dump switches would prevent --create from having
any effect. For example, it would fail to do anything in pg_restore
if the archive file had been made by a selective dump, because there
would be no TOC entry for the database.
Since we don't issue \connect either if we don't issue CREATE DATABASE,
this could result in unexpectedly restoring objects into the wrong
database.
Also fix pg_restore's selective restore logic so that when an object is
selected to be restored, we also restore its ACL, comment, and security
label if any. Previously there was no way to get the latter properties
except through tedious mucking about with a -L file. If, for some
reason, you don't want these properties, you can match the old behavior
by adding --no-acl etc.
While at it, try to make _tocEntryRequired() a little better organized
and better documented.
Discussion: https://postgr.es/m/32668.1516848577@sss.pgh.pa.us
2018-01-25 20:26:07 +01:00
|
|
|
clause) to drop database objects. This option is not valid
|
2017-10-09 03:44:17 +02:00
|
|
|
unless <option>--clean</option> is also specified.
|
2014-03-03 19:02:18 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
Support --no-comments in pg_dump, pg_dumpall, pg_restore.
We have switches already to suppress other subsidiary object properties,
such as ACLs, security labels, ownership, and tablespaces, so just on
the grounds of symmetry we should allow suppressing comments as well.
Also, commit 0d4e6ed30 added a positive reason to have this feature,
i.e. to allow obtaining the old behavior of selective pg_restore should
anyone desire that.
Recent commits have removed the cases where pg_dump emitted comments on
built-in objects that the restoring user might not have privileges to
comment on, so the original primary motivation for this feature is gone,
but it still seems at least somewhat useful in its own right.
Robins Tharakan, reviewed by Fabrízio Mello
Discussion: https://postgr.es/m/CAEP4nAx22Z4ch74oJGzr5RyyjcyUSbpiFLyeYXX8pehfou92ug@mail.gmail.com
2018-01-25 21:27:24 +01:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--no-comments</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2018-06-26 07:57:53 +02:00
|
|
|
Do not output commands to restore comments, even if the archive
|
|
|
|
|
contains them.
|
Support --no-comments in pg_dump, pg_dumpall, pg_restore.
We have switches already to suppress other subsidiary object properties,
such as ACLs, security labels, ownership, and tablespaces, so just on
the grounds of symmetry we should allow suppressing comments as well.
Also, commit 0d4e6ed30 added a positive reason to have this feature,
i.e. to allow obtaining the old behavior of selective pg_restore should
anyone desire that.
Recent commits have removed the cases where pg_dump emitted comments on
built-in objects that the restoring user might not have privileges to
comment on, so the original primary motivation for this feature is gone,
but it still seems at least somewhat useful in its own right.
Robins Tharakan, reviewed by Fabrízio Mello
Discussion: https://postgr.es/m/CAEP4nAx22Z4ch74oJGzr5RyyjcyUSbpiFLyeYXX8pehfou92ug@mail.gmail.com
2018-01-25 21:27:24 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2014-03-03 19:02:18 +01:00
|
|
|
<varlistentry>
|
2006-10-15 01:07:22 +02:00
|
|
|
<term><option>--no-data-for-failed-tables</option></term>
|
2006-08-01 20:21:44 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2006-10-15 01:07:22 +02:00
|
|
|
By default, table data is restored even if the creation command
|
|
|
|
|
for the table failed (e.g., because it already exists).
|
|
|
|
|
With this option, data for such a table is skipped.
|
Update reference documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
2007-02-01 00:26:05 +01:00
|
|
|
This behavior is useful if the target database already
|
|
|
|
|
contains the desired table contents. For example,
|
2017-10-09 03:44:17 +02:00
|
|
|
auxiliary tables for <productname>PostgreSQL</productname> extensions
|
|
|
|
|
such as <productname>PostGIS</productname> might already be loaded in
|
2006-10-15 01:07:22 +02:00
|
|
|
the target database; specifying this option prevents duplicate
|
|
|
|
|
or obsolete data from being loaded into them.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
This option is effective only when restoring directly into a
|
|
|
|
|
database, not when producing SQL script output.
|
2006-08-01 20:21:44 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2017-05-12 15:15:40 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--no-publications</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Do not output commands to restore publications, even if the archive
|
|
|
|
|
contains them.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2009-01-05 17:54:37 +01:00
|
|
|
<varlistentry>
|
2011-05-25 20:53:26 +02:00
|
|
|
<term><option>--no-security-labels</option></term>
|
2009-01-05 17:54:37 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2011-05-25 20:53:26 +02:00
|
|
|
Do not output commands to restore security labels,
|
|
|
|
|
even if the archive contains them.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2017-05-09 16:58:06 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--no-subscriptions</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Do not output commands to restore subscriptions, even if the archive
|
|
|
|
|
contains them.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2022-01-17 06:51:46 +01:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--no-table-access-method</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Do not output commands to select table access methods.
|
|
|
|
|
With this option, all objects will be created with whichever
|
|
|
|
|
access method is the default during restore.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2011-05-25 20:53:26 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--no-tablespaces</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Do not output commands to select tablespaces.
|
|
|
|
|
With this option, all objects will be created in whichever
|
|
|
|
|
tablespace is the default during restore.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2011-12-17 01:09:38 +01:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--section=<replaceable class="parameter">sectionname</replaceable></option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
Only restore the named section. The section name can be
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>pre-data</option>, <option>data</option>, or <option>post-data</option>.
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
This option can be specified more than once to select multiple
|
|
|
|
|
sections. The default is to restore all sections.
|
2011-12-17 01:09:38 +01:00
|
|
|
</para>
|
|
|
|
|
<para>
|
Rewrite --section option to decouple it from --schema-only/--data-only.
The initial implementation of pg_dump's --section option supposed that the
existing --schema-only and --data-only options could be made equivalent to
--section settings. This is wrong, though, due to dubious but long since
set-in-stone decisions about where to dump SEQUENCE SET items, as seen in
bug report from Martin Pitt. (And I'm not totally convinced there weren't
other bugs, either.) Undo that coupling and instead drive --section
filtering off current-section state tracked as we scan through the TOC
list to call _tocEntryRequired().
To make sure those decisions don't shift around and hopefully save a few
cycles, run _tocEntryRequired() only once per TOC entry and save the result
in a new TOC field. This required minor rejiggering of ACL handling but
also allows a far cleaner implementation of inhibit_data_for_failed_table.
Also, to ensure that pg_dump and pg_restore have the same behavior with
respect to the --section switches, add _tocEntryRequired() filtering to
WriteToc() and WriteDataChunks(), rather than trying to implement section
filtering in an entirely orthogonal way in dumpDumpableObject(). This
required adjusting the handling of the special ENCODING and STDSTRINGS
items, but they were pretty weird before anyway.
Minor other code review for the patch, too.
2012-05-30 05:22:14 +02:00
|
|
|
The data section contains actual table data as well as large-object
|
|
|
|
|
definitions.
|
|
|
|
|
Post-data items consist of definitions of indexes, triggers, rules
|
|
|
|
|
and constraints other than validated check constraints.
|
|
|
|
|
Pre-data items consist of all other data definition items.
|
2011-12-17 01:09:38 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2016-07-07 03:09:26 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>--strict-names</option></term>
|
2016-07-07 03:09:26 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Require that each schema
|
|
|
|
|
(<option>-n</option>/<option>--schema</option>) and table
|
|
|
|
|
(<option>-t</option>/<option>--table</option>) qualifier match at
|
|
|
|
|
least one schema/table in the backup file.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2011-05-25 20:53:26 +02:00
|
|
|
<varlistentry>
|
|
|
|
|
<term><option>--use-set-session-authorization</option></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
Output SQL-standard <command>SET SESSION AUTHORIZATION</command> commands
|
|
|
|
|
instead of <command>ALTER OWNER</command> commands to determine object
|
2011-05-25 20:53:26 +02:00
|
|
|
ownership. This makes the dump more standards-compatible, but
|
|
|
|
|
depending on the history of the objects in the dump, might not restore
|
|
|
|
|
properly.
|
2009-01-05 17:54:37 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2010-02-19 15:36:45 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-?</option></term>
|
|
|
|
|
<term><option>--help</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
Show help about <application>pg_restore</application> command line
|
|
|
|
|
arguments, and exit.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
</variablelist>
|
|
|
|
|
</para>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
<application>pg_restore</application> also accepts
|
2000-10-12 16:09:37 +02:00
|
|
|
the following command line arguments for connection parameters:
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></option></term>
|
|
|
|
|
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
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.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></option></term>
|
|
|
|
|
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
|
2000-10-12 16:09:37 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2005-01-04 04:58:16 +01:00
|
|
|
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.
|
2003-03-24 15:32:51 +01:00
|
|
|
</para>
|
2000-10-12 16:09:37 +02:00
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-U <replaceable>username</replaceable></option></term>
|
2007-02-01 05:39:33 +01:00
|
|
|
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
|
2001-03-06 19:55:57 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-12-11 20:57:32 +01:00
|
|
|
User name to connect as.
|
2001-05-17 23:12:49 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2009-02-26 17:02:39 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-w</option></term>
|
|
|
|
|
<term><option>--no-password</option></term>
|
2009-02-26 17:02:39 +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>
|
|
|
|
|
|
2001-05-17 23:12:49 +02:00
|
|
|
<varlistentry>
|
2002-03-22 20:20:45 +01:00
|
|
|
<term><option>-W</option></term>
|
2007-02-01 05:39:33 +01:00
|
|
|
<term><option>--password</option></term>
|
2001-05-17 23:12:49 +02:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2007-12-11 20:57:32 +01:00
|
|
|
Force <application>pg_restore</application> to prompt for a
|
2009-01-05 17:54:37 +01:00
|
|
|
password before connecting to a database.
|
2007-12-11 20:57:32 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
This option is never essential, since
|
|
|
|
|
<application>pg_restore</application> will automatically prompt
|
|
|
|
|
for a password if the server demands password authentication.
|
|
|
|
|
However, <application>pg_restore</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
|
2007-12-11 20:57:32 +01:00
|
|
|
connection attempt.
|
2001-03-06 19:55:57 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2006-02-12 05:04:32 +01:00
|
|
|
|
|
|
|
|
<varlistentry>
|
2009-01-05 17:54:37 +01:00
|
|
|
<term><option>--role=<replaceable class="parameter">rolename</replaceable></option></term>
|
2006-02-12 05:04:32 +01:00
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2009-01-05 17:54:37 +01:00
|
|
|
Specifies a role name to be used to perform the restore.
|
2017-10-09 03:44:17 +02:00
|
|
|
This option causes <application>pg_restore</application> to issue a
|
|
|
|
|
<command>SET ROLE</command> <replaceable class="parameter">rolename</replaceable>
|
2009-01-05 17:54:37 +01:00
|
|
|
command after connecting to the database. It is useful when the
|
2017-10-09 03:44:17 +02:00
|
|
|
authenticated user (specified by <option>-U</option>) lacks privileges
|
|
|
|
|
needed by <application>pg_restore</application>, but can switch to a role with
|
2009-01-05 17:54:37 +01:00
|
|
|
the required rights. Some installations have a policy against
|
|
|
|
|
logging in directly as a superuser, and use of this option allows
|
|
|
|
|
restores to be performed without violating the policy.
|
2006-02-12 05:04:32 +01:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
</variablelist>
|
|
|
|
|
</para>
|
2001-03-06 19:55:57 +01:00
|
|
|
</refsect1>
|
2000-10-12 16:09:37 +02:00
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1>
|
|
|
|
|
<title>Environment</title>
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><envar>PGHOST</envar></term>
|
2009-02-07 15:31:30 +01:00
|
|
|
<term><envar>PGOPTIONS</envar></term>
|
2002-07-28 17:22:21 +02:00
|
|
|
<term><envar>PGPORT</envar></term>
|
|
|
|
|
<term><envar>PGUSER</envar></term>
|
|
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Default connection parameters
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
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
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><envar>PG_COLOR</envar></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2020-03-09 02:53:22 +01:00
|
|
|
Specifies whether to use 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>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
2002-07-28 17:22:21 +02:00
|
|
|
</variablelist>
|
2007-02-20 19:10:59 +01:00
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
This utility, like most other <productname>PostgreSQL</productname> utilities,
|
|
|
|
|
also uses the environment variables supported by <application>libpq</application>
|
2017-11-23 15:39:47 +01:00
|
|
|
(see <xref linkend="libpq-envars"/>). However, it does not read
|
2012-08-27 21:26:53 +02:00
|
|
|
<envar>PGDATABASE</envar> when a database name is not supplied.
|
2007-02-20 19:10:59 +01:00
|
|
|
</para>
|
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
<refsect1 id="app-pgrestore-diagnostics">
|
|
|
|
|
<title>Diagnostics</title>
|
|
|
|
|
|
2003-03-24 15:32:51 +01:00
|
|
|
<para>
|
|
|
|
|
When a direct database connection is specified using the
|
|
|
|
|
<option>-d</option> option, <application>pg_restore</application>
|
|
|
|
|
internally executes <acronym>SQL</acronym> statements. If you have
|
|
|
|
|
problems running <application>pg_restore</application>, make sure
|
|
|
|
|
you are able to select information from the database using, for
|
2017-11-23 15:39:47 +01:00
|
|
|
example, <xref linkend="app-psql"/>. Also, any default connection
|
2007-02-20 19:10:59 +01:00
|
|
|
settings and environment variables used by the
|
|
|
|
|
<application>libpq</application> front-end library will apply.
|
2003-03-24 15:32:51 +01:00
|
|
|
</para>
|
2000-10-12 16:09:37 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
|
|
|
|
|
<refsect1 id="app-pgrestore-notes">
|
2002-10-12 01:03:48 +02:00
|
|
|
<title>Notes</title>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
2002-02-11 01:14:10 +01:00
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
If your installation has any local additions to the
|
2017-10-09 03:44:17 +02:00
|
|
|
<literal>template1</literal> database, be careful to load the output of
|
2002-10-12 01:03:48 +02:00
|
|
|
<application>pg_restore</application> into a truly empty database;
|
|
|
|
|
otherwise you are likely to get errors due to duplicate definitions
|
|
|
|
|
of the added objects. To make an empty database without any local
|
2017-10-09 03:44:17 +02:00
|
|
|
additions, copy from <literal>template0</literal> not <literal>template1</literal>, for example:
|
2002-02-11 01:14:10 +01:00
|
|
|
<programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
CREATE DATABASE foo WITH TEMPLATE template0;
|
2002-02-11 01:14:10 +01:00
|
|
|
</programlisting>
|
|
|
|
|
</para>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
<para>
|
2002-10-12 01:03:48 +02:00
|
|
|
The limitations of <application>pg_restore</application> are detailed below.
|
2000-10-12 16:09:37 +02:00
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
When restoring data to a pre-existing table and the option
|
2017-10-09 03:44:17 +02:00
|
|
|
<option>--disable-triggers</option> is used,
|
2003-03-24 15:32:51 +01:00
|
|
|
<application>pg_restore</application> emits commands
|
2010-02-19 04:50:03 +01:00
|
|
|
to disable triggers on user tables before inserting the data, then emits commands to
|
2000-10-20 15:44:39 +02:00
|
|
|
re-enable them after the data has been inserted. If the restore is stopped in the
|
Update reference documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
2007-02-01 00:26:05 +01:00
|
|
|
middle, the system catalogs might be left in the wrong state.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
|
|
<listitem>
|
2011-08-07 09:49:45 +02:00
|
|
|
<para><application>pg_restore</application> cannot restore large objects
|
2010-02-19 04:50:03 +01:00
|
|
|
selectively; for instance, only those for a specific table. If
|
2008-09-07 21:12:57 +02:00
|
|
|
an archive contains large objects, then all large objects will be
|
|
|
|
|
restored, or none of them if they are excluded via <option>-L</option>,
|
|
|
|
|
<option>-t</option>, or other options.
|
2000-10-12 16:09:37 +02:00
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
</para>
|
2001-03-06 19:55:57 +01:00
|
|
|
|
|
|
|
|
<para>
|
2017-11-23 15:39:47 +01:00
|
|
|
See also the <xref linkend="app-pgdump"/> documentation for details on
|
2002-10-12 01:03:48 +02:00
|
|
|
limitations of <application>pg_dump</application>.
|
2001-03-06 19:55:57 +01:00
|
|
|
</para>
|
2003-03-18 01:02:11 +01:00
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
Once restored, it is wise to run <command>ANALYZE</command> on each
|
2021-08-16 23:27:52 +02:00
|
|
|
restored table so the optimizer has useful statistics; see
|
|
|
|
|
<xref linkend="vacuum-for-statistics"/> and
|
2017-11-23 15:39:47 +01:00
|
|
|
<xref linkend="autovacuum"/> for more information.
|
2003-03-18 01:02:11 +01:00
|
|
|
</para>
|
|
|
|
|
|
2000-10-12 16:09:37 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
|
|
|
|
|
<refsect1 id="app-pgrestore-examples">
|
2002-10-12 01:03:48 +02:00
|
|
|
<title>Examples</title>
|
2000-10-12 16:09:37 +02:00
|
|
|
|
2000-10-20 15:44:39 +02:00
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
Assume we have dumped a database called <literal>mydb</literal> into a
|
2006-11-26 19:11:11 +01:00
|
|
|
custom-format dump file:
|
2000-10-20 15:44:39 +02:00
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
<screen>
|
2006-11-26 19:11:11 +01:00
|
|
|
<prompt>$</prompt> <userinput>pg_dump -Fc mydb > db.dump</userinput>
|
2001-03-06 19:55:57 +01:00
|
|
|
</screen>
|
2000-10-20 15:44:39 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2006-11-26 19:11:11 +01:00
|
|
|
To drop the database and recreate it from the dump:
|
2000-10-20 15:44:39 +02:00
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
<screen>
|
2006-11-26 19:11:11 +01:00
|
|
|
<prompt>$</prompt> <userinput>dropdb mydb</userinput>
|
|
|
|
|
<prompt>$</prompt> <userinput>pg_restore -C -d postgres db.dump</userinput>
|
2001-10-24 00:11:22 +02:00
|
|
|
</screen>
|
2006-11-26 19:11:11 +01:00
|
|
|
|
2017-10-09 03:44:17 +02:00
|
|
|
The database named in the <option>-d</option> switch can be any database existing
|
|
|
|
|
in the cluster; <application>pg_restore</application> only uses it to issue the
|
|
|
|
|
<command>CREATE DATABASE</command> command for <literal>mydb</literal>. With
|
|
|
|
|
<option>-C</option>, data is always restored into the database name that appears
|
2006-11-26 19:11:11 +01:00
|
|
|
in the dump file.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
To reload the dump into a new database called <literal>newdb</literal>:
|
2006-11-26 19:11:11 +01:00
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
|
<prompt>$</prompt> <userinput>createdb -T template0 newdb</userinput>
|
|
|
|
|
<prompt>$</prompt> <userinput>pg_restore -d newdb db.dump</userinput>
|
|
|
|
|
</screen>
|
|
|
|
|
|
2017-10-09 03:44:17 +02:00
|
|
|
Notice we don't use <option>-C</option>, and instead connect directly to the
|
2006-11-26 19:11:11 +01:00
|
|
|
database to be restored into. Also note that we clone the new database
|
2017-10-09 03:44:17 +02:00
|
|
|
from <literal>template0</literal> not <literal>template1</literal>, to ensure it is
|
2006-11-26 19:11:11 +01:00
|
|
|
initially empty.
|
2001-10-24 00:11:22 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
To reorder database items, it is first necessary to dump the table of
|
|
|
|
|
contents of the archive:
|
|
|
|
|
<screen>
|
2006-11-26 19:11:11 +01:00
|
|
|
<prompt>$</prompt> <userinput>pg_restore -l db.dump > db.list</userinput>
|
2001-10-24 00:11:22 +02:00
|
|
|
</screen>
|
2007-02-01 01:28:19 +01:00
|
|
|
The listing file consists of a header and one line for each item, e.g.:
|
2001-10-24 00:11:22 +02:00
|
|
|
<programlisting>
|
|
|
|
|
;
|
2010-02-23 01:21:19 +01:00
|
|
|
; Archive created at Mon Sep 14 13:55:39 2009
|
|
|
|
|
; dbname: DBDEMOS
|
|
|
|
|
; TOC Entries: 81
|
|
|
|
|
; Compression: 9
|
|
|
|
|
; Dump Version: 1.10-0
|
2001-10-24 00:11:22 +02:00
|
|
|
; Format: CUSTOM
|
2010-02-23 01:21:19 +01:00
|
|
|
; Integer: 4 bytes
|
|
|
|
|
; Offset: 8 bytes
|
|
|
|
|
; Dumped from database version: 8.3.5
|
|
|
|
|
; Dumped by pg_dump version: 8.3.8
|
2001-10-24 00:11:22 +02:00
|
|
|
;
|
|
|
|
|
;
|
|
|
|
|
; Selected TOC Entries:
|
|
|
|
|
;
|
2010-02-23 01:21:19 +01:00
|
|
|
3; 2615 2200 SCHEMA - public pasha
|
|
|
|
|
1861; 0 0 COMMENT - SCHEMA public pasha
|
|
|
|
|
1862; 0 0 ACL - public pasha
|
|
|
|
|
317; 1247 17715 TYPE public composite pasha
|
|
|
|
|
319; 1247 25899 DOMAIN public domain0 pasha
|
2001-10-24 00:11:22 +02:00
|
|
|
</programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
Semicolons start a comment, and the numbers at the start of lines refer to the
|
2001-10-24 00:11:22 +02:00
|
|
|
internal archive ID assigned to each item.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
2007-02-01 01:28:19 +01:00
|
|
|
Lines in the file can be commented out, deleted, and reordered. For example:
|
2001-10-24 00:11:22 +02:00
|
|
|
<programlisting>
|
|
|
|
|
10; 145433 TABLE map_resolutions postgres
|
|
|
|
|
;2; 145344 TABLE species postgres
|
|
|
|
|
;4; 145359 TABLE nt_header postgres
|
|
|
|
|
6; 145402 TABLE species_records postgres
|
|
|
|
|
;8; 145416 TABLE ss_old postgres
|
|
|
|
|
</programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
could be used as input to <application>pg_restore</application> and would only restore
|
|
|
|
|
items 10 and 6, in that order:
|
2001-10-24 00:11:22 +02:00
|
|
|
<screen>
|
2006-11-26 19:11:11 +01:00
|
|
|
<prompt>$</prompt> <userinput>pg_restore -L db.list db.dump</userinput>
|
2011-08-07 09:49:45 +02:00
|
|
|
</screen></para>
|
2000-10-20 15:44:39 +02:00
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
2000-10-20 15:44:39 +02:00
|
|
|
|
2001-03-06 19:55:57 +01:00
|
|
|
<simplelist type="inline">
|
2017-11-23 15:39:47 +01:00
|
|
|
<member><xref linkend="app-pgdump"/></member>
|
|
|
|
|
<member><xref linkend="app-pg-dumpall"/></member>
|
|
|
|
|
<member><xref linkend="app-psql"/></member>
|
2001-03-06 19:55:57 +01:00
|
|
|
</simplelist>
|
2000-10-12 16:09:37 +02:00
|
|
|
</refsect1>
|
|
|
|
|
</refentry>
|
