pg_restore: Fix wrong descriptions of --with-{schema,data,statistics} options. master github/master
authorFujii Masao <fujii@postgresql.org>
Thu, 12 Jun 2025 14:25:21 +0000 (23:25 +0900)
committerFujii Masao <fujii@postgresql.org>
Thu, 12 Jun 2025 14:25:21 +0000 (23:25 +0900)
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.

Bug: #18952
Reported-by: TAKATSUKA Haruka <harukat@sraoss.co.jp>
Author: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: TAKATSUKA Haruka <harukat@sraoss.co.jp>
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Discussion: https://postgr.es/m/18952-be40a620f8b1e755@postgresql.org

doc/src/sgml/ref/pg_restore.sgml
src/bin/pg_dump/pg_restore.c

index 2295df62d03a802489701dec207dc74334494ff2..8c88b07dcc8657c500db4b7eb862457f08caef30 100644 (file)
@@ -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>
index f2182e918256098930d2b79528e06d22f6ec94fb..c4b6214d618cd5bbc79c253ddb1feda4d1c93e14 100644 (file)
@@ -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"));