doc: Add missing CREATE/ALTER PUBLICATION parameter descriptions

Document table_name, column_name, and schema_name in the CREATE
PUBLICATION and ALTER PUBLICATION reference pages. Also add anchors for
the ALTER PUBLICATION parameter list, matching the style already used by
CREATE PUBLICATION.

Author: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHut+Ptekz+TO4ui8-fiBm4Y+O2v=HQnkK_cW4G=w9ep8654EA@mail.gmail.com

diff --git a/doc/src/sgml/ref/alter_publication.sgml b/doc/src/sgml/ref/alter_publication.sgml
index 52114a16a391e0c019c9e3a9f890e6e7b03279ee..d2898d2633eaf9770001fe10c2bc828fedcb39f7 100644 (file)
--- a/doc/src/sgml/ref/alter_publication.sgml
+++ b/doc/src/sgml/ref/alter_publication.sgml
@@ -149,7 +149,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
   <title>Parameters</title>
 
   <variablelist>
   <title>Parameters</title>
 
   <variablelist>

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-name">

     <term><replaceable class="parameter">name</replaceable></term>
     <listitem>
      <para>
     <term><replaceable class="parameter">name</replaceable></term>
     <listitem>
      <para>


@@ -158,15 +158,17 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-table-name">

     <term><replaceable class="parameter">table_name</replaceable></term>
     <listitem>
      <para>
       Name of an existing table.  If <literal>ONLY</literal> is specified before the
     <term><replaceable class="parameter">table_name</replaceable></term>
     <listitem>
      <para>
       Name of an existing table.  If <literal>ONLY</literal> is specified before the

-      table name, only that table is affected.  If <literal>ONLY</literal> is not
-      specified, the table and all its descendant tables (if any) are
-      affected.  Optionally, <literal>*</literal> can be specified after the table
-      name to explicitly indicate that descendant tables are included.
+      <replaceable class="parameter">table_name</replaceable>, only that table
+      is affected.  If <literal>ONLY</literal> is not specified, the table and
+      all its descendant tables (if any) are affected.  Optionally,
+      <literal>*</literal> can be specified after the
+      <replaceable class="parameter">table_name</replaceable> to explicitly
+      indicate that descendant tables are included.

      </para>
 
      <para>
      </para>
 
      <para>


@@ -189,7 +191,17 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-column-name">
+    <term><replaceable class="parameter">column_name</replaceable></term>
+    <listitem>
+     <para>
+      Name of an existing column of
+      <replaceable class="parameter">table_name</replaceable>.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry id="sql-alterpublication-params-schema-name">

     <term><replaceable class="parameter">schema_name</replaceable></term>
     <listitem>
      <para>
     <term><replaceable class="parameter">schema_name</replaceable></term>
     <listitem>
      <para>


@@ -198,7 +210,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-set">

     <term><literal>SET ( <replaceable class="parameter">publication_parameter</replaceable> [= <replaceable class="parameter">value</replaceable>] [, ... ] )</literal></term>
     <listitem>
      <para>
     <term><literal>SET ( <replaceable class="parameter">publication_parameter</replaceable> [= <replaceable class="parameter">value</replaceable>] [, ... ] )</literal></term>
     <listitem>
      <para>


@@ -224,7 +236,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-new-owner">

     <term><replaceable class="parameter">new_owner</replaceable></term>
     <listitem>
      <para>
     <term><replaceable class="parameter">new_owner</replaceable></term>
     <listitem>
      <para>


@@ -233,7 +245,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

-   <varlistentry>
+   <varlistentry id="sql-alterpublication-params-new-name">

     <term><replaceable class="parameter">new_name</replaceable></term>
     <listitem>
      <para>
     <term><replaceable class="parameter">new_name</replaceable></term>
     <listitem>
      <para>

diff --git a/doc/src/sgml/ref/create_publication.sgml b/doc/src/sgml/ref/create_publication.sgml
index 85cfcaddafa66089c8ce472b75767d6524b13573..35c28006f601c0b15f5cb1b32d2467e7758ac9e4 100644 (file)
--- a/doc/src/sgml/ref/create_publication.sgml
+++ b/doc/src/sgml/ref/create_publication.sgml
@@ -79,15 +79,45 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
     </listitem>
    </varlistentry>
 
     </listitem>
    </varlistentry>
 

+   <varlistentry id="sql-createpublication-params-table-name">
+    <term><replaceable class="parameter">table_name</replaceable></term>
+    <listitem>
+     <para>
+      Name of an existing table.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry id="sql-createpublication-params-column-name">
+    <term><replaceable class="parameter">column_name</replaceable></term>
+    <listitem>
+     <para>
+      Name of an existing column of
+      <replaceable class="parameter">table_name</replaceable>.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry id="sql-createpublication-params-schema-name">
+    <term><replaceable class="parameter">schema_name</replaceable></term>
+    <listitem>
+     <para>
+      Name of an existing schema.
+     </para>
+    </listitem>
+   </varlistentry>
+

    <varlistentry id="sql-createpublication-params-for-table">
     <term><literal>FOR TABLE</literal></term>
     <listitem>
      <para>
       Specifies a list of tables to add to the publication.  If
    <varlistentry id="sql-createpublication-params-for-table">
     <term><literal>FOR TABLE</literal></term>
     <listitem>
      <para>
       Specifies a list of tables to add to the publication.  If

-      <literal>ONLY</literal> is specified before the table name, only
+      <literal>ONLY</literal> is specified before the
+      <replaceable class="parameter">table_name</replaceable>, only

       that table is added to the publication.  If <literal>ONLY</literal> is not
       specified, the table and all its descendant tables (if any) are added.
       that table is added to the publication.  If <literal>ONLY</literal> is not
       specified, the table and all its descendant tables (if any) are added.

-      Optionally, <literal>*</literal> can be specified after the table name to
+      Optionally, <literal>*</literal> can be specified after the
+      <replaceable class="parameter">table_name</replaceable> to

       explicitly indicate that descendant tables are included.
       This does not apply to a partitioned table, however.  The partitions of
       a partitioned table are always implicitly considered part of the
       explicitly indicate that descendant tables are included.
       This does not apply to a partitioned table, however.  The partitions of
       a partitioned table are always implicitly considered part of the


@@ -208,11 +238,12 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
      </para>
      <para>
       For inherited tables, if <literal>ONLY</literal> is specified before the
      </para>
      <para>
       For inherited tables, if <literal>ONLY</literal> is specified before the

-      table name, only that table is excluded from the publication. If
-      <literal>ONLY</literal> is not specified, the table and all its descendant
-      tables (if any) are excluded. Optionally, <literal>*</literal> can be
-      specified after the table name to explicitly indicate that descendant
-      tables are excluded.
+      <replaceable class="parameter">table_name</replaceable>, only that table
+      is excluded from the publication. If <literal>ONLY</literal> is not
+      specified, the table and all its descendant tables (if any) are excluded.
+      Optionally, <literal>*</literal> can be specified after the
+      <replaceable class="parameter">table_name</replaceable> to explicitly
+      indicate that descendant tables are excluded.

      </para>
      <para>
       For partitioned tables, only the root partitioned table may be specified
      </para>
      <para>
       For partitioned tables, only the root partitioned table may be specified