Adicione comentários aos dados e AI ativo
Este artigo apresenta comentários para dados e AI ativo e explica como adicioná-los. Os comentários podem ajudar o senhor e outros usuários a encontrar e gerenciar os dados e o AI ativo de que precisa.
Os comentários fornecem um campo de metadados para anotar seus objetos protegíveis. O senhor pode adicionar comentários a qualquer objeto seguro em Unity Catalog, como catálogos, esquemas, tabelas, volumes, modelos AI e outros. Você também pode adicionar comentários às colunas da tabela.
O senhor pode adicionar comentários manualmente ou permitir que o site Databricks crie comentários gerados pelo AIpara o senhor. AIOs comentários gerados (também conhecidos como AI-generated documentation) estão disponíveis para tabelas e colunas de tabelas. Consulte Adicionar AIcomentários gerados pelo Unity Catalog site aos objetos.
Quando o senhor modifica os comentários de uma tabela Unity Catalog (ou uma tabela Delta Lake no legado Hive metastore), uma operação SET TBLPROPERTIES
no histórico da tabela registra a consulta SQL que foi usada para definir o comentário da tabela.
Antes de começar
Você deve atender aos seguintes requisitos para adicionar ou editar comentários:
-
Para adicionar ou editar comentários em um catálogo, esquema, volume, modelo, compartilhamento, destinatário, provedor, credencial de armazenamento, localização externa ou conexão, você deve ser o proprietário do objeto ou ter o privilégio
MANAGE
no objeto. -
Para adicionar ou editar comentários em uma tabela ou coluna, você deve ser o proprietário ou ter os seguintes privilégios:
MODIFY
eSELECT
na mesa.USE CATALOG
eUSE SCHEMA
no catálogo e esquema principais.
-
O senhor deve usar um SQL warehouse ou outro compute que suporte Unity Catalog.
-
Para usar AI-generated comments, seu workspace deve estar habilitado para AI-assistive recurso. Consulte Adicionar AIcomentários gerados pelo Unity Catalog site aos objetos.
Adicionar e editar comentários
O senhor pode adicionar comentários a objetos protegidos ou editá-los usando o SQL comando ou o Catalog Explorer.
- Catalog Explorer
- SQL
O salvamento de comentários aciona um comando ALTER
SQL , que pode interromper o pipeline Databricks e o trabalho.
-
Na barra lateral workspace, clique em
Catalog para abrir o Catalog Explorer.
-
Pesquise e selecione o objeto sobre o qual você deseja comentar.
Os objetos de dados e AI são listados e podem ser pesquisados no painel Catalog (Catálogo ). Compartilhamentos, credenciais de armazenamento, locais externos e conexões podem ser acessados usando o menu que se abre quando você clica no ícone de
engrenagem.
-
Adicione um comentário ou edite um comentário existente.
- Para adicionar um comentário a uma tabela usando AI -generated comments, view o AI Suggested Comment no painel direito do Overview tab. Pode levar alguns segundos para aparecer. Aceite-o como está ou edite e salve-o.
- Para adicionar um comentário a uma coluna da tabela usando os comentários gerados pelo site AI , clique no botão AI generate acima da lista de colunas. O Databricks gera comentários para cada coluna. Aceite-os como estão ou edite-os. Clique na marca de seleção para salvar o comentário.
- Para adicionar um comentário a um objeto que não suporta comentários gerados pelo site AI , clique em Add comment para adicionar um comentário.
- Para adicionar um comentário a uma coluna da tabela sem usar os comentários gerados pelo site AI , clique no ícone
Add comment (Adicionar comentário ) na linha da coluna.
- Se já existir um comentário , ele aparecerá no painel direito da Visão geral tab ou abaixo do nome do objeto. Se não for AI-generated, clique no ícone
edit para editá-lo.
Você pode usar o Markdown básico para estilizar comentários na interface do usuário do Catalog Explorer. O estilo Markdown não é renderizado quando retornado pelas instruções DESCRIBE
. Toda a sintaxe básica é suportada no Catalog Explorer, exceto imagens, e somente dois níveis de título são renderizados. Para obter mais informações, consulte Sintaxe básica.
Para obter mais informações sobre AIos comentários gerados pelo site, consulte Adicionar AIcomentários gerados pelo Unity Catalog site aos objetos.
O senhor pode usar o comando SQL para adicionar um literal de cadeia de caracteres como comentário a qualquer objeto seguro em Unity Catalog e a tabelas gerenciar no legado Hive metastore. O comando SQL que o senhor usa depende do objeto ao qual deseja adicionar ou editar o comentário:
-
Para adicionar ou atualizar um comentário para qualquer objeto securizável existente, exceto colunas de tabela, use o comando
COMMENT ON
. Consulte COMMENT ON.O senhor também pode usar a opção
COMMENT
com o comandoALTER <object>
para o objeto (por exemplo,ALTER TABLE
). Consulte os artigos de referência do site SQL para o comandoALTER <object>
. -
Para adicionar ou atualizar um comentário de coluna em uma tabela existente, use o comando
ALTER TABLE
com a cláusulaALTER COLUMN
e a opçãoCOMMENT
na coluna. Consulte a cláusula ALTER TABLE e ALTER TABLE... COLUMN. -
Para adicionar um comentário quando o senhor criar um objeto, use a opção
COMMENT
com o comandoCREATE <object>
. Consulte os artigos de referência do SQL para oCREATE <object>
comando que o senhor deseja usar.