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 '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 バージョンでは動作しません。