doc: Mention all options equivalent to pg_dump --filter patterns.
authorDean Rasheed <dean.a.rasheed@gmail.com>
Mon, 10 Jun 2024 13:55:41 +0000 (14:55 +0100)
committerDean Rasheed <dean.a.rasheed@gmail.com>
Mon, 10 Jun 2024 13:58:21 +0000 (14:58 +0100)
In the documentation for pg_dump's new --filter option, added by
commit a5cf808be5, each object pattern should match some other
existing pg_dump option, but some had been omitted, so add them.

Noted by Daniel Gustafsson, reviewed by Ayush Vatsa.

Discussion: https://postgr.es/m/CAEZATCWtVUt51B6BjTUQoS4dcNyOBj%2B04ngL7HSH3ehBXTUt%3Dw%40mail.gmail.com

doc/src/sgml/ref/pg_dump.sgml

index 08d775379fd1bc2d0522683ec94643157f18ed8a..b95ed875176f7b1811d64b9654fd3cd058948feb 100644 (file)
@@ -866,13 +866,14 @@ PostgreSQL documentation
         same rules as the corresponding options:
         <option>-t</option>/<option>--table</option>,
         <option>--table-and-children</option>,
-        <option>--exclude-table-and-children</option> or
-        <option>-T</option> for tables,
-        <option>-n</option>/<option>--schema</option> for schemas,
+        <option>-T</option>/<option>--exclude-table</option>, and
+        <option>--exclude-table-and-children</option> for tables,
+        <option>-n</option>/<option>--schema</option> and
+        <option>-N</option>/<option>--exclude-schema</option> for schemas,
         <option>--include-foreign-data</option> for data on foreign servers,
-        <option>--exclude-table-data</option>,
+        <option>--exclude-table-data</option> and
         <option>--exclude-table-data-and-children</option> for table data, and
-        <option>-e</option>/<option>--extension</option> or
+        <option>-e</option>/<option>--extension</option> and
         <option>--exclude-extension</option> for extensions.
         To read from <literal>STDIN</literal>, use <filename>-</filename> as the
         filename.  The <option>--filter</option> option can be specified in
@@ -895,34 +896,37 @@ PostgreSQL documentation
         <itemizedlist>
          <listitem>
           <para>
-           <literal>extension</literal>: extensions, works like the
-           <option>-e</option>/<option>--extension</option> option.
+           <literal>extension</literal>: extensions. This works like the
+           <option>-e</option>/<option>--extension</option> or
+           <option>--exclude-extension</option> option.
           </para>
          </listitem>
          <listitem>
           <para>
-           <literal>foreign_data</literal>: data on foreign servers, works like
+           <literal>foreign_data</literal>: data on foreign servers. This works like
            the <option>--include-foreign-data</option> option. This keyword can
            only be used with the <literal>include</literal> keyword.
           </para>
          </listitem>
          <listitem>
           <para>
-           <literal>table</literal>: tables, works like the
-           <option>-t</option>/<option>--table</option> option.
+           <literal>table</literal>: tables. This works like the
+           <option>-t</option>/<option>--table</option> or
+           <option>-T</option>/<option>--exclude-table</option> option.
           </para>
          </listitem>
          <listitem>
           <para>
            <literal>table_and_children</literal>: tables including any partitions
-           or inheritance child tables, works like the
-           <option>--table-and-children</option> option.
+           or inheritance child tables. This works like the
+           <option>--table-and-children</option> or
+           <option>--exclude-table-and-children</option> option.
           </para>
          </listitem>
          <listitem>
           <para>
            <literal>table_data</literal>: table data of any tables matching
-           <replaceable>pattern</replaceable>, works like the
+           <replaceable>pattern</replaceable>. This works like the
            <option>--exclude-table-data</option> option. This keyword can only
            be used with the <literal>exclude</literal> keyword.
           </para>
@@ -931,15 +935,16 @@ PostgreSQL documentation
           <para>
            <literal>table_data_and_children</literal>: table data of any tables
            matching <replaceable>pattern</replaceable> as well as any partitions
-           or inheritance children of the table(s), works like the
+           or inheritance children of the table(s). This works like the
            <option>--exclude-table-data-and-children</option> option. This
            keyword can only be used with the <literal>exclude</literal> keyword.
           </para>
          </listitem>
          <listitem>
           <para>
-           <literal>schema</literal>: schemas, works like the
-           <option>-n</option>/<option>--schema</option> option.
+           <literal>schema</literal>: schemas. This works like the
+           <option>-n</option>/<option>--schema</option> or
+           <option>-N</option>/<option>--exclude-schema</option> option.
           </para>
          </listitem>
         </itemizedlist>