<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.29 2001/03/06 05:22:18 pjw Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.30 2001/03/06 18:55:57 petere Exp $
Postgres documentation
-->
<refentry id="APP-PGDUMP">
<docinfo>
- <date>2000-12-25</date>
+ <date>2001-03-06</date>
</docinfo>
<refmeta>
- <refentrytitle id="app-pgdump-title">
- <application>pg_dump</application>
+ <refentrytitle>
+ pg_dump
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>pg_dump</application>
- </refname>
+ <refname>pg_dump</refname>
+
<refpurpose>
Extract a <productname>Postgres</productname> database into a script file or other archive file
</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>2000-11-22</date>
- </refsynopsisdivinfo>
- <synopsis>
-pg_dump [ <replaceable class="parameter">dbname</replaceable> ]
-pg_dump [ -h <replaceable class="parameter">host</replaceable> ]
- [ -p <replaceable class="parameter">port</replaceable> ]
- [ -t <replaceable class="parameter">table</replaceable> ]
- [ -a ] [ -b ] [ -c ] [-C] [ -d ] [ -D ]
- [-f <REPLACEABLE CLASS="PARAMETER">file</REPLACEABLE>]
- [-F <REPLACEABLE CLASS="PARAMETER">format</REPLACEABLE>]
- [ -i ] [ -n ] [ -N ] [ -o ] [ -O ] [-R]
- [ -s ] [ -S ] [ -u ] [ -v ] [ -x ] [ -Z 0..9 ]
- [ <replaceable class="parameter">dbname</replaceable> ]
- </synopsis>
-
- <refsect2 id="R2-APP-PG-DUMP-1">
- <refsect2info>
- <date>2000-11-22</date>
- </refsect2info>
- <title>
- Inputs
- </title>
+ <cmdsynopsis>
+ <command>pg_dump</command>
+ <group> <arg>-a</arg> <arg>-s</arg> </group>
+ <arg>-b</arg>
+ <arg>-c</arg>
+ <arg>-C</arg>
+ <group> <arg>-d</arg> <arg>-D</arg> </group>
+ <arg>-f <replaceable>file</replaceable></arg>
+ <arg>-F <replaceable>format</replaceable></arg>
+ <arg>-i</arg>
+ <sbr>
+ <group> <arg>-n</arg> <arg>-N</arg> </group>
+ <arg>-o</arg>
+ <arg>-O</arg>
+ <arg>-R</arg>
+ <arg>-S</arg>
+ <arg>-t <replaceable>table</replaceable></arg>
+ <arg>-v</arg>
+ <arg>-x</arg>
+ <arg>-Z <replaceable>0...9</replaceable></arg>
+ <sbr>
+ <arg>-h <replaceable>host</replaceable></arg>
+ <arg>-p <replaceable>port</replaceable></arg>
+ <arg>-u</arg>
+ <sbr>
+ <arg choice="plain"><replaceable>dbname</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+
+ <refsect1 id="pg-dump-description">
+ <title>
+ Description
+ </title>
+
+ <para>
+ <command>pg_dump</command> is a utility for dumping out a
+ <productname>Postgres</productname> database into a script or archive
+ file containing query commands. The script files are in text format
+ and can be used to reconstruct the database, even on other machines
+ and other architectures.
+ The archive files, new with version 7.1, contain enough information for
+ <xref linkend="app-pgrestore"> to rebuild the database, but also
+ allow <command>pg_restore</command> to be selective about what is restored, or even to
+ reorder the items prior to being restored. The archive files are
+ also designed to be portable across architectures.
+ </para>
+
+ <para>
+ <command>pg_dump</command>
+ will produce the queries necessary to re-generate all
+ user-defined types, functions, tables, indices, aggregates, and
+ operators. In addition, all the data is copied out in text format so
+ that it can be readily copied in again, as well as imported into tools
+ for editing.
+ </para>
+
+ <para>
+ <command>pg_dump</command>
+ is useful for dumping out the contents of a database to move from one
+ <productname>Postgres</productname> installation to another. After running
+ <command>pg_dump</command>,
+ one should examine the output for any warnings, especially
+ in light of the limitations listed below.
+ </para>
+
+ <para>
+ When used with one of the alternate file formats and combined with
+ <command>pg_restore</command>, it provides a flexible archival
+ and transfer mechanism. <command>pg_dump</command> can be used
+ to backup an entire database, then <command>pg_restore</command>
+ can be used to examine the archive and/or select which parts of the
+ database are to be restored.
+ See the <xref linkend="app-pgrestore"> documentation for details.
+ </para>
+
+ <refsect2 id="pg-dump-options">
+ <title>Options</title>
+
<para>
- <application>pg_dump</application> accepts the following command
- line arguments:
+ <command>pg_dump</command> accepts the following command
+ line arguments. (Long option forms are only available on some platforms.)
<variablelist>
<varlistentry>
<listitem>
<para>
Specifies the name of the database to be extracted.
- <replaceable class="parameter">dbname</replaceable>
- defaults to the value of the
- <envar>USER</envar>
- environment variable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
+ <term>--data-only</term>
<listitem>
<para>
- Dump out only the data, no schema (definitions).
+ Dump only the data, not the schema (definitions).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-b</term>
+ <term>--blobs</term>
<listitem>
<para>
- Dump data and BLOB data.
+ Dump data and <acronym>BLOB</acronym> data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-c</term>
+ <term>--clean</term>
<listitem>
<para>
- Clean (drop) schema prior to create.
+ Dump commands to clean (drop) the schema prior to (the
+ commands for) creating it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-C</term>
+ <term>--create</term>
<listitem>
<para>
- For plain text (script) output, include SQL to create the database itself.
+ For plain text (script) output, include commands to create the database itself.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d</term>
+ <term>--inserts</term>
<listitem>
<para>
- Dump data as proper insert strings. This is not recommended for large databases
- for performance reasons.
+ Dump data as proper <command>INSERT</command> commands (not
+ <command>COPY</command>). This will make restoration very
+ slow.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D</term>
+ <term>--attribute-inserts</term>
<listitem>
<para>
- Dump data as inserts with attribute names. This is not recommended for large databases
- for performance reasons.
+ Dump data as <command>INSERT</command> commands with explicit
+ column names. This will make restoration very slow.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f <replaceable class="parameter">file</replaceable></term>
+ <term>--file=<replaceable class="parameter">file</replaceable></term>
<listitem>
<para>
Send output to the specified file.
<varlistentry>
<term>-F <replaceable class="parameter">format</replaceable></term>
+ <term>--format=<replaceable class="parameter">format</replaceable></term>
<listitem>
<para>
Format can be one of the following:
- </para>
-
<variablelist>
<varlistentry>
<term>p</term>
<listitem>
<para>
- output a plain text SQL script file (default)
+ output a plain text <acronym>SQL</acronym> script file (default)
</para>
</listitem>
</varlistentry>
<term>t</term>
<listitem>
<para>
- output a TAR archive suitable for input into
- <APPLICATION>pg_restore</APPLICATION>. Using this archive format
+ output a <filename>tar</filename> archive suitable for input into
+ <command>pg_restore</command>. Using this archive format
allows reordering and/or exclusion of schema elements
at the time the database is restored. It is also possible to limit
which data is reloaded at restore time.
<listitem>
<para>
output a custom archive suitable for input into
- <APPLICATION>pg_restore</APPLICATION>. This is the most flexible
+ <command>pg_restore</command>. This is the most flexible
format in that it allows reordering of data load as well
as schema elements. This format is also compressed by default.
</para>
</varlistentry>
</variablelist>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>-i</term>
+ <term>--ignore-version</term>
<listitem>
<para>
- Ignore version mismatch between <application>pg_dump</application>
- and the database server. Since <application>pg_dump</application>
+ Ignore version mismatch between <command>pg_dump</command>
+ and the database server. Since <command>pg_dump</command>
knows a great deal about system catalogs, any given version of
- <application>pg_dump</application> is only intended to work with
+ <command>pg_dump</command> is only intended to work with
the corresponding release of the database server. Use this option
if you need to override the version check (and if
- <application>pg_dump</application> then fails, don't
+ <command>pg_dump</command> then fails, don't
say you weren't warned).
</para>
</listitem>
<varlistentry>
<term>-n</term>
+ <term>--no-quotes</term>
<listitem>
<para>
Suppress double quotes around identifiers unless absolutely necessary.
This may cause trouble loading this dumped data if there are reserved words
used for identifiers.
This was the default behavior for
- <application>pg_dump</application> prior to v6.4.
+ <command>pg_dump</command> prior to version 6.4.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-N</term>
+ <term>--quotes</term>
<listitem>
<para>
Include double quotes around identifiers.
<varlistentry>
<term>-o</term>
+ <term>--oids</term>
<listitem>
<para>
Dump object identifiers (<acronym>OID</acronym>s) for every table.
<varlistentry>
<term>-O</term>
+ <term>--no-owner</term>
<listitem>
<para>
- In plain text output mode, don't set object ownership to match the
- original database. Typically, <APPLICATION>pg_dump</APPLICATION>
- issues <PROGRAMLISTING>\connect</PROGRAMLISTING> statments to set
- ownership of schema elements.
+ In plain text output mode, do not set object ownership to
+ match the original database. Typically,
+ <command>pg_dump</command> issues
+ (<command>psql</command>-specific) <command>\connect</command>
+ statements to set ownership of schema elements.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-R</term>
+ <term>--no-reconnect</term>
<listitem>
<para>
- In plain text output mode, prohibit <APPLICATION>pg_dump</APPLICATION>
- from issuing any <PROGRAMLISTING>\connect</PROGRAMLISTING> statements.
+ In plain text output mode, prohibit <command>pg_dump</command>
+ from issuing any <command>\connect</command> statements.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
+ <term>--schema-only</term>
<listitem>
<para>
- Dump out only the schema (definitions), no data.
+ Dump only the schema (definitions), no data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-S <replaceable class="parameter">username</replaceable></term>
+ <term>--superuser=<replaceable class="parameter">username</replaceable></term>
<listitem>
<para>
- Specify the superuser username to use when disabling triggers and/or
+ Specify the superuser user name to use when disabling triggers and/or
setting ownership of schema elements.
</para>
</listitem>
<varlistentry>
<term>-t <replaceable class="parameter">table</replaceable></term>
+ <term>--table=<replaceable class="parameter">table</replaceable></term>
<listitem>
<para>
Dump data for <replaceable class="parameter">table</replaceable> only.
</listitem>
</varlistentry>
- <varlistentry>
- <term>-u</term>
- <listitem>
- <para>
- Use password authentication. Prompts for username and password.
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>-v</term>
+ <term>--verbose</term>
<listitem>
<para>
Specifies verbose mode.
<varlistentry>
<term>-x</term>
+ <term>--no-acl</term>
<listitem>
<para>
Prevent dumping of ACLs (grant/revoke commands) and table ownership information.
<varlistentry>
<term>-Z <replaceable class="parameter">0..9</replaceable></term>
+ <term>--compress=<replaceable class="parameter">0..9</replaceable></term>
<listitem>
<para>
Specify the compression level to use in archive formats that support
</variablelist>
</para>
<para>
- <application>pg_dump</application> also accepts
+ <command>pg_dump</command> also accepts
the following command line arguments for connection parameters:
<variablelist>
<varlistentry>
<term>-h <replaceable class="parameter">host</replaceable></term>
+ <term>--host=<replaceable class="parameter">host</replaceable></term>
<listitem>
<para>
- Specifies the hostname of the machine on which the
- <application>postmaster</application>
+ Specifies the host name of the machine on which the
+ <command>postmaster</command>
is running. If host begins with a slash, it is used
- as the directory for the unix domain socket.
+ as the directory for the Unix domain socket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">port</replaceable></term>
+ <term>--port=<replaceable class="parameter">port</replaceable></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or local Unix domain socket file
- extension on which the <application>postmaster</application>
+ extension on which the <command>postmaster</command>
is listening for connections. The port number defaults to 5432,
or the value of the <envar>PGPORT</envar>
environment variable (if set).
</para>
</refsect2>
- <refsect2 id="R2-APP-PG-DUMP-2">
- <refsect2info>
- <date>1998-11-05</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- <application>pg_dump</application> will create a file or
- write to <filename>stdout</filename>.
+ </refsect1>
- <variablelist>
- <varlistentry>
- <term><computeroutput>
+
+ <refsect1 id="app-pgdump-diagnostics">
+ <title>Diagnostics</title>
+
+ <msgset>
+ <msgentry>
+ <msg>
+ <msgmain>
+ <msgtext>
+<screen><computeroutput>
Connection to database 'template1' failed.
connectDBStart() -- connect() failed: No such file or directory
Is the postmaster running locally
and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'?
- </computeroutput></term>
- <listitem>
+</computeroutput></screen>
+ </msgtext>
+ </msgmain>
+ </msg>
+
+ <msgexplan>
<para>
- <application>pg_dump</application> could not attach to the
- <application>postmaster</application>
+ <command>pg_dump</command> could not attach to the
+ <command>postmaster</command>
process on the specified host and port. If you see this message,
- ensure that the <application>postmaster</application>
+ ensure that the <command>postmaster</command>
is running on the proper host and that you have specified the proper
- port. If your site uses an authentication system, ensure that you
- have obtained the required authentication credentials.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><computeroutput>
-Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
-FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
- </computeroutput></term>
- <listitem>
- <para>
- You do not have a valid entry in the relation <literal>pg_shadow</literal>
- and and will not be allowed to access <productname>Postgres</productname>.
- Contact your <productname>Postgres</productname> administrator.
+ port.
</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><computeroutput>
+ </msgexplan>
+ </msgentry>
+
+ <msgentry>
+ <msg>
+ <msgmain>
+ <msgtext>
+<screen><computeroutput>
dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed
- </computeroutput></term>
- <listitem>
+</computeroutput></screen>
+ </msgtext>
+ </msgmain>
+ </msg>
+
+ <msgexplan>
<para>
You do not have permission to read the database.
Contact your <productname>Postgres</productname> site administrator.
</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </msgexplan>
+ </msgentry>
+ </msgset>
<note>
<para>
- <application>pg_dump</application> internally executes
+ <command>pg_dump</command> internally executes
<command>SELECT</command> statements. If you have problems running
- <application>pg_dump</application>,
+ <command>pg_dump</command>,
make sure you are able to select information from the database using, for
- example, <application>psql</application>.
+ example, <xref linkend="app-psql">.
</para>
</note>
- </refsect2>
- </refsynopsisdiv>
-
- <refsect1 id="R1-APP-PG-DUMP-1">
- <refsect1info>
- <date>2000-</date>
- </refsect1info>
- <title>
- Description
- </title>
- <para>
- <application>pg_dump</application> is a utility for dumping out a
- <productname>Postgres</productname> database into a script or archive
- file containing query commands. The script files are in text format
- and can be used to reconstruct the database, even on other machines
- and other architectures.
- </para>
- <para>
- The archive files, new with version 7.1, contain enough information for
- <APPLICATION>pg_restore</APPLICATION> to rebuild the database, but also
- allow pg_restore to be selective about what is restored, or even to
- reorder the items prior to being restored. The archive files should
- also be portable across architectures.
- </para>
- <para>
- <application>pg_dump</application>
- will produce the queries necessary to re-generate all
- user-defined types, functions, tables, indices, aggregates, and
- operators. In addition, all the data is copied out in text format so
- that it can be readily copied in again, as well as imported into tools
- for editing.
- </para>
-
- <para>
- <application>pg_dump</application>
- is useful for dumping out the contents of a database to move from one
- <productname>Postgres</productname> installation to another. After running
- <application>pg_dump</application>,
- one should examine the output for any warnings, especially
- in light of the limitations listed below.
- </para>
-
- <para>
- When used with one of the alternate file formats and combined with
- <APPLICATION>pg_restore</APPLICATION>, it provides a flexible archival
- and trasfer mechanism. <APPLICATION>pg_dump</APPLICATION> can be used
- to backup an entire database, then <APPLICATION>pg_restore</APPLICATION>
- can be used to examine the archive and/or select which parts of the
- database are to be restored.
- </para>
-
- <para>
- See the <APPLICATION>pg_restore</APPLICATION> documentation for details.
- </para>
-
</refsect1>
- <refsect1 id="R1-APP-PG-DUMP-2">
- <refsect1info>
- <date>2000-11-21</date>
- </refsect1info>
- <title>
- Notes
- </title>
+
+ <refsect1 id="pg-dump-notes">
+ <title>Notes</title>
<para>
- <application>pg_dump</application> has a few limitations.
+ <command>pg_dump</command> has a few limitations.
The limitations mostly stem from
difficulty in extracting certain meta-information from the system
catalogs.
<itemizedlist>
<listitem>
<para>
- <application>pg_dump</application>
- does not understand partial indices. The reason is
- the same as above; partial index predicates are stored as plans.
- </para>
- </listitem>
-
- <listitem>
- <para>
- When dumping a single table or as plain text, <application>pg_dump</application>
+ When dumping a single table or as plain text, <command>pg_dump</command>
does not handle large objects. Large objects must be dumped in their
- entirity using one of the binary archive formats.
+ entirety using one of the binary archive formats.
</para>
</listitem>
<listitem>
<para>
- When doing a data only dump, <application>pg_dump</application> emits queries
+ When doing a data only dump, <command>pg_dump</command> emits queries
to disable triggers on user tables before inserting the data and queries to
re-enable them after the data has been inserted. If the restore is stopped
in the middle, the system catalogs may be left in the wrong state.
</para>
</refsect1>
- <refsect1 id="R1-APP-PG-DUMP-3">
- <refsect1info>
- <date>2000-11-21</date>
- </refsect1info>
- <title>
- Usage
- </title>
- <para>
- To dump a database of the same name as the user:
+ <refsect1 id="pg-dump-examples">
+ <title>Examples</title>
- <programlisting>
-$ pg_dump > db.out
- </programlisting>
+ <para>
+ To dump a database:
+<screen>
+<prompt>$</prompt> <userinput>pg_dump mydb > db.out</userinput>
+</screen>
</para>
<para>
To reload this database:
-
- <programlisting>
-$ psql -e database < db.out
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>psql -d database -f db.out</userinput>
+</screen>
</para>
<para>
- To dump a database called mydb that contains BLOBs to a TAR file:
+ To dump a database called mydb that contains
+ <acronym>BLOB</acronym>s to a <filename>tar</filename> file:
- <programlisting>
-$ pg_dump -Ft --blobs mydb > db.tar
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>pg_dump -Ft -b mydb > db.tar</userinput>
+</screen>
</para>
<para>
- To reload this database (with BLOBs) to an existing db called newdb:
+ To reload this database (with <acronym>BLOB</acronym>s) to an
+ existing database called newdb:
- <programlisting>
-$ pg_restore db.tar --dbname=newdb
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>pg_restore -d newdb db.tar</userinput>
+</screen>
</para>
</refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <simplelist type="inline">
+ <member><xref linkend="app-pg-dumpall"></member>
+ <member><xref linkend="app-pgrestore"></member>
+ <member><xref linkend="app-psql"></member>
+ <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member>
+ </simplelist>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.9 2001/03/06 18:55:57 petere Exp $ -->
+
<refentry id="APP-PGRESTORE">
+ <docinfo>
+ <date>2001-03-06</date>
+ </docinfo>
+
<refmeta>
- <refentrytitle id="app-pgrestore-title">
- <application>pg_restore</application>
+ <refentrytitle>
+ pg_restore
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- <application>pg_restore</application>
- </refname>
+ <refname>pg_restore</refname>
+
<refpurpose>
Restore a <PRODUCTNAME>Postgres</PRODUCTNAME> database from an archive file created by
-<APPLICATION>pg_dump</APPLICATION>
+<command>pg_dump</command>
</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>2000-10-11</date>
- </refsynopsisdivinfo>
- <synopsis>
-pg_restore [ <replaceable class="parameter">archive-file</replaceable> ]
- [ -h <replaceable class="parameter">host</replaceable> ]
- [ -p <replaceable class="parameter">port</replaceable> ]
- [ -t <replaceable class="parameter">table</replaceable> ]
- [ -a ] [ -c ] [-C] [-d <replaceable class="parameter">name</replaceable>]
- [ -f <replaceable class="parameter">archive-file</replaceable>]
- [ -F <replaceable class="parameter">format</replaceable>]
- [ -i <replaceable class="parameter">index</replaceable> ]
- [ -l ] [ -L <replaceable class="parameter">contents-file</replaceable> ]
- [ -N ] [ -o ] [ -O ]
- [ -P <replaceable class="parameter">function-name</replaceable> ] [ -r ] [ -R ]
- [ -s ] [ -S ] { -T <replaceable class="parameter">trigger</replaceable> ] [ -u ]
- [ -v ] [ -x ]
- </synopsis>
-
- <refsect2 id="R2-APP-PG-RESTORE-1">
- <refsect2info>
- <date>2000-10-11</date>
- </refsect2info>
+ <cmdsynopsis>
+ <command>pg_restore</command>
+ <arg> -a </arg>
+ <arg> -c </arg>
+ <arg> -C </arg>
+ <arg> -d <replaceable class="parameter">dbname</replaceable> </arg>
+ <arg> -f <replaceable class="parameter">archive-file</replaceable> </arg>
+ <arg> -F <replaceable class="parameter">format</replaceable> </arg>
+ <arg> -i <replaceable class="parameter">index</replaceable> </arg>
+ <sbr>
+ <arg> -l </arg>
+ <arg> -L <replaceable class="parameter">contents-file</replaceable> </arg>
+ <group> <arg> -N </arg> <arg> -o </arg> <arg> -r </arg> </group>
+ <arg> -O </arg>
+ <arg> -P <replaceable class="parameter">function-name</replaceable> </arg>
+ <arg> -R </arg>
+ <arg> -s </arg>
+ <arg> -S </arg>
+ <arg> -t <replaceable class="parameter">table</replaceable> </arg>
+ <arg> -T <replaceable class="parameter">trigger</replaceable> </arg>
+ <arg> -v </arg>
+ <arg> -x </arg>
+ <sbr>
+ <arg> -h <replaceable class="parameter">host</replaceable> </arg>
+ <arg> -p <replaceable class="parameter">port</replaceable> </arg>
+ <arg> -u </arg>
+ <sbr>
+ <arg> <replaceable class="parameter">archive-file</replaceable> </arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+
+ <refsect1 id="app-pgrestore-description">
+ <title>
+ Description
+ </title>
+
+ <para>
+ <command>pg_restore</command> is a utility for restoring a
+ <productname>Postgres</productname> database dumped by
+ <xref linkend="app-pgdump"> in one of the non-plain-text formats.
+ </para>
+
+ <para>
+ The archive files, new with the 7.1 release, contain enough information for
+ <command>pg_restore</command> to rebuild the database, but also allow
+ <command>pg_restore</command> 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. <command>pg_dump</command> will
+ produce the queries necessary to re-generate all user-defined types, functions,
+ tables, indices, aggregates, and operators. In addition, all the data is copied
+ out (in text format for scripts) so that it can be readily copied in again.
+ </para>
+
+ <para>
+ <command>pg_restore</command> reads the archive file and outputs the appropriate
+ SQL in the required order based on the command parameters. Obviously, it can not restore
+ information that is not present in the dump file; so if the dump is made using the
+ <quote>dump data as <command>INSERT</command>s</quote> option, <command>pg_restore</command> will not be able to
+ load the data using <command>COPY</command> statements.
+ </para>
+
+ <para>
+ The most flexible output file format is the <quote>custom</quote> format (<option>-Fc</option>). It allows for
+ selection and reordering of all archived items, and is compressed by default. The <filename>tar</filename>
+ format (<option>-Ft</option>) is not compressed and it is not possible to reorder
+ data when loading, but it is otherwise quite flexible.
+ </para>
+
+ <para>
+ To reorder the items, it is first necessary to dump the contents of the archive:
+<screen>
+<prompt>$</prompt> <userinput>pg_restore archive.file -l > archive.list</userinput>
+</screen>
+ This file consists of a header and one line for each item, e.g.,
+<programlisting>
+;
+; Archive created at Fri Jul 28 22:28:36 2000
+; dbname: birds
+; TOC Entries: 74
+; Compression: 0
+; Dump Version: 1.4-0
+; Format: CUSTOM
+;
+;
+; Selected TOC Entries:
+;
+2; 145344 TABLE species postgres
+3; 145344 ACL species
+4; 145359 TABLE nt_header postgres
+5; 145359 ACL nt_header
+6; 145402 TABLE species_records postgres
+7; 145402 ACL species_records
+8; 145416 TABLE ss_old postgres
+9; 145416 ACL ss_old
+10; 145433 TABLE map_resolutions postgres
+11; 145433 ACL map_resolutions
+12; 145443 TABLE hs_old postgres
+13; 145443 ACL hs_old
+</programlisting>
+ Semi-colons are comment delimiters, and the numbers at the start of lines refer to the
+ internal archive ID assigned to each item.
+ </para>
+
+ <para>
+ Lines in the file can be commented out, deleted, and reordered. For example,
+<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>
+ could be used as input to <command>pg_restore</command> and would only restore
+ items 10 and 6, in that order.
+<screen>
+<prompt>$</prompt> <userinput>pg_restore archive.file -L archive.list</userinput>
+</screen>
+ </para>
+
+ <refsect2 id="app-pgrestore-options">
<title>
- Inputs
+ Options
</title>
+
<para>
- <application>pg_restore</application> accepts the following command
- line arguments:
+ <command>pg_restore</command> accepts the following command
+ line arguments. (Long option forms are only available on some platforms.)
<variablelist>
<varlistentry>
<listitem>
<para>
Specifies the location of the archive file to be restored.
- If not specified, and no '-f' option is specified, then STDIN is used.
+ If not specified, and no <option>-f</option> option is specified, then the standard input is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
+ <term>--data-only</term>
<listitem>
<para>
Restore only the data, no schema (definitions).
<varlistentry>
<term>-c</term>
+ <term>--clean</term>
<listitem>
<para>
Clean (drop) schema prior to create.
<varlistentry>
<term>-C</term>
+ <term>--create</term>
<listitem>
<para>
Include SQL to create the schema.
<varlistentry>
<term>-d <replaceable class="parameter">dbname</replaceable></term>
+ <term>--dbname=<replaceable class="parameter">dbname</replaceable></term>
<listitem>
<para>
Connect to database <replaceable class="parameter">dbname</replaceable> and restore
</varlistentry>
<varlistentry>
- <term>-f</term>
+ <term>-f <replaceable>filename</replaceable></term>
+ <term>--file=<replaceable>filename</replaceable></term>
<listitem>
<para>
- Specify output file for generated script. Default is STDOUT.
+ Specify output file for generated script. (Use with the
+ <option>-l</option> option.) Default is the standard output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-F <replaceable class="parameter">format</replaceable></term>
+ <term>--format=<replaceable class="parameter">format</replaceable></term>
<listitem>
<para>
Specify format of the archive.
- It is not necessary to specify the format, since <APPLICATION>pg_restore</APPLICATION> will
+ It is not necessary to specify the format, since <COMMAND>pg_restore</COMMAND> will
determine the format automatically. If specified, it can be one of the following:
</para>
<term>t</term>
<listitem>
<para>
- archive is a TAR archive. Using this archive format allows reordering and/or
+ Archive is a <filename>tar</filename> archive. Using this archive format allows reordering and/or
exclusion of schema elements at the time the database is restored. It is also possible to limit which
data is reloaded at restore time.
</para>
<term>c</term>
<listitem>
<para>
- archive is in the custom format from pg_dump. This is the most flexible format
+ Archive is in the custom format of <command>pg_dump</command>. This is the most flexible format
in that it allows reordering of data load as well as schema elements.
This format is also compressed by default.
</para>
<varlistentry>
<term>-i <replaceable class="parameter">index</replaceable></term>
+ <term>--index=<replaceable class="parameter">index</replaceable></term>
<listitem>
<para>
Restore definition for named <replaceable class="parameter">index</replaceable> only.
<varlistentry>
<term>-l</term>
+ <term>--list</term>
<listitem>
<para>
- List the contents of the archive. The output of this command can be used with the '-U, --use-list' option
+ List the contents of the archive. The output of this command can be used with the <option>-L</option> option
to restrict and reorder the items that are restored.
</para>
</listitem>
<varlistentry>
<term>-L <replaceable class="parameter">list-file</replaceable></term>
+ <term>--use-list=<replaceable class="parameter">list-file</replaceable></term>
<listitem>
<para>
- Restore elements in <REPLACEABLE CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the
- order they appear in the file. Lines can be moved and may also be commented out by placing
- a ';' at the start of the line.
+ Restore elements in <REPLACEABLE CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the
+ order they appear in the file. Lines can be moved and may also be commented out by placing a ';' at the
+ start of the line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-N</term>
+ <term>--orig-order</term>
<listitem>
<para>
- Restore items in the original dump order. By default pg_dump will dump items in an order convenient
- to pg_dump, then save the archive in a modified OID order. This option overrides the OID ordering.
+ Restore items in the original dump order. By default <command>pg_dump</command> will dump items in an order convenient
+ to <command>pg_dump</command>, then save the archive in a modified OID order. This option overrides the OID ordering.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-o</term>
+ <term>--oid-order</term>
<listitem>
<para>
- Restore items in the OID order. By default pg_dump will dump items in an order convenient
- to pg_dump, then save the archive in a modified OID order. This option enforces strict OID ordering.
+ Restore items in the OID order. By default <command>pg_dump</command> will dump items in an order convenient
+ to <command>pg_dump</command>, then save the archive in a modified OID order. This option enforces strict OID ordering.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-O</term>
+ <term>--no-owner</term>
<listitem>
<para>
- Prevent any attempt to restore original object ownership. Objects will be owned by the username used
+ Prevent any attempt to restore original object ownership. Objects will be owned by the user name used
to attach to the database.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-P <replaceable class="parameter">procedure-name</replaceable></term>
+ <term>-P <replaceable class="parameter">function-name</replaceable></term>
+ <term>--function=<replaceable class="parameter">function-name</replaceable></term>
<listitem>
<para>
Specify a procedure or function to be restored.
<varlistentry>
<term>-r</term>
+ <term>--rearrange</term>
<listitem>
<para>
- Restore items in modified OID order. By default pg_dump will dump items in an order convenient
- to pg_dump, then save the archive in a modified OID order. Most objects
- will be restored in OID order, but some things (eg. RULES & INDEXES) will be restored at the end of
+ Restore items in modified OID order. By default <command>pg_dump</command> will dump items in an order convenient
+ to <command>pg_dump</command>, then save the archive in a modified OID order. Most objects
+ will be restored in OID order, but some things (e.g., rules and indices) will be restored at the end of
the process irrespective of their OIDs. This option is the default.
</para>
</listitem>
<varlistentry>
<term>-R</term>
+ <term>--no-reconnect</term>
<listitem>
<para>
- Prohibit <
APPLICATION>pg_restore</APPLICATION> from issuing any <PROGRAMLISTING>\connect</PROGRAMLISTING>
+ Prohibit <
COMMAND>pg_restore</COMMAND> from issuing any <PROGRAMLISTING>\connect</PROGRAMLISTING>
statements or reconnecting to the database if directly connected.
</para>
</listitem>
<varlistentry>
<term>-s</term>
+ <term>--schema-only</term>
<listitem>
<para>
Restore the schema (definitions), no data. Sequence values will be reset.
<varlistentry>
<term>-S <replaceable class="parameter">username</replaceable></term>
+ <term>--superuser=<replaceable class="parameter">username</replaceable></term>
<listitem>
<para>
- Specify the superuser username to use when disabling triggers and/or setting ownership of schema elements.
- By default, <APPLICATION>pg_restore</APPLICATION> will use the current username if it is a superuser.
+ Specify the superuser user name to use when disabling triggers and/or setting ownership of schema elements.
+ By default, <COMMAND>pg_restore</COMMAND> will use the current user name if it is a superuser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-t <replaceable class="parameter">table</replaceable></term>
+ <term>--table=<replaceable class="parameter">table</replaceable></term>
<listitem>
<para>
Restore schema/data for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> only.
<varlistentry>
<term>-T <replaceable class="parameter">trigger</replaceable></term>
+ <term>--trigger=<replaceable class="parameter">trigger</replaceable></term>
<listitem>
<para>
Restore definition of <REPLACEABLE CLASS="PARAMETER">trigger</REPLACEABLE> only.
</listitem>
</varlistentry>
- <varlistentry>
- <term>-u</term>
- <listitem>
- <para>
- Use password authentication. Prompts for username and password.
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>-v</term>
+ <term>--verbose</term>
<listitem>
<para>
Specifies verbose mode.
<varlistentry>
<term>-x</term>
+ <term>--no-acl</term>
<listitem>
<para>
Prevent restoration of ACLs (grant/revoke commands).
</variablelist>
</para>
+
<para>
- <application>pg_restore</application> also accepts
+ <command>pg_restore</command> also accepts
the following command line arguments for connection parameters:
<variablelist>
<varlistentry>
<term>-h <replaceable class="parameter">host</replaceable></term>
+ <term>--host=<replaceable class="parameter">host</replaceable></term>
<listitem>
<para>
- Specifies the hostname of the machine on which the
- <application>postmaster</application>
+ Specifies the host name of the machine on which the
+ <command>postmaster</command>
is running. If host begins with a slash, it is used
- as the directory for the unix domain socket.
+ as the directory for the Unix domain socket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p <replaceable class="parameter">port</replaceable></term>
+ <term>--port=<replaceable class="parameter">port</replaceable></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or local Unix domain socket file
- extension on which the <application>postmaster</application>
+ extension on which the <command>postmaster</command>
is listening for connections. The port number defaults to 5432,
or the value of the <envar>PGPORT</envar>
environment variable (if set).
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>-u</term>
+ <listitem>
+ <para>
+ Use password authentication. Prompts for user name and password.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect2>
- <refsect2 id="R2-APP-PG-RESTORE-2">
- <refsect2info>
- <date>2000-10-11</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- <application>pg_restore</application> will create a script file,
- write to <filename>stdout</filename>, or restore a database directly.
+ </refsect1>
- <variablelist>
- <varlistentry>
- <term><computeroutput>
+
+ <refsect1 id="app-pgrestore-diagnostics">
+ <title>Diagnostics</title>
+
+ <msgset>
+ <msgentry>
+ <msg>
+ <msgmain>
+ <msgtext>
+<screen><computeroutput>
Connection to database 'template1' failed.
connectDBStart() -- connect() failed: No such file or directory
Is the postmaster running locally
and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'?
- </computeroutput></term>
- <listitem>
+</computeroutput></screen>
+ </msgtext>
+ </msgmain>
+ </msg>
+
+ <msgexplan>
<para>
- <application>pg_restore</application> could not attach to the
- <application>postmaster</application>
+ <command>pg_restore</command> could not attach to the
+ <command>postmaster</command>
process on the specified host and port. If you see this message,
- ensure that the <application>postmaster</application>
+ ensure that the <command>postmaster</command>
is running on the proper host and that you have specified the proper
port. If your site uses an authentication system, ensure that you
have obtained the required authentication credentials.
</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><computeroutput>
-Connection to database '<replaceable class="parameter">dbname</replaceable>' failed.
-FATAL 1: SetUserId: user '<replaceable class="parameter">username</replaceable>' is not in 'pg_shadow'
- </computeroutput></term>
- <listitem>
- <para>
- You do not have a valid entry in the relation <literal>pg_shadow</literal>
- and and will not be allowed to access <productname>Postgres</productname>.
- Contact your <productname>Postgres</productname> administrator.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </para>
+ </msgexplan>
+ </msgentry>
+ </msgset>
<note>
<para>
- When a direct database connection is specified using the -d option, <application>pg_restore</application>
+ When a direct database connection is specified using the -d option, <command>pg_restore</command>
internally executes <command>SQL</command> statements. If you have problems running
- <application>pg_restore</application>,
+ <command>pg_restore</command>,
make sure you are able to select information from the database using, for
- example, <application>psql</application>.
+ example, <command>psql</command>.
</para>
</note>
- </refsect2>
- </refsynopsisdiv>
-
- <refsect1 id="R1-APP-PG-RESTORE-1">
- <refsect1info>
- <date>2000-10-11</date>
- </refsect1info>
- <title>
- Description
- </title>
- <para>
- <application>pg_restore</application> is a utility for restoring a
- <productname>Postgres</productname> database dumped by <application>pg_dump</application>
- from any one of the non-plain-text output formats.
- </para>
-
- <para>
- The archive files, new with this relase, contain enough information for
- <application>pg_restore</application> to rebuild the database, but 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 should
- also be portable across architectures. <application>pg_dump</application> will
- produce the queries necessary to re-generate all user-defined types, functions,
- tables, indices, aggregates, and operators. In addition, all the data is copied
- out (in text format for scripts) so that it can be readily copied in again.
- </para>
-
- <para>
- <application>pg_restore</application> reads the archive file and outputs the appropriate
- SQL in the required order based on the command parameters. Obviously, it can not restore
- information that is not present in the dump file; so if the dump is made using the
- 'dump data as inserts' option, <application>pg_restore</application> will not be able to
- load the data using <command>COPY</command> statements.
- </para>
-
- <para>
- The most flexible output file format is the new 'custom' format (-Fc). It allows for
- selection and reordering of all archived items, and is compressed by default. The TAR
- format (-Ft) is not compressed and it is not possible to reorder
- data when loading, but it is otherwise quite flexible.
- </para>
-
- <para>
- To reorder the items, it is first necessary to dump the contents of the archive:
- <programlisting>
- $ pg_restore archive.file --list > archive.lis
- </programlisting>
- This file consists of a header and one line for each item, eg.
- <programlisting>
-;
-; Archive created at Fri Jul 28 22:28:36 2000
-; dbname: birds
-; TOC Entries: 74
-; Compression: 0
-; Dump Version: 1.4-0
-; Format: CUSTOM
-;
-;
-; Selected TOC Entries:
-;
-2; 145344 TABLE species postgres
-3; 145344 ACL species
-4; 145359 TABLE nt_header postgres
-5; 145359 ACL nt_header
-6; 145402 TABLE species_records postgres
-7; 145402 ACL species_records
-8; 145416 TABLE ss_old postgres
-9; 145416 ACL ss_old
-10; 145433 TABLE map_resolutions postgres
-11; 145433 ACL map_resolutions
-12; 145443 TABLE hs_old postgres
-13; 145443 ACL hs_old
-</programlisting>
-
- Where semi-colons are comment delimiters, and the numbers at the start of lines refer to the
- internal archive ID assigned to each item. Lines in the file can be commented out, deleted,
- and/or reordered. For example,
- <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>
- </para>
- <para>
- Could be used as input to <application>pg_restore</application> and would only restore
- items 10 and 6, in that order.
- <programlisting>
- $ pg_restore acrhive.file --use=archive.lis
- </programlisting>
- </para>
-
</refsect1>
- <refsect1 id="R1-APP-PG-RESTORE-2">
- <refsect1info>
- <date>2000-10-11</date>
- </refsect1info>
+
+ <refsect1 id="app-pgrestore-notes">
<title>
Notes
</title>
+
<para>
- See the <application>pg_dump</application> section for details on limitation of
- <application>pg_dump</application>.
- </para>
- <para>
- The limitations of pg_restore are detailed below.
+ The limitations of <command>pg_restore</command> are detailed below.
<itemizedlist>
<listitem>
<para>
- When restoring data to a table, <application>pg_restore</application> emits queries
+ When restoring data to a table, <command>pg_restore</command> emits queries
to disable triggers on user tables before inserting the data then emits queries to
re-enable them after the data has been inserted. If the restore is stopped in the
middle, the system catalogs may be left in the wrong state.
<listitem>
<para>
- <application>pg_restore</application> will not restore BLOBs for a single table. If
+ <command>pg_restore</command> will not restore BLOBs for a single table. If
an archive contains BLOBs, then all BLOBs will be restored.
</para>
</listitem>
</itemizedlist>
</para>
+
+ <para>
+ See the <xref linkend="app-pgdump"> documentation for details on
+ limitation of <command>pg_dump</command>.
+ </para>
</refsect1>
- <refsect1 id="R1-APP-PG-RESTORE-3">
- <refsect1info>
- <date>2000-10-11</date>
- </refsect1info>
+
+ <refsect1 id="app-pgrestore-examples">
<title>
- Usage
+ Examples
</title>
- <para>
- To create a custom archive for a database of the same name as the user:
- <programlisting>
-$ pg_dump -Fc > db.out
- </programlisting>
+ <para>
+ To dump a database:
+<screen>
+<prompt>$</prompt> <userinput>pg_dump mydb > db.out</userinput>
+</screen>
</para>
<para>
To reload this database:
-
- <programlisting>
-$ pg_restore db.out | psql -e database
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>psql -d database -f db.out</userinput>
+</screen>
</para>
<para>
- To dump a database called mydb that contains BLOBs to a TAR file:
+ To dump a database called mydb that contains
+ <acronym>BLOB</acronym>s to a <filename>tar</filename> file:
- <programlisting>
-$ pg_dump -Ft mydb --blobs > db.tar
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>pg_dump -Ft -b mydb > db.tar</userinput>
+</screen>
</para>
<para>
- To reload this database (with BLOBs) to an existing db called newdb:
+ To reload this database (with <acronym>BLOB</acronym>s) to an
+ existing database called newdb:
- <programlisting>
-$ pg_restore db.tar --db=newdb
- </programlisting>
+<screen>
+<prompt>$</prompt> <userinput>pg_restore -d newdb db.tar</userinput>
+</screen>
</para>
+ </refsect1>
+
+
+ <refsect1>
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member><xref linkend="app-pgdump"></member>
+ <member><xref linkend="app-pg-dumpall"></member>
+ <member><xref linkend="app-psql"></member>
+ <member><citetitle>PostgreSQL Administrator's Guide</citetitle></member>
+ </simplelist>
</refsect1>
</refentry>
projects / postgresql / commitdiff