ALTER TABLE ... MODIFY COMMENT

Ajoute, modifie ou supprime le commentaire d’une table, qu’il ait été défini auparavant ou non. La modification du commentaire est répercutée à la fois dans system.tables et dans la requête SHOW CREATE TABLE.

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

Pour créer une table avec un commentaire :

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

Pour modifier le commentaire de la table :

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

Pour afficher le commentaire modifié :

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

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

Pour supprimer le commentaire de la table :

ALTER TABLE table_with_comment MODIFY COMMENT '';

Pour vérifier que le commentaire a bien été supprimé :

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

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

Pour les tables Replicated, le commentaire peut varier d'une réplique à l'autre. La modification du commentaire ne s'applique qu'à une seule réplique.

Cette fonctionnalité est disponible à partir de la version 23.9. Elle ne fonctionne pas dans les versions antérieures de ClickHouse.

• clause COMMENT
• ALTER DATABASE ... MODIFY COMMENT