ALTER TABLE ... MODIFY COMMENT

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

语法

ALTER TABLE [db].name [ON CLUSTER cluster] MODIFY COMMENT '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─┐
│         │
└─────────┘

注意事项

对于复制表，不同副本上的注释可能不同。修改注释仅适用于单个副本。

此功能自 23.9 版本起可用。在之前的 ClickHouse 版本中不起作用。