Compartilhar via


COMMENT ON

Aplica-se a:marque sim SQL do Databricks marque sim Databricks Runtime

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

Observação

Se desejar adicionar um comentário gerado por IA em uma tabela ou coluna de tabela gerenciada pelo Catálogo do Unity, confira Adicionar comentários gerados por IA a objetos do catálogo do Unity.

Catálogos, compartilhamentos, destinatários e provedores têm suporte comente no Catálogo do Unity.

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 relation_name |
      VOLUME volume_name }
    IS comment

Parâmetros

  • catalog_name

    O nome do catálogo em que o comentário é exibido. Para executar esta instrução, você deve ser o proprietário do catálogo ou ter o privilégio MANAGE sobre ele.

  • relation_name . nome_da_coluna

    Aplica-se a: marque sim SQL do Databricks marque sim Databricks Runtime 16.1 e superior

    O nome qualificado da coluna na qual você comenta. relation_name deve identificar uma tabela, uma exibição ou uma exibição materializada. O relation_name não deve incluir uma especificação temporal ou especificação de opções.

    Se você usar o Catálogo do Unity, para executar esta instrução, deverá ter:

    • MODIFY privilégio na tabela.
    • ser a OWNER da exibição.
  • connection_name

    Aplica-se a:marque sim SQL do Databricks marque sim LTS do Databricks Runtime 13.3 e superior com marque sim somente Catálogo do Unity

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

  • schema_name

    O nome do esquema em que o comentário é exibido.

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

  • nome_da_relação

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

    Se você usar o Catálogo do Unity, para executar esta instrução, deverá ter:

    • MODIFY privilégio na tabela.
    • ser a OWNER da exibição.
  • share_name

    Aplica-se a:marque sim SQL do Databricks marque sim LTS do Databricks Runtime 11.3 e superior

    O nome do compartilhamento em que o comentário é exibido. Para executar essa instrução, você precisa ser o proprietário do compartilhamento.

  • recipient_name

    Aplica-se a:marque sim SQL do Databricks marque sim LTS do Databricks Runtime 11.3 e superior

    O nome do destinatário em que o comentário é exibido. Para executar essa instrução, você precisa ser o proprietário do destinatário.

  • provider_name

    Aplica-se a:marque sim SQL do Databricks marque sim LTS do Databricks Runtime 11.3 e superior

    O nome do provedor em que o comentário é exibido. Para executar essa instrução, você precisa ser o proprietário do provedor.

  • volume_name

    Aplica-se a:marque sim SQL do Databricks marque sim LTS do Databricks Runtime 13.3 e superior

    O nome do volume em que o comentário é exibido. Para executar esta instrução, você deve ser o proprietário do volume ou ter o privilégio MANAGE sobre ele.

  • comentário

    Uma literal de STRING 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 VOLUME my_volume IS 'Huge volume';