From: Fujii Masao <fujii@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Clarify that empty COMMENT string removes the comment.
Date: Tue, 03 Mar 2026 05:49:44 +0000
Message-ID: <E1vxIdc-0027S3-21@gemulon.postgresql.org> (raw)
doc: Clarify that empty COMMENT string removes the comment.
Clarify the documentation of COMMENT ON to state that specifying an empty
string is treated as NULL, meaning that the comment is removed.
This makes the behavior explicit and avoids possible confusion about how
empty strings are handled.
Also adds regress test cases that use empty string to remove a comment.
Backpatch to all supported versions.
Author: Chao Li <lic@highgo.com>
Reviewed-by: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com>
Reviewed-by: David G. Johnston <david.g.johnston@gmail.com>
Reviewed-by: Shengbin Zhao <zshengbin91@gmail.com>
Reviewed-by: Jim Jones <jim.jones@uni-muenster.de>
Reviewed-by: zhangqiang <zhang_qiang81@163.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/26476097-B1C1-4BA8-AA92-0AD0B8EC7190@gmail.com
Backpatch-through: 14
Branch
------
REL_17_STABLE
Details
-------
https://git.postgresql.org/pg/commitdiff/ec80fab7a1fdaeb15041f312447f32dd0420d46f
Modified Files
--------------
doc/src/sgml/ref/comment.sgml | 18 +++++++++++-------
src/test/regress/expected/create_index.out | 14 ++++++++++++++
src/test/regress/expected/create_role.out | 27 +++++++++++++++++++++++++++
src/test/regress/sql/create_index.sql | 4 ++++
src/test/regress/sql/create_role.sql | 7 +++++++
5 files changed, 63 insertions(+), 7 deletions(-)
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: Clarify that empty COMMENT string removes the comment.
In-Reply-To: <E1vxIdc-0027S3-21@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