database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-06-26 12:21:12 +03:00
Code Activity

Improve pg_dump/pg_dumpall help synopses and terminology

Browse Source 
Increase consistency of --help and man page synopses between pg_dump
and pg_dumpall.  These should now be very similar, as pg_dumpall can
now also produce non-text dump output.  But actually, they had drifted
further apart.

- Use verb "export" consistently, instead of "dump" or "extract".
- Use "SQL script" instead of just "script" or "text file".
- Maintain consistent distinction between SQL script and other
  formats/archives (which is relevant for pg_restore).

Reviewed-by: Robert Treat <rob@xzilla.net>
Discussion: https://www.postgresql.org/message-id/flat/3f71d8a7-095b-4829-9b0b-fce09e9866b3%40eisentraut.org
This commit is contained in:
Peter Eisentraut
2025-06-19 13:53:12 +02:00
parent 1546e17f9d
commit dec6643487
5 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/sgml/ref/pg_dump.sgml
View File

@ -18,7 +18,7 @@ PostgreSQL documentation
<refname>pg_dump</refname> <refname>pg_dump</refname>
<refpurpose> <refpurpose>
extract a <productname>PostgreSQL</productname> database into a script file or other archive file export a <productname>PostgreSQL</productname> database as an SQL script or to other formats
</refpurpose> </refpurpose>
</refnamediv> </refnamediv>

7
doc/src/sgml/ref/pg_dumpall.sgml
View File

@ -16,7 +16,10 @@ PostgreSQL documentation
<refnamediv> <refnamediv>
<refname>pg_dumpall</refname> <refname>pg_dumpall</refname>
<refpurpose>extract a <productname>PostgreSQL</productname> database cluster using a specified dump format</refpurpose>
<refpurpose>
export a <productname>PostgreSQL</productname> database cluster as an SQL script or to other formats
</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
@ -33,7 +36,7 @@ PostgreSQL documentation
<para> <para>
<application>pg_dumpall</application> is a utility for writing out <application>pg_dumpall</application> is a utility for writing out
(<quote>dumping</quote>) all <productname>PostgreSQL</productname> databases (<quote>dumping</quote>) all <productname>PostgreSQL</productname> databases
of a cluster into an archive. The archive contains 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 <acronym>SQL</acronym> commands that can be used as input to <xref
linkend="app-psql"/> to restore the databases. It does this by linkend="app-psql"/> to restore the databases. It does this by
calling <xref linkend="app-pgdump"/> for each database in the cluster. calling <xref linkend="app-pgdump"/> for each database in the cluster.

4
doc/src/sgml/ref/pg_restore.sgml
View File

@ -18,8 +18,8 @@ PostgreSQL documentation
<refname>pg_restore</refname> <refname>pg_restore</refname>
<refpurpose> <refpurpose>
restore a <productname>PostgreSQL</productname> database or cluster restore <productname>PostgreSQL</productname> databases from archives
from an archive created by <application>pg_dump</application> or created by <application>pg_dump</application> or
<application>pg_dumpall</application> <application>pg_dumpall</application>
</refpurpose> </refpurpose>
</refnamediv> </refnamediv>

2
src/bin/pg_dump/pg_dump.c
View File

@ -1235,7 +1235,7 @@ main(int argc, char **argv)
static void static void
help(const char *progname) help(const char *progname)
{ {
printf(_("%s dumps a database as a text file or to other formats.\n\n"), progname); printf(_("%s exports a PostgreSQL database as an SQL script or to other formats.\n\n"), progname);
printf(_("Usage:\n")); printf(_("Usage:\n"));
printf(_(" %s [OPTION]... [DBNAME]\n"), progname); printf(_(" %s [OPTION]... [DBNAME]\n"), progname);

2
src/bin/pg_dump/pg_dumpall.c
View File

@ -699,7 +699,7 @@ main(int argc, char *argv[])
static void static void
help(void) help(void)
{ {
printf(_("%s extracts a PostgreSQL database cluster based on specified dump format.\n\n"), progname); printf(_("%s exports a PostgreSQL database cluster as an SQL script or to other formats.\n\n"), progname);
printf(_("Usage:\n")); printf(_("Usage:\n"));
printf(_(" %s [OPTION]...\n"), progname); printf(_(" %s [OPTION]...\n"), progname);