Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

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

Ограничения

Для таблиц Replicated комментарий может различаться между репликами. Изменение комментария применяется только к одной реплике.

Эта возможность доступна начиная с версии 23.9. В предыдущих версиях ClickHouse она не работает.

Navigation