ALTER TABLE ... MODIFY COMMENT - ClickHouse Documentation

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

语法

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

要创建带注释的表：

Query

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

如需修改表注释：

Query

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

要查看修改后的注释：

Query

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

Response

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

要删除表注释：

Query

ALTER TABLE table_with_comment MODIFY COMMENT '';

要验证该注释已被移除：

Query

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

Response

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

对于复制表，不同副本上的注释可以不同。修改注释仅会应用到单个副本。该功能自 23.9 版本起可用。在更早的 ClickHouse 版本中无法使用。