Partilhar via

COMMENT ON

  • Artigo

Aplica-se a:Marque Sim Databricks SQL Marque Sim Databricks Runtime

Define um comentário em um catálogo, esquema, tabela, compartilhamento, destinatário, provedor ou volume.

Nota

Se você quiser adicionar um comentário gerado por IA para uma tabela ou coluna de tabela gerenciada pelo Unity Catalog, consulte Adicionar comentários gerados por IA a objetos do Unity Catalog.

Catálogos, compartilhamentos, destinatários e provedores são suportados somente no Catálogo Unity.

Para definir o comentário de uma coluna de tabela, use ALTER TABLE.

Sintaxe

COMMENT ON
    { CATALOG catalog_name |
      COLUMN relation_name . column_name |
      CONNECTION connection_name |
      PROVIDER provider_name |
      RECIPIENT recipient_name |
      { SCHEMA | DATABASE } schema_name |
      SHARE share_name |
      TABLE table_name |
      VOLUME volume_name }
    IS comment

Parâmetros

  • catalog_name

    O nome do catálogo onde o comentário aparece. Para executar essa instrução, você deve ser o proprietário do catálogo ou ter o privilégio de MANAGE nele.

  • relation_name . nome_da_coluna

    Aplica-se a: marca de verificação sim Databricks SQL marca de verificação sim Databricks Runtime 16.1 e superior

    O nome qualificado da coluna que você comenta. relation_name deve identificar uma vista ou uma tabela. O relation_name não deve incluir uma especificação temporal ou uma especificação de opções.

    Se utilizar o Unity Catalog, para executar esta instrução, deverá ter o privilégio MODIFY na tabela.

  • connection_name

    Aplica-se a:assinalado como sim Databricks SQL assinalado como sim Databricks Runtime 13.3 LTS e superior assinalado como sim apenas Unity Catalog

    O nome da conexão onde o comentário aparece. Para executar essa instrução, você deve ser o proprietário da conexão ou ter o privilégio de MANAGE nela.

  • schema_name

    O nome do esquema onde o comentário aparece.

    Se você usar o Unity Catalog, para executar essa instrução, deverá ser o proprietário do esquema ou ter o privilégio de MANAGE nele.

  • table_name

    O nome da tabela que você comenta. O nome não deve incluir uma especificação temporal ou uma especificação de opções.

    Se utilizar o Unity Catalog, para executar esta instrução, deverá ter o privilégio MODIFY na tabela.

  • share_name

    Aplica-se a:Marque Sim Databricks SQL Marque Sim Databricks Runtime 11.3 LTS e superior

    O nome do compartilhamento onde seu comentário aparece. Para executar esta declaração, você deve ser o proprietário da ação.

  • recipient_name

    Aplica-se a:Marque Sim Databricks SQL Marque Sim Databricks Runtime 11.3 LTS e superior

    O nome do destinatário onde o comentário aparece. Para executar essa instrução, você deve ser o proprietário do destinatário.

  • provider_name

    Aplica-se a:Marque Sim Databricks SQL Marque Sim Databricks Runtime 11.3 LTS e superior

    O nome do provedor onde o comentário aparece. Para executar essa instrução, você deve ser o proprietário do provedor.

  • volume_name

    Aplica-se a:Marque Sim Databricks SQL Marque Sim Databricks Runtime 13.3 LTS e superior

    O nome do volume onde o comentário aparece. Para executar essa instrução, você deve ser o proprietário do volume ou ter o privilégio de MANAGE nele.

  • comentar

    Um STRING literal ou NULL. Se você especificar NULL qualquer comentário existente será removido.

Exemplos

> COMMENT ON CATALOG my_catalog IS 'This is my catalog';

> COMMENT ON COLUMN my_table.c1 IS 'This is my column';

> COMMENT ON CONNECTION mysql_connection IS 'this is a mysql connection';

> COMMENT ON SCHEMA my_schema IS 'This is my schema';

> COMMENT ON TABLE my_table IS 'This is my table';

> COMMENT ON TABLE my_table IS NULL;

> COMMENT ON SHARE my_share IS 'A good share';

> COMMENT ON RECIPIENT my_recipient IS 'A good recipient';

> COMMENT ON PROVIDER my_provider IS 'A good provider';

> COMMENT ON PROVIDER my_volume IS 'Huge volume';