ALTER TABLE ... MODIFY COMMENT

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

構文

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

コメント付きのテーブルを作成するには:

Querysql

CREATE TABLE table_with_comment
(
    `k` UInt64,
    `s` String
)
ENGINE = Memory()
COMMENT 'The temporary table';

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

Querysql

ALTER TABLE table_with_comment
MODIFY COMMENT 'new comment on a table';

変更後のコメントを表示するには:

Querysql

SELECT comment
FROM system.tables
WHERE database = currentDatabase() AND name = 'table_with_comment';

Responsetext

┌─comment────────────────┐
│ new comment on a table │
└────────────────────────┘

テーブルコメントを削除するには:

Querysql

ALTER TABLE table_with_comment MODIFY COMMENT '';

コメントが削除されていることを確認するには:

Querysql

SELECT comment
FROM system.tables
WHERE database = currentDatabase() AND name = 'table_with_comment';

Responsetext

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

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

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