Перейти к основному содержанию
Перейти к основному содержанию

ALTER TABLE ... MODIFY COMMENT

Добавляет, изменяет или удаляет комментарий к таблице, независимо от того, был ли он задан ранее или нет. Изменение комментария отображается как в system.tables, так и в результате запроса SHOW CREATE TABLE.

Синтаксис​

ALTER TABLE [db].name [ON CLUSTER cluster] MODIFY 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 комментарий может отличаться на разных репликах. Изменение комментария применяется только к одной реплике.

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

Связанные материалы​