pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Fujii Masao <fujii@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.
Date: Thu, 27 Nov 2025 14:33:00 +0000
Message-ID: <E1vOd3L-001fah-3A@gemulon.postgresql.org> (raw)

doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.

The documentation for CREATE/ALTER PUBLICATION previously showed:

        [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ]

to indicate that the table/column specification could be repeated.
However, placing [, ... ] directly after a multi-part construct was
misleading and made it unclear which portion was repeatable.

This commit introduces a new term, table_and_columns, to represent:

        [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ]

and updates the synopsis to use:

        table_and_columns [, ... ]

which clearly identifies the repeatable element.

Backpatched to v15, where the misleading syntax was introduced.

Author: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Chao Li <lic@highgo.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAHut+PtsyvYL3KmA6C8f0ZpXQ=7FEqQtETVy-BOF+cm9WPvfMQ@mail.gmail.com
Backpatch-through: 15

Branch
------
REL_17_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/d7977668eec65363012797302b492adff1578274

Modified Files
--------------
doc/src/sgml/ref/alter_publication.sgml  | 8 ++++++--
doc/src/sgml/ref/create_publication.sgml | 6 +++++-
2 files changed, 11 insertions(+), 3 deletions(-)



view thread (5+ messages)  latest in thread

Message-ID: <E1vOd3L-001fah-3A@gemulon.postgresql.org>
Permalink:  ../E1vOd3L-001fah-3A@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1vOd3L-001fah-3A@gemulon.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: fujii@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Fix misleading synopsis for CREATE/ALTER PUBLICATION.
  In-Reply-To: <E1vOd3L-001fah-3A@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox