COMMENT ON

  • Artigo

Aplica-se a:marca de seleção positiva Databricks SQL marca de seleção positiva Databricks Runtime

Define um comentário em um catálogo, um esquema, uma tabela, um compartilhamento, um destinatário, um provedor ou um 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, consulte Adicionar comentários gerados por IA em uma tabela.

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

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

Sintaxe

COMMENT ON
    { CATALOG catalog_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 em que o comentário é exibido. Para executar essa instrução, você precisa ser o proprietário do catálogo.

  • connection_name

    Aplica-se a:verificação marcada como sim Databricks SQL verificação marcada como sim Databricks Runtime 13.3 LTS e superior verificação marcada como simsomente Unity Catalog

    O nome da conexão em que o comentário aparece. Para executar essa instrução, você precisa ser o proprietário da conexão.

  • 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, precisará ser o proprietário do esquema.

  • table_name

    O nome da tabela na qual você comenta. O nome não deve incluir uma especificação temporal.

    Se você usar o Catálogo do Unity, para executar essa instrução, precisará ter o privilégio MODIFY na tabela.

  • share_name

    Aplica-se a:verificação marcada como sim Databricks SQL marca de seleção positiva Databricks Runtime 11.3 LTS 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:verificação marcada como sim Databricks SQL marca de seleção positiva Databricks Runtime 11.3 LTS 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:verificação marcada como sim Databricks SQL marca de seleção positiva Databricks Runtime 11.3 LTS 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:verificação marcada como sim Databricks SQL verificação marcada como sim Databricks Runtime 13.3 LTS e superior

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

  • comment

    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 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';