Share via

Dados do documento no Catalog Explorer usando comentários de markdown

  • Artigo

Os usuários podem usar o Gerenciador de Catálogos para exibir comentários sobre ativos de dados, como catálogos, esquemas e tabelas. Este artigo descreve como os proprietários de objetos ou usuários com permissão de modificação em objetos podem adicionar esses comentários manualmente usando o Gerenciador de Catálogos.

Nota

Para tabelas e colunas, o Catalog Explorer também permite ver sugestões de comentários geradas por IA e aplicá-las. Consulte Adicionar comentários gerados por IA a uma tabela.

Se você estiver usando o Catálogo Unity, poderá usar o Gerenciador de Catálogos para adicionar e editar comentários em todos os objetos que não estejam em um catálogo de Compartilhamento Delta.

Para dados no metastore do Hive, você pode usar o Catalog Explorer para editar apenas comentários de tabela.

O Markdown fornece um conjunto robusto de opções para documentar dados, aprimorando as opções que os usuários do Azure Databricks têm para aumentar a capacidade de descoberta e a compreensão de ativos de dados compartilhados. O uso de comentários de markdown não tem impacto no desempenho da consulta. Markdown não renderiza quando retornado por DESCRIBE instruções.

Adicionar comentários de marcação a objetos de dados usando o Catalog Explorer

O Catalog Explorer exibe comentários para catálogos, esquemas, tabelas e outros ativos abaixo do nome do objeto.

  • Se nenhum comentário existir, uma opção Adicionar comentário será exibida.
  • Você pode alternar a exibição de comentários com as opções Ocultar comentário e Mostrar comentário .

A marcação nos comentários da tabela é renderizada no Gerenciador de Catálogos assim que você salva as alterações.

  • Clique no ícone de lápis para modificar os comentários.
  • Clique em Salvar para atualizar os comentários.

Você também pode usar SQL para adicionar comentários de tabela durante a criação de tabelas ou ALTER TABLE ações.

Ao modificar comentários em uma tabela Delta Lake, uma SET TBLPROPERTIES operação no histórico da tabela registra a consulta SQL usada para definir os comentários da tabela atual.

Exemplo de documentação de markdown suportada

O Catalog Explorer oferece suporte à sintaxe básica de markdown. Não é possível usar markdown para emojis, imagens e tabelas de markdown renderizadas. O Catalog Explorer processa apenas dois níveis de cabeçalhos de marcação.

O exemplo a seguir mostra um bloco de código de markdown bruto. Copie essa marcação para um comentário no Gerenciador de Catálogos e clique em Salvar para visualizar.

# Header 1
## Header 2

**bold text**

*italics text*

~~strikethrough text~~

`monospace text`

---

> Block quote

Ordered list:
1. Item 1
1. Item 2
1. Item 3

Unordered list:
- Item a
- Item b
- Item c

def my_function(): retorno my_value


[Link](https://www.markdownguide.org/cheat-sheet/#basic-syntax)

Mais recursos

Você também pode usar a seguinte funcionalidade para adicionar comentários a objetos de dados:

  • O comando COMMENT ON . Esta opção não suporta comentários de coluna.
  • A COMMENT opção quando você usa o CREATE <object> comando ou ALTER <object> . Por exemplo, consulte CREATE TABLE [USING] e ALTER TABLE. Esta opção suporta comentários de coluna.
  • Comentários gerados por IA (também conhecidos como documentação gerada por IA) no Catalog Explorer. Você pode exibir um comentário sugerido por um modelo de linguagem grande (LLM) que leva em conta os metadados da tabela, como o esquema da tabela e os nomes das colunas, e editar ou aceitar o comentário como está para adicioná-lo. Esta opção suporta apenas tabelas e colunas. Consulte Adicionar comentários gerados por IA a uma tabela.