Dati dei documenti in Esplora cataloghi tramite commenti markdown

Gli utenti possono usare Esplora cataloghi per visualizzare commenti sugli asset di dati, ad esempio cataloghi, schemi e tabelle. Questo articolo descrive in che modo i proprietari di oggetti o gli utenti con autorizzazione di modifica per gli oggetti possono aggiungere tali commenti manualmente tramite Esplora cataloghi.

Nota

Per tabelle e colonne, Esplora cataloghi consente anche di visualizzare i suggerimenti dei commenti generati dall'intelligenza artificiale e applicarli. Vedere Aggiungere commenti generati dall'intelligenza artificiale a una tabella.

Se si usa Unity Catalog, è possibile usare Esplora cataloghi per aggiungere e modificare commenti su tutti gli oggetti diversi da quelli di un catalogo di condivisione differenziale.

Per i dati nel metastore Hive, è possibile usare Esplora cataloghi solo per modificare i commenti delle tabelle.

Markdown offre un set affidabile di opzioni per documentare i dati, migliorando le opzioni disponibili per gli utenti di Azure Databricks per aumentare l'individuabilità e la comprensione degli asset di dati condivisi. L'uso dei commenti markdown non ha alcun impatto sulle prestazioni delle query. Il rendering di Markdown non viene eseguito quando restituito dalle DESCRIBE istruzioni .

Aggiungere commenti markdown agli oggetti dati usando Esplora cataloghi

Esplora cataloghi visualizza i commenti per cataloghi, schemi, tabelle e altri asset sotto il nome dell'oggetto.

• Se non esiste alcun commento, viene visualizzata un'opzione Aggiungi commento .
• È possibile attivare o disattivare la visualizzazione dei commenti con le opzioni Nascondi commento e Mostra commento .

Il rendering di Markdown nei commenti tabella viene eseguito in Esplora cataloghi non appena si salvano le modifiche.

• Fare clic sull'icona a forma di matita per modificare i commenti.
• Fare clic su Salva per aggiornare i commenti.

È anche possibile usare SQL per aggiungere commenti di tabella durante la creazione o ALTER TABLE le azioni della tabella.

Quando si modificano i commenti in una tabella Delta Lake, un'operazione SET TBLPROPERTIES nella cronologia delle tabelle registra la query SQL usata per definire i commenti della tabella corrente.

Esempio di documentazione markdown supportata

Esplora cataloghi supporta la sintassi markdown di base. Non è possibile usare markdown per emoji, immagini e tabelle markdown sottoposte a rendering. Esplora cataloghi esegue il rendering solo di due livelli di intestazioni markdown.

Nell'esempio seguente viene illustrato un blocco di codice di markdown non elaborato. Copiare questo markdown in un commento in Esplora cataloghi e fare clic su Salva in anteprima.

# 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(): restituzione my_value

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

Altre risorse

È anche possibile usare la funzionalità seguente per aggiungere commenti agli oggetti dati:

• Comando COMMENT ON . Questa opzione non supporta i commenti delle colonne.
• Opzione COMMENT quando si usa il CREATE <object> comando o ALTER <object> . Ad esempio, vedere CREATE TABLE [USING] e ALTER TABLE. Questa opzione supporta i commenti di colonna.
• Commenti generati dall'intelligenza artificiale (nota anche come documentazione generata dall'intelligenza artificiale) in Esplora cataloghi. È possibile visualizzare un commento suggerito da un modello LLM (Large Language Model) che tiene conto dei metadati della tabella, ad esempio lo schema della tabella e i nomi di colonna, e modificare o accettare il commento così come è per aggiungerlo. Questa opzione supporta solo tabelle e colonne. Vedere Aggiungere commenti generati dall'intelligenza artificiale a una tabella.