COMMENT ON

  • Artículo

Se aplica a:casilla marcada como Sí Databricks SQL casilla marcada como Sí Databricks Runtime

Establece un comentario en un catálogo, esquema, tabla, recurso compartido, destinatario, proveedor o volumen.

Nota:

Si quiere agregar un comentario generado por IA para una tabla o columna de tabla administrada por Unity Catalog, consulte Adición de comentarios generados por IA a una tabla.

Los catálogos, los recursos compartidos, los destinatarios y los proveedores solo se admiten en el catálogo de Unity.

Para establecer el comentario de una columna de tabla, use ALTER TABLE.

Sintaxis

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

    Nombre del catálogo donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario del catálogo.

  • connection_name

    Se aplica a:casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 13.3 LTS y versiones posteriores casilla marcada como Sí Solo Unity Catalog

    Nombre de la conexión donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario de la conexión.

  • schema_name

    Nombre del esquema donde aparece el comentario.

    Si usa el catálogo de Unity, para ejecutar esta instrucción, debe ser el propietario del esquema.

  • table_name

    Nombre de la tabla en la que se realiza el comentario. El nombre no debe incluir una especificación temporal.

    Si usa el catálogo de Unity, para ejecutar esta instrucción, debe tener privilegios MODIFY en la tabla.

  • share_name

    Se aplica a:casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 11.3 LTS y versiones posteriores

    Nombre del recurso compartido donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario del recurso compartido.

  • recipient_name

    Se aplica a:casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 11.3 LTS y versiones posteriores

    Nombre del destinatario donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario del destinatario.

  • provider_name

    Se aplica a:casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 11.3 LTS y versiones posteriores

    Nombre del proveedor donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario del proveedor.

  • volume_name

    Se aplica a:casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 13.3 LTS y versiones posteriores

    Nombre del volumen donde aparece el comentario. Para ejecutar esta instrucción, debe ser el propietario del volumen.

  • comentario

    Literal STRING o NULL. Si especifica NULL, se quitan todos los comentarios existentes.

Ejemplos

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