ALTER TABLE ... MODIFY COMMENT

Documentação para ALTER TABLE … MODIFY COMMENT, que permite adicionar, modificar ou remover comentários da tabela

Adiciona, modifica ou remove um comentário da tabela, independentemente de ele ter sido definido anteriormente ou não. A alteração no comentário é refletida tanto em system.tables quanto na consulta SHOW CREATE TABLE.

​

Sintaxe

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

​

Exemplos

Para criar uma tabela com comentário:

Consulta

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

Para alterar o comentário da tabela:

Consulta

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

Para ver o comentário modificado:

Consulta

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

Response

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

Para remover o comentário da tabela:

Consulta

ALTER TABLE table_with_comment MODIFY COMMENT '';

Para verificar se o comentário foi removido:

Consulta

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

Response

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

​

Ressalvas

Para tabelas Replicated, o comentário pode ser diferente entre as réplicas. A modificação do comentário se aplica a uma única réplica.

O recurso está disponível desde a versão 23.9. Ele não funciona em versões anteriores do ClickHouse.

​

Conteúdo relacionado

• cláusula COMMENT
• ALTER DATABASE ... MODIFY COMMENT