跳到主要内容
跳到主要内容

ALTER TABLE ... MODIFY COMMENT

添加、修改或删除表注释(无论之前是否设置过)。表注释的更改会同时反映在 system.tablesSHOW CREATE TABLE 查询的结果中。

语法

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

示例

要创建包含注释的表:

CREATE TABLE table_with_comment
(
    `k` UInt64,
    `s` String
)
ENGINE = Memory()
COMMENT '临时表';

若要修改表的注释:

ALTER TABLE table_with_comment 
MODIFY COMMENT '表的新注释';

要查看已修改的注释:

SELECT comment 
FROM system.tables 
WHERE database = currentDatabase() AND name = 'table_with_comment';
┌─comment────────────────┐
│ 表上的新注释           │
└────────────────────────┘

要删除表注释:

ALTER TABLE table_with_comment MODIFY COMMENT '';

要确认注释已被删除:

SELECT comment 
FROM system.tables 
WHERE database = currentDatabase() AND name = 'table_with_comment';
┌─注释─┐
│      │
└──────┘

注意事项

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

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