pgsql: doc: Clarify that empty COMMENT string removes the comment. - Mailing list pgsql-committers

From Fujii Masao
Subject pgsql: doc: Clarify that empty COMMENT string removes the comment.
Date
Msg-id E1vxIdD-0027QT-2j@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
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
------
master

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

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(-)


pgsql-committers by date:

Previous
From: Michael Paquier
Date:
Subject: pgsql: Add support for "exprs" in pg_restore_extended_stats()
Next
From: Fujii Masao
Date:
Subject: pgsql: doc: Clarify that empty COMMENT string removes the comment.