ALTER TABLE ... MODIFY COMMENT

テーブルコメントを追加、変更、または削除します。以前に設定されていたかどうかに関係なく、コメントの変更は、system.tables および SHOW CREATE TABLE クエリの両方に反映されます。

Syntax

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─┐
│         │
└─────────┘

レプリケーションテーブルの場合、コメントは異なるレプリカごとに異なる可能性があります。コメントの変更は単一のレプリカに適用されます。

この機能はバージョン23.9以降で利用可能であり、以前のClickHouseバージョンでは機能しません。