database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-24 10:47:04 +03:00
Code

Doc: clarify explanation of pg_dump usage.

Browse Source 
This section confusingly used both "infile" and "outfile" to refer
to the same file, i.e. the textual output of pg_dump.  Use "dumpfile"
for both cases, per suggestion from Jonathan Katz.

Discussion: https://postgr.es/m/152311295239.31235.6487236091906987117@wrigleys.postgresql.org
This commit is contained in:
Tom Lane 2018-04-08 16:35:42 -04:00
parent 4f85f66469
commit 893e9e6540
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/sgml/backup.sgml
View File

@ -35,7 +35,7 @@
<xref linkend="app-pgdump"/> for this purpose. The basic usage of this <xref linkend="app-pgdump"/> for this purpose. The basic usage of this
command is: command is:
<synopsis> <synopsis>
pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">outfile</replaceable> pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">dumpfile</replaceable>
</synopsis> </synopsis>
As you see, <application>pg_dump</application> writes its result to the As you see, <application>pg_dump</application> writes its result to the
standard output. We will see below how this can be useful. standard output. We will see below how this can be useful.
@ -109,9 +109,9 @@ pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable cl
be read in by the <application>psql</application> program. The be read in by the <application>psql</application> program. The
general command form to restore a dump is general command form to restore a dump is
<synopsis> <synopsis>
psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class="parameter">infile</replaceable> psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class="parameter">dumpfile</replaceable>
</synopsis> </synopsis>
where <replaceable class="parameter">infile</replaceable> is the where <replaceable class="parameter">dumpfile</replaceable> is the
file output by the <application>pg_dump</application> command. The database <replaceable file output by the <application>pg_dump</application> command. The database <replaceable
class="parameter">dbname</replaceable> will not be created by this class="parameter">dbname</replaceable> will not be created by this
command, so you must create it yourself from <literal>template0</literal> command, so you must create it yourself from <literal>template0</literal>
@ -141,7 +141,7 @@ psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class
behavior and have <application>psql</application> exit with an behavior and have <application>psql</application> exit with an
exit status of 3 if an SQL error occurs: exit status of 3 if an SQL error occurs:
<programlisting> <programlisting>
psql --set ON_ERROR_STOP=on dbname &lt; infile psql --set ON_ERROR_STOP=on dbname &lt; dumpfile
</programlisting> </programlisting>
Either way, you will only have a partially restored database. Either way, you will only have a partially restored database.
Alternatively, you can specify that the whole dump should be Alternatively, you can specify that the whole dump should be
@ -201,11 +201,11 @@ pg_dump -h <replaceable>host1</replaceable> <replaceable>dbname</replaceable> |
cluster, and also preserves cluster-wide data such as role and cluster, and also preserves cluster-wide data such as role and
tablespace definitions. The basic usage of this command is: tablespace definitions. The basic usage of this command is:
<synopsis> <synopsis>
pg_dumpall &gt; <replaceable>outfile</replaceable> pg_dumpall &gt; <replaceable>dumpfile</replaceable>
</synopsis> </synopsis>
The resulting dump can be restored with <application>psql</application>: The resulting dump can be restored with <application>psql</application>:
<synopsis> <synopsis>
psql -f <replaceable class="parameter">infile</replaceable> postgres psql -f <replaceable class="parameter">dumpfile</replaceable> postgres
</synopsis> </synopsis>
(Actually, you can specify any existing database name to start from, (Actually, you can specify any existing database name to start from,
but if you are loading into an empty cluster then <literal>postgres</literal> but if you are loading into an empty cluster then <literal>postgres</literal>