Adicionar comentários aos dados e ao IA ativo

Este artigo apresenta comentários para dados e IA ativo e explica como adicioná-los. Os comentários podem ajudar o senhor e outros usuários a encontrar e gerenciar os dados e a IA ativa de que precisam.

Os comentários fornecem um campo de metadados para anotar seus objetos protegíveis. O senhor pode adicionar comentários a qualquer objeto seguro no Unity Catalog, como catálogos, esquemas, tabelas, volumes, modelos de IA e muito mais. O senhor também pode adicionar comentários às colunas da tabela.

O senhor pode adicionar comentários manualmente ou deixar que o Databricks crie comentários gerados por IA para o senhor. Os comentários gerados pela IA (também conhecidos como documentação gerada pela IA) estão disponíveis para tabelas e colunas de tabelas. Consulte Adicionar comentários gerados por IA aos objetos do Unity Catalog.

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

O senhor 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, o senhor deve ser o proprietário ou ter os seguintes privilégios:

    • MODIFY e SELECT na mesa.

    • USE CATALOG e USE SCHEMA no catálogo e no esquema pai.

  • O senhor deve usar um SQL warehouse ou outro compute que ofereça suporte a Unity Catalog (usuário compartilhado ou único compute).

  • Para usar os comentários gerados pela IA, o site workspace deve estar habilitado para o recurso IA-assistive. Consulte Adicionar comentários gerados por IA aos objetos do Unity Catalog.

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.

  1. Na barra lateral workspace, clique em Ícone do catálogo Catalog para abrir o Catalog Explorer.

  2. Pesquise e selecione o objeto que o senhor deseja comentar.

    Os objetos de dados e de IA são listados e podem ser pesquisados no painel Catalog. Compartilhamentos, credenciais de armazenamento, locais externos e conexões podem ser acessados usando o menu que se abre quando o senhor clica no ícone de engrenagem ícone de engrenagem.

  3. Adicione um comentário ou edite um comentário existente.

    • Para adicionar um comentário a uma tabela usando comentários gerados pela IA, view o IA Suggested Comment (Comentário sugerido pela IA ) no painel direito da Visão geral tab. Pode levar alguns segundos para aparecer. Aceite-o como está ou edite-o e salve-o.

    • Para adicionar um comentário a uma coluna da tabela usando comentários gerados por IA, clique no botão Gerar IA 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 por IA, clique em Add comment (Adicionar comentário ) para adicionar um comentário.

    • Para adicionar um comentário a uma coluna da tabela sem usar comentários gerados por IA, clique no ícone Ícone para adicionar uma tag de coluna ou comentário 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 gerado por IA, clique no ícone de edição ícone de edição para editá-lo.

O senhor 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 por declarações DESCRIBE. Toda a sintaxe básica é compatível com o Catalog Explorer, exceto as imagens, e apenas dois níveis de cabeçalho são renderizados. Para obter mais informações, consulte Sintaxe básica.

Para obter mais informações sobre comentários gerados por IA, consulte Adicionar comentários gerados por IA a objetos Unity Catalog .

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. Veja COMMENT ON.

    O senhor também pode usar a opção COMMENT com o comando ALTER <object> para o objeto (por exemplo, ALTER TABLE). Consulte os artigos de referência do SQL para o comando ALTER <object>.

  • Para adicionar ou atualizar um comentário de coluna em uma tabela existente, use o comando ALTER TABLE com a cláusula ALTER COLUMN e a opção COMMENT 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 comando CREATE <object>. Consulte os artigos de referência SQL para o comando CREATE <object> que o senhor deseja usar.