Share via

Dokumentdaten im Katalog-Explorer mit Markdown-Kommentaren

  • Artikel

Benutzer können den Katalog-Explorer verwenden, um Kommentare zu Datenobjekten wie Katalogen, Schemas und Tabellen anzuzeigen. In diesem Artikel wird beschrieben, wie Objektbesitzer oder Benutzer mit Änderungsberechtigungen für Objekte diese Kommentare manuell mithilfe des Katalog-Explorers hinzufügen können.

Hinweis

Für Tabellen und Spalten können Sie im Katalog-Explorer auch KI-generierte Kommentarvorschläge anzeigen und anwenden. Weitere Informationen dazu finden Sie unter Hinzufügen von KI-generierten Kommentaren zu einer Tabelle.

Bei Verwendung von Unity Catalog können Sie den Katalog-Explorer verwenden, um Kommentare für alle Objekte hinzuzufügen und zu bearbeiten, die sich nicht in einem Delta Sharing-Katalog befinden.

Für Daten im Hive-Metastore können Sie den Katalog-Explorer nur zum Bearbeiten von Tabellenkommentaren nutzen.

Markdown bietet stabile Optionen zum Dokumentieren von Daten. Dadurch werden die Optionen optimiert, die Azure Databricks-Benutzern zum Verbessern der Ermittelbarkeit und der Nachvollziehbarkeit freigegebener Datenressourcen zur Verfügung stehen. Die Verwendung von Markdownkommentaren hat keine Auswirkungen auf die Abfrageleistung. Markdown wird nicht gerendert, wenn es von DESCRIBE-Anweisungen zurückgegeben wird.

Hinzufügen von Markdown-Kommentaren zu Datenobjekten mithilfe des Katalog-Explorers

Der Katalog-Explorer zeigt Kommentare für Kataloge, Schemas, Tabellen und andere Objekte unterhalb des Objektnamens an.

  • Wenn kein Kommentar vorhanden ist, wird die Option Kommentar hinzufügen angezeigt.
  • Sie können die Kommentaranzeige mit den Optionen Kommentar ausblenden und Kommentar anzeigen umschalten.

Markdown in Tabellenkommentaren wird im Katalog-Explorer gerendert, sobald Sie Änderungen speichern.

  • Klicken Sie auf das Stiftsymbol, um Kommentare zu ändern.
  • Klicken Sie auf Speichern, um Kommentare zu aktualisieren.

Sie können SQL auch verwenden, um Tabellenkommentare während der Tabellenerstellung oder ALTER TABLE-Aktionen hinzuzufügen.

Beim Ändern von Kommentaren zu einer Delta Lake-Tabelle zeichnet ein SET TBLPROPERTIES-Vorgang im Tabellenverlauf die SQL-Abfrage auf, die zum Definieren der aktuellen Tabellenkommentare verwendet wird.

Beispiel für unterstützte Markdowndokumentation

Der Katalog-Explorer unterstützt grundlegende Markdownsyntax. Markdown kann nicht für Emojis, Bilder und gerenderte Markdowntabellen verwendet werden. Der Katalog-Explorer rendert nur zwei Ebenen von Markdownheadern.

Das folgende Beispiel zeigt einen Codeblock mit unformatiertem Markdown. Kopieren Sie dieses Markdownelement in einen Kommentar im Katalog-Explorer, und klicken Sie zum Anzeigen einer Vorschau auf Speichern.

# 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)

Weitere Ressourcen

Sie können auch die folgenden Funktionen verwenden, um Datenobjekten Kommentare hinzuzufügen:

  • Den Befehl KOMMENTAR EIN. Diese Option unterstützt keine Spaltenkommentare.
  • Die COMMENT-Option, wenn Sie den CREATE <object>- oder ALTER <object>-Befehl verwenden. Weitere Informationen finden Sie unter CREATE TABLE [USING] und ALTER TABLE. Diese Option unterstützt Spaltenkommentare.
  • KI-generierte Kommentare (auch als KI-generierte Dokumentation bezeichnet) im Katalog-Explorer. Sie können einen Kommentar anzeigen, der von einem großen Sprachmodell (LLM) vorgeschlagen wird, das die Metadaten der Tabelle berücksichtigt, wie z. B. das Tabellenschema und die Spaltennamen, und den Kommentar bearbeiten oder unverändert akzeptieren, um ihn hinzuzufügen. Diese Option unterstützt nur Tabellen und Spalten. Weitere Informationen dazu finden Sie unter Hinzufügen von KI-generierten Kommentaren zu einer Tabelle.