From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: harukat@sraoss.co.jp
To: pgsql-bugs@lists.postgresql.org
Subject: Re: BUG #18952: pg_restore --help and document have strange description: Dump something
Date: Wed, 11 Jun 2025 10:04:24 +0900
Message-ID: <df4a3f45-3559-4fa0-9ae9-d1fbb1b4bb42@oss.nttdata.com> (raw)
In-Reply-To: <18952-be40a620f8b1e755@postgresql.org>
References: <18952-be40a620f8b1e755@postgresql.org>
On 2025/06/10 16:35, PG Bug reporting form wrote:
> The following bug has been logged on the website:
>
> Bug reference: 18952
> Logged by: TAKATSUKA Haruka
> Email address: harukat@sraoss.co.jp
> PostgreSQL version: 18beta1
> Operating system: any
> Description:
>
> pg_restore --help has strange description like "Dump .....":
> [dbhost]$ LANG=C pg_restore --help
> pg_restore restores PostgreSQL databases from archives created by pg_dump or
> pg_dumpall.
> Usage:
> pg_restore [OPTION]... [FILE]
> (snip)
> --with-data dump the data
> --with-schema dump the schema
> --with-statistics dump the statistics
> Connection options:
> -h, --host=HOSTNAME database server host or socket directory
> (snip)
> https://www.postgresql.org/docs/18/app-pgrestore.html also have the
> following description.
> --with-data
> Dump data. This is the default.
> --with-schema
> Dump schema (data definitions). This is the default.
> --with-statistics
> Dump statistics. This is the default.
Thanks for the report!
Are you suggesting that "dump" in the help message and docs should be "restore"?
If so, does the attached patch address that correctly?
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
From 42d796b2dfa09c4f45502c804f7939331d285af8 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 11 Jun 2025 09:53:14 +0900
Subject: [PATCH v1] pg_restore: Fix wrong descriptions of
--with-{schema,data,statistics} options.
Commit bde2fb797aa added the --with-schema, --with-data, and --with-statistics
options to pg_restore. These options control whether to restore schema, data,
or statistics if present in the archive. However, the help message and
documentation incorrectly described them as affecting what gets dumped.
This commit corrects those descriptions to clarify that the options control
restoration, not dumping.
---
doc/src/sgml/ref/pg_restore.sgml | 9 ++++++---
src/bin/pg_dump/pg_restore.c | 6 +++---
2 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgmlindex 2295df62d03..8c88b07dcc8 100644--- a/doc/src/sgml/ref/pg_restore.sgml+++ b/doc/src/sgml/ref/pg_restore.sgml@@ -923,7 +923,8 @@ PostgreSQL documentation
<term><option>--with-data</option></term>
<listitem>
<para>
- Dump data. This is the default.+ Output commands to restore data, if the archive contains them.+ This is the default.
</para>
</listitem>
</varlistentry>
@@ -932,7 +933,8 @@ PostgreSQL documentation
<term><option>--with-schema</option></term>
<listitem>
<para>
- Dump schema (data definitions). This is the default.+ Output commands to restore schema (data definitions), if the archive+ contains them. This is the default.
</para>
</listitem>
</varlistentry>
@@ -941,7 +943,8 @@ PostgreSQL documentation
<term><option>--with-statistics</option></term>
<listitem>
<para>
- Dump statistics. This is the default.+ Output commands to restore statistics, if the archive contains them.+ This is the default.
</para>
</listitem>
</varlistentry>
diff --git a/src/bin/pg_dump/pg_restore.c b/src/bin/pg_dump/pg_restore.cindex f2182e91825..c4b6214d618 100644--- a/src/bin/pg_dump/pg_restore.c+++ b/src/bin/pg_dump/pg_restore.c@@ -712,9 +712,9 @@ usage(const char *progname)
printf(_(" --use-set-session-authorization\n"
" use SET SESSION AUTHORIZATION commands instead of\n"
" ALTER OWNER commands to set ownership\n"));
- printf(_(" --with-data dump the data\n"));- printf(_(" --with-schema dump the schema\n"));- printf(_(" --with-statistics dump the statistics\n"));+ printf(_(" --with-data restore the data\n"));+ printf(_(" --with-schema restore the schema\n"));+ printf(_(" --with-statistics restore the statistics\n"));
printf(_("\nConnection options:\n"));
printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
--
2.49.0
Attachments:
[text/plain] v1-0001-pg_restore-Fix-wrong-descriptions-of-with-schema-.patch (3.0K, ../df4a3f45-3559-4fa0-9ae9-d1fbb1b4bb42@oss.nttdata.com/2-v1-0001-pg_restore-Fix-wrong-descriptions-of-with-schema-.patch)
download | inline diff:
From 42d796b2dfa09c4f45502c804f7939331d285af8 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 11 Jun 2025 09:53:14 +0900
Subject: [PATCH v1] pg_restore: Fix wrong descriptions of
--with-{schema,data,statistics} options.
Commit bde2fb797aa added the --with-schema, --with-data, and --with-statistics
options to pg_restore. These options control whether to restore schema, data,
or statistics if present in the archive. However, the help message and
documentation incorrectly described them as affecting what gets dumped.
This commit corrects those descriptions to clarify that the options control
restoration, not dumping.
---
doc/src/sgml/ref/pg_restore.sgml | 9 ++++++---
src/bin/pg_dump/pg_restore.c | 6 +++---
2 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgmlindex 2295df62d03..8c88b07dcc8 100644--- a/doc/src/sgml/ref/pg_restore.sgml+++ b/doc/src/sgml/ref/pg_restore.sgml@@ -923,7 +923,8 @@ PostgreSQL documentation
<term><option>--with-data</option></term>
<listitem>
<para>
- Dump data. This is the default.+ Output commands to restore data, if the archive contains them.+ This is the default.
</para>
</listitem>
</varlistentry>
@@ -932,7 +933,8 @@ PostgreSQL documentation
<term><option>--with-schema</option></term>
<listitem>
<para>
- Dump schema (data definitions). This is the default.+ Output commands to restore schema (data definitions), if the archive+ contains them. This is the default.
</para>
</listitem>
</varlistentry>
@@ -941,7 +943,8 @@ PostgreSQL documentation
<term><option>--with-statistics</option></term>
<listitem>
<para>
- Dump statistics. This is the default.+ Output commands to restore statistics, if the archive contains them.+ This is the default.
</para>
</listitem>
</varlistentry>
diff --git a/src/bin/pg_dump/pg_restore.c b/src/bin/pg_dump/pg_restore.cindex f2182e91825..c4b6214d618 100644--- a/src/bin/pg_dump/pg_restore.c+++ b/src/bin/pg_dump/pg_restore.c@@ -712,9 +712,9 @@ usage(const char *progname)
printf(_(" --use-set-session-authorization\n"
" use SET SESSION AUTHORIZATION commands instead of\n"
" ALTER OWNER commands to set ownership\n"));
- printf(_(" --with-data dump the data\n"));- printf(_(" --with-schema dump the schema\n"));- printf(_(" --with-statistics dump the statistics\n"));+ printf(_(" --with-data restore the data\n"));+ printf(_(" --with-schema restore the schema\n"));+ printf(_(" --with-statistics restore the statistics\n"));
printf(_("\nConnection options:\n"));
printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
--
2.49.0
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-bugs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, harukat@sraoss.co.jp, pgsql-bugs@lists.postgresql.org
Subject: Re: BUG #18952: pg_restore --help and document have strange description: Dump something
In-Reply-To: <df4a3f45-3559-4fa0-9ae9-d1fbb1b4bb42@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox