Re: DOCS - Add missing EXCEPT parameter description to ALTER PUBLICATION - Mailing list pgsql-hackers

From Peter Smith
Subject Re: DOCS - Add missing EXCEPT parameter description to ALTER PUBLICATION
Date
Msg-id CAHut+Pui8-YTBjiP7SxHN5HebpM-wBKqN4bdEw=_d-oNT2zB2g@mail.gmail.com
Whole thread
Responses Re: DOCS - Add missing EXCEPT parameter description to ALTER PUBLICATION
List pgsql-hackers
Hi Nisha,

Thanks for following-up on this...

The patch LGTM in general, but here are a few comments.

======

1.
+   <varlistentry>
+    <term><literal>EXCEPT</literal></term>
+    <listitem>
+     <para>
+      This clause specifies a list of tables to be excluded from the
+      publication when used with <literal>SET ALL TABLES</literal>.  If
+      <literal>EXCEPT</literal> is specified, the existing exclusion list is
+      replaced with the specified tables.  If <literal>EXCEPT</literal> is
+      omitted, any existing table exclusions are removed.  See
+      <xref linkend="sql-createpublication-params-for-except-table"/> for
+      details.
+     </para>
+    </listitem>
+   </varlistentry>

1a.
I think reversing the first sentence wording makes it simpler.

SUGGESTION
This clause can be used with <literal>SET ALL TABLES</literal> to
specify a list of tables to be excluded from the publication.

~~~

1b.
The term is written differently to how you wrote it in your other thread [1].

Here, you write the term as style #1:
<term><literal>EXCEPT</literal></term>

But, in the other thread you wrote the same term as style #2:
<term><literal>EXCEPT ( <replaceable
class="parameter">except_table_object</replaceable> [, ... ]
)</literal></term>

I am not sure which way is better. If we are eventually going to put
all variations of EXCEPT in the same place then maybe style #1 is
best; OTOH, if we anticipate separate descriptions for the "EXCEPT
(TABLE ...)" and "EXCEPT (SEQUENCE ...)" then maybe style #2 is best.

~~~

1c.
The xref looks a bit strange because it renders like "See EXCEPT for
details", but we are already looking at "EXCEPT", just not the same
one. Perhaps it should be changed so it renders like "See CREATE
PUBLICATION ... EXCEPT for details".

======
[1]
https://www.postgresql.org/message-id/flat/CABdArM5sw4Q1ZU8HGdo4BSc1A_%2B8xtUNq17j6wcir%3DyMUy19Cg%40mail.gmail.com

Kind Regards,
Peter Smith.
Fujitsu Australia



pgsql-hackers by date:

Previous
From: Nitin Motiani
Date:
Subject: Re: Adding pg_dump flag for parallel export to pipes
Next
From: Bertrand Drouvot
Date:
Subject: Re: Avoid orphaned objects dependencies, take 3