ALTER TABLE ... MODIFY COMMENT

Документация по ALTER TABLE … MODIFY COMMENT, который позволяет добавлять, изменять или удалять комментарий к таблице

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

​

Синтаксис

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

​

Примеры

Чтобы создать таблицу с комментарием:

Query

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

Чтобы изменить комментарий к таблице:

Query

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

Чтобы просмотреть изменённый комментарий:

Query

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

Response

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

Чтобы удалить комментарий к таблице:

Query

ALTER TABLE table_with_comment MODIFY COMMENT '';

Чтобы убедиться, что комментарий удалён:

Query

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

Response

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

​

Ограничения

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

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

​

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

• предложение COMMENT
• ALTER DATABASE ... MODIFY COMMENT