Adición de comentarios a los recursos de datos e IA

En este artículo encontrará comentarios sobre los recursos de datos e inteligencia artificial y se explica cómo agregarlos. Los comentarios pueden ayudarle tanto a usted como a otros usuarios a encontrar y administrar los recursos de datos e inteligencia artificial que necesite.

Los comentarios proporcionan un campo de metadatos para anotar los objetos protegibles. Puede agregar comentarios a cualquier objeto protegible de Unity Catalog, como catálogos, esquemas, tablas, volúmenes, modelos de IA, etc. También puede agregar comentarios a las columnas de la tabla.

Puede agregar los comentarios manualmente, o bien puede permitir que Databricks cree automáticamente comentarios generados por la interfaz de usuario. Los comentarios generados por inteligencia artificial (también conocidos como documentación generada por inteligencia artificial) están disponibles para tablas y columnas de tabla. Consulte Agregar comentarios generados por IA a una tabla.

Si se modifican los comentarios de una tabla de Unity Catalog (o una tabla de Delta Lake en el metastore de Hive heredado), una operación SET TBLPROPERTIES del historial de tablas registra la consulta SQL que se usó para definir el comentario de la tabla.

Antes de empezar

Para agregar o editar comentarios debe cumplir los siguientes requisitos:

• Para agregar o editar comentarios en un catálogo, esquema, volumen, modelo, recurso compartido, destinatario, proveedor, credencial de almacenamiento, ubicación externa o conexión, es preciso ser el propietario del objeto.
• Para agregar o editar comentarios en una tabla o columna, es preciso ser el propietario o tener los siguientes privilegios:
  • MODIFY y SELECT en la tabla.
  • USE CATALOG y USE SCHEMA en el catálogo y el esquema principales.
• Debe usar un almacén de SQL, o cualquier otro proceso que admita Unity Catalog (proceso compartido o de un solo usuario).
• Para usar comentarios generados por IA, el área de trabajo debe estar habilitado para las características de asistencia de IA. Consulte Agregar comentarios generados por IA a una tabla.

Adición y edición de comentarios

Puede agregar comentarios a objetos protegibles, o bien editarlos mediante comandos SQL o el Explorador de catálogos.

Explorador de catálogo

1. En la barra lateral del área de trabajo, haga clic en Catálogo para abrir el Explorador de catálogos.

2. Busque el objeto en el que desea incluir comentarios y selecciónelo.

   Los objetos de datos e IA se enumeran y se pueden buscar en el panel Catálogo. A los recursos compartidos, las credenciales de almacenamiento, las ubicaciones externas y las conexiones se puede acceder mediante el menú que se abre al hacer clic en el icono del engranaje .

3. Agregue un comentario o edite un comentario existente.

   • Para agregar un comentario a una tabla mediante los comentarios generados por la IA, vea el comentario sugerido por la IA en el panel derecho de la pestaña Información general. Es posible que tarde unos segundos en aparecer. Acéptelo tal cual o edítelo y guárdelo.
   • Para agregar un comentario a una columna de la tabla mediante comentarios generados por IA, haga clic en el botón Generados por IA, que está encima de la lista de columnas. Databricks genera comentarios para cada columna. Acéptelos como están o edítelos. Haga clic en la marca de verificación para guardar el comentario.
   • Para agregar un comentario a un objeto que no admite comentarios generados por IA, haga clic en Agregar comentario para agregar un comentario.
   • Para agregar un comentario a una columna de tabla sin usar comentarios generados por IA, haga clic en el icono Agregar comentario de la fila de la columna.
   • Si ya existe un comentario, aparece en el panel derecho de la pestaña Información general o debajo del nombre del objeto. Si no lo ha generado la IA, haga clic en el icono de edición para editarlo.

Puede usar le versión básica de Markdown para aplicar estilo a los comentarios en la interfaz de usuario del Explorador de catálogos. El estilo de Markdown no se representa cuando lo devuelven instrucciones DESCRIBE. Toda las sintaxis básica se admite en el Explorador de catálogos, excepto las imágenes, y solo se representan dos niveles de encabezado. Para más información, consulte Sintaxis básica.

Para más información sobre los comentarios generados por la inteligencia artificial, consulte Adición de comentarios generados por IA a una tabla.

SQL

Puede usar un comando SQL para agregar un literal de cadena como comentario a cualquier objeto protegible de Unity Catalog y a las tablas administradas en el metastore de Hive heredado. El comando SQL que use depende del objeto para el que desea agregar o editar el comentario:

• Para agregar o actualizar un comentario para cualquier objeto protegible existente, excepto las columnas de la tabla, use el comando COMMENT ON. Consulte COMMENT ON.

  También puede usar la opción COMMENT con el comando ALTER <object> para el objeto (por ejemplo, ALTER TABLE). Consulte el artículo de referencia de SQL para el comando ALTER <object>.

• Para agregar o actualizar un comentario de columna para una tabla existente, use el comando ALTER TABLE con la cláusula ALTER COLUMN y la opción COMMENT de la columna. Consulte ALTER TABLE y Cláusula ALTER TABLE ... COLUMN.

• Para agregar un comentario al crear un objeto, use la opción COMMENT con el comando CREATE <object>. Consulte el artículo de referencia de SQL para ver el comando CREATE <object> que desea usar.