upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-03-30 06:16:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc: clarify introductory description of pg_dumpall.

Browse source 
Add a sentence that describes the parts of a cluster's state that are
*not* included in the output.

Also swap two sentences in the introductory paragraph.  Without that,
it is not clear what the "it" at the beginning of the second sentence
is referring to.  Also add a reference to pg_restore, since not all
output formats are restored with pg_dump.

Also clarify the recently-added text about where different output
formats go, and relocate it above the ancillary text about having
to run as superuser.

Reported-by: Dimitre Radoulov <cichomitiko@gmail.com>
Author: Laurenz Albe <laurenz.albe@cybertec.at>
Reviewed-by: Tom Lane <tgl@sss.pgh.pa.us>
Discussion: https://postgr.es/m/CAGJBphSX2oMPPu=VM4U8NP4+qffFH_483tFQCJ_s-mOcN3DLDw@mail.gmail.com
This commit is contained in:
Tom Lane 2026-03-29 13:53:17 -04:00
parent 01d58d7e3f
commit e7b809ae75
1 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/src/sgml/ref/pg_dumpall.sgml
View file

@ -36,14 +36,33 @@ PostgreSQL documentation
<para>
<application>pg_dumpall</application> is a utility for writing out
(<quote>dumping</quote>) all <productname>PostgreSQL</productname> databases
of a cluster into an SQL script file or an archive. The output contains
<acronym>SQL</acronym> commands that can be used as input to <xref
linkend="app-psql"/> to restore the databases. It does this by
of a cluster into an SQL script file or an archive. It does this by
calling <xref linkend="app-pgdump"/> for each database in the cluster.
The output contains <acronym>SQL</acronym> commands that can be used
as input to <xref linkend="app-psql"/> or <xref linkend="app-pgrestore"/>
to restore the databases.
<application>pg_dumpall</application> also dumps global objects
that are common to all databases, namely database roles, tablespaces,
and privilege grants for configuration parameters.
(<application>pg_dump</application> does not save these objects.)
The only parts of a database cluster's state that
are <emphasis>not</emphasis> included in the default output
of <application>pg_dumpall</application> are the configuration files
and any database parameter setting changes made with
<xref linkend="sql-altersystem"/>.
</para>
<para>
If the output format is a
plain text SQL script, it will be written to the standard output. Use the
<option>-f</option>/<option>--file</option> option or shell operators to
redirect it into a file.
</para>
<para>
If another output format is selected, the archive will be placed in a
directory named using the <option>-f</option>/<option>--file</option>
option, which is required in this case.
</para>
<para>
@ -54,17 +73,6 @@ PostgreSQL documentation
allowed to add roles and create databases.
</para>
<para>
Plain text SQL scripts will be written to the standard output. Use the
<option>-f</option>/<option>--file</option> option or shell operators to
redirect it into a file.
</para>
<para>
Archives in other formats will be placed in a directory named using the
<option>-f</option>/<option>--file</option>, which is required in this case.
</para>
<para>
<application>pg_dumpall</application> needs to connect several
times to the <productname>PostgreSQL</productname> server (once per