From 10f55448965f9af3a62070dce840c5c701561630 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Tue, 3 Sep 2019 14:25:26 +0200 Subject: [PATCH] Clarify pg_dump documentation Clarify in the help output and documentation that -n, -t etc. take a "pattern" rather than a "schema" or "table" etc. This was especially confusing now that the new pg_dumpall --exclude-database option was documented with "pattern" and the others not, even though they all behave the same. Discussion: https://www.postgresql.org/message-id/flat/b85f3fa1-b350-38d1-1893-4f7911bd7310%402ndquadrant.com --- doc/src/sgml/ref/pg_dump.sgml | 42 +++++++++++++++++------------------ src/bin/pg_dump/pg_dump.c | 10 ++++----- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 017713f6e4..4bcd4bdaef 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -375,17 +375,17 @@ PostgreSQL documentation - - + + Dump only schemas matching schema; this selects both the + class="parameter">pattern; this selects both the schema itself, and all its contained objects. When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be - selected by writing multiple switches. Also, the - schema parameter is + selected by writing multiple switches. The + pattern parameter is interpreted as a pattern according to the same rules used by psql's \d commands (see ), @@ -417,12 +417,12 @@ PostgreSQL documentation - - + + - Do not dump any schemas matching the schema pattern. The pattern is + Do not dump any schemas matching pattern. The pattern is interpreted according to the same rules as for . can be given more than once to exclude schemas matching any of several patterns. @@ -513,16 +513,16 @@ PostgreSQL documentation - - + + Dump only tables with names matching - table. + pattern. For this purpose, table includes views, materialized views, sequences, and foreign tables. Multiple tables - can be selected by writing multiple switches. Also, the - table parameter is + can be selected by writing multiple switches. The + pattern parameter is interpreted as a pattern according to the same rules used by psql's \d commands (see ), @@ -565,12 +565,12 @@ PostgreSQL documentation - - + + - Do not dump any tables matching the table pattern. The pattern is + Do not dump any tables matching pattern. The pattern is interpreted according to the same rules as for . can be given more than once to exclude tables matching any of several patterns. @@ -728,11 +728,11 @@ PostgreSQL documentation - + - Do not dump data for any tables matching the table pattern. The pattern is + Do not dump data for any tables matching pattern. The pattern is interpreted according to the same rules as for . can be given more than once to exclude tables matching any of several patterns. This option is diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index 34981401bf..7ec0c84540 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -1000,14 +1000,14 @@ help(const char *progname) printf(_(" -c, --clean clean (drop) database objects before recreating\n")); printf(_(" -C, --create include commands to create database in dump\n")); printf(_(" -E, --encoding=ENCODING dump the data in encoding ENCODING\n")); - printf(_(" -n, --schema=SCHEMA dump the named schema(s) only\n")); - printf(_(" -N, --exclude-schema=SCHEMA do NOT dump the named schema(s)\n")); + printf(_(" -n, --schema=PATTERN dump the specified schema(s) only\n")); + printf(_(" -N, --exclude-schema=PATTERN do NOT dump the specified schema(s)\n")); printf(_(" -O, --no-owner skip restoration of object ownership in\n" " plain-text format\n")); printf(_(" -s, --schema-only dump only the schema, no data\n")); printf(_(" -S, --superuser=NAME superuser user name to use in plain-text format\n")); - printf(_(" -t, --table=TABLE dump the named table(s) only\n")); - printf(_(" -T, --exclude-table=TABLE do NOT dump the named table(s)\n")); + printf(_(" -t, --table=PATTERN dump the specified table(s) only\n")); + printf(_(" -T, --exclude-table=PATTERN do NOT dump the specified table(s)\n")); printf(_(" -x, --no-privileges do not dump privileges (grant/revoke)\n")); printf(_(" --binary-upgrade for use by upgrade utilities only\n")); printf(_(" --column-inserts dump data as INSERT commands with column names\n")); @@ -1015,7 +1015,7 @@ help(const char *progname) printf(_(" --disable-triggers disable triggers during data-only restore\n")); printf(_(" --enable-row-security enable row security (dump only content user has\n" " access to)\n")); - printf(_(" --exclude-table-data=TABLE do NOT dump data for the named table(s)\n")); + printf(_(" --exclude-table-data=PATTERN do NOT dump data for the specified table(s)\n")); printf(_(" --extra-float-digits=NUM override default setting for extra_float_digits\n")); printf(_(" --if-exists use IF EXISTS when dropping objects\n")); printf(_(" --inserts dump data as INSERT commands, rather than COPY\n"));