ALTER TABLE ... MODIFY COMMENT

添加、修改或删除表注释，无论该注释此前是否已设置。注释更改会同时反映在 system.tables 以及 SHOW CREATE TABLE 查询结果中。

语法

ALTER TABLE [db].name [ON CLUSTER cluster] MODIFY COMMENT 'Comment'

要创建包含注释的表：

CREATE TABLE table_with_comment
(
    `k` UInt64,
    `s` String
)
ENGINE = Memory()
COMMENT 'The temporary table';

若要修改表的注释：

ALTER TABLE table_with_comment 
MODIFY COMMENT 'new comment on a table';

要查看已修改的注释：

SELECT comment 
FROM system.tables 
WHERE database = currentDatabase() AND name = 'table_with_comment';

┌─comment────────────────┐
│ new comment on a table │
└────────────────────────┘

要删除表注释：

ALTER TABLE table_with_comment MODIFY COMMENT '';

要确认注释已被删除：

SELECT comment 
FROM system.tables 
WHERE database = currentDatabase() AND name = 'table_with_comment';

┌─comment─┐
│         │
└─────────┘

对于 Replicated 表，不同副本上的注释 (注释) 可以不同。修改注释只会作用于单个副本。

该功能自 23.9 版本起可用。在更早的 ClickHouse 版本中不可用。