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 '一時テーブル';

テーブルのコメントを変更するには:

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';

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

Replicated テーブルの場合、コメントはレプリカごとに異なる場合があります。コメントの変更は 1 つのレプリカにのみ適用されます。

この機能はバージョン 23.9 以降で利用可能です。以前の ClickHouse のバージョンでは使用できません。