Documente dados no Catalog Explorer usando comentários de redução

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

Observação

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 estiver usando Unity Catalog, você poderá usar o Catalog Explorer para adicionar e editar comentários em todos os objetos, exceto aqueles em um catálogo Delta Sharing .

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

Markdown fornece um conjunto robusto de opções para documentar dados, aprimorando as opções que os usuários do Databricks têm para aumentar a descoberta e compreensão dos dados ativos compartilhados. O uso de comentários de redução não afeta o desempenho query . Markdown não é renderizado quando retornado por instruções DESCRIBE .

Adicione comentários de reduçã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 não existir nenhum comentário, uma opção Adicionar comentário será mostrada.
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 Catalog Explorer 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 à tabela durante a criação da tabela ou ações ALTER TABLE .

Ao modificar comentários em uma tabela Delta Lake, uma SET TBLPROPERTIES operações na tabela história registra a query SQL usada para definir os comentários da tabela atual.

Exemplo de documentação de redução suportada

O Catalog Explorer oferece suporte à sintaxe básica de markdown. Você não pode usar markdown para emojis, imagens e tabelas de markdown renderizadas. O Catalog Explorer renderiza apenas dois níveis de cabeçalhos de redução.

O exemplo a seguir mostra um bloco de código de redução bruta. Copie esta marcação para um comentário no Catalog Explorer 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():
    return my_value
```

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

Mais recurso

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 oferece suporte a comentários de coluna.
A opção COMMENT quando você usa o comando CREATE <object> ou ALTER <object> . Por exemplo, consulte CREATE TABLE [USING] e ALTER TABLE. Esta opção oferece suporte a comentários de coluna.
Comentários gerados por IA (também conhecidos como documentação gerada por IA) no Catalog Explorer. Você pode view um comentário sugerido por um modelo de linguagem grande (LLM) que leva em account 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.