COMMENT statement [YSQL]

Synopsis

Use the COMMENT statement to set, update, or remove a comment on a database object.

Syntax

{{%ebnf%}} comment_on {{%/ebnf%}}

Semantics

To remove a comment, set the value to NULL.

comment_on

COMMENT ON

Add or change a comment about a database object. To remove a comment, set the value to NULL.

aggregate_signature

Examples

Add a comment

COMMENT ON DATABASE postgres IS 'Default database';

COMMENT ON INDEX index_name IS 'Special index';

Remove a comment

COMMENT ON TABLE some_table IS NULL;