Hinzufügen von Kommentaren zu Daten und KI-Ressourcen

In diesem Artikel werden Kommentare für Daten und KI-Ressourcen vorgestellt und erläutert, wie sie hinzugefügt werden. Kommentare können Ihnen und anderen Benutzern dabei helfen, die benötigten Daten und KI-Ressourcen zu finden und zu verwalten.

Kommentare bieten ein Metadatenfeld zum Kommentieren Ihrer sicherungsfähigen Objekte. Jedem sicherungsfähigen Objekt in Unity Catalog können Kommentare hinzugefügt werden (z. B. Katalogen, Schemas, Tabellen, Volumes und KI-Modellen). Sie können auch Tabellenspalten Kommentare hinzufügen.

Sie können Kommentare manuell hinzufügen oder Databricks erlauben, KI-generierte Kommentare für Sie zu erstellen. KI-generierte Kommentare (auch als KI-generierte Dokumentation bezeichnet) sind für Tabellen und Tabellenspalten verfügbar. Siehe Hinzufügen von KI-generierten Kommentaren zu Unity Catalog-Objekten.

Wenn Sie Kommentare für eine Unity Catalog-Tabelle (oder eine Delta Lake-Tabelle im Legacy-Hive-Metastore) ändern, zeichnet ein SET TBLPROPERTIES-Vorgang im Tabellenverlauf die SQL-Abfrage auf, die zum Definieren des Tabellenkommentars verwendet wurde.

Voraussetzungen

Sie müssen die folgenden Anforderungen erfüllen, um Kommentare hinzuzufügen oder zu bearbeiten:

• Sie müssen Besitzer des Objekts sein, um Kommentare für Kataloge, Schemas, Volumes, Modelle, Freigaben, Empfänger, Anbieter, Speicheranmeldeinformationen, externe Speicherorte oder Verbindungen hinzuzufügen.
• Zum Hinzufügen oder Bearbeiten von Kommentaren für eine Tabelle oder Spalte müssen Sie der Besitzer sein oder über die folgenden Berechtigungen verfügen:
  • MODIFY und SELECT für die Tabelle
  • USE CATALOG und USE SCHEMA für den übergeordneten Katalog und das übergeordnete Schema
• Sie müssen ein SQL-Warehouse oder eine andere Compute-Instanz verwenden, die Unity Catalog unterstützt (freigegebene Compute oder Einzelbenutzer-Compute).
• Um KI-generierte Kommentare zu verwenden, muss Ihr Arbeitsbereich für KI-Hilfsfunktionen aktiviert sein. Siehe Hinzufügen von KI-generierten Kommentaren zu Unity Catalog-Objekten.

Hinzufügen und Bearbeiten von Kommentaren

Sie können Kommentare zu sicherungsfähigen Objekten hinzufügen oder mit SQL-Befehlen oder dem Katalog-Explorer bearbeiten.

Katalog-Explorer

1. Klicken Sie auf der Seitenleiste des Arbeitsbereichs auf Katalog, um den Katalog-Explorer zu öffnen.

2. Suchen Sie nach dem Objekt, das Sie kommentieren möchten, und wählen Sie es aus.

   Die durchsuchbaren Daten und KI-Objekte werden im Bereich Katalog aufgeführt. Freigaben, Speicheranmeldeinformationen, externe Speicherorte und Verbindungen sind über das Menü zugänglich, das geöffnet wird, wenn Sie auf das Zahnradsymbol klicken.

3. Fügen Sie einen Kommentar hinzu, oder bearbeiten Sie einen vorhandenen Kommentar.

   • Wenn Sie einer Tabelle einen Kommentar mithilfe von KI-generierten Kommentaren hinzufügen möchten, zeigen Sie das Element Von der KI vorgeschlagener Kommentar im rechten Bereich der Registerkarte Übersicht an. Es dauert möglicherweise ein paar Sekunden, bis der Kommentar angezeigt wird. Akzeptieren Sie den Kommentar im aktuellen Zustand, oder bearbeiten Sie ihn, und speichern Sie ihn anschließend.
   • Wenn Sie einer Tabellenspalte einen Kommentar mithilfe von KI-generierten Kommentaren hinzufügen möchten, klicken Sie auf die Schaltfläche KI-Generator oberhalb der Spaltenliste. Databricks generiert Kommentare für jede Spalte. Akzeptieren Sie diese, oder bearbeiten Sie sie. Klicken Sie auf das Häkchen, um den Kommentar zu speichern.
   • Wenn Sie einem Objekt, das keine KI-generierten Kommentare unterstützt, einen Kommentar hinzufügen möchten, klicken Sie auf Kommentar hinzufügen, um einen Kommentar hinzuzufügen.
   • Wenn Sie einer Tabellenspalte einen Kommentar hinzufügen möchten, ohne KI-generierte Kommentare zu verwenden, klicken Sie in der Spaltenzeile auf das Symbol Kommentar hinzufügen.
   • Wenn bereits ein Kommentar vorhanden ist, wird er im rechten Bereich auf der Registerkarte Übersicht oder unter dem Objektnamen angezeigt. Wenn es sich nicht um einen KI-generierten Kommentar handelt, klicken Sie auf das Bearbeitungssymbol, um den Kommentar zu bearbeiten.

Sie können grundlegende Markdown-Elemente verwenden, um Kommentare auf der Benutzeroberfläche des Katalog-Explorers zu formatieren. Die Markdown-Formatierung wird nicht gerendert, wenn Elemente von DESCRIBE-Anweisungen zurückgegeben werden. Die gesamte grundlegende Syntax wird im Katalog-Explorer mit Ausnahme von Bildern unterstützt, und nur zwei Überschriftenebenen werden gerendert. Weitere Informationen finden Sie unter Grundlegende Syntax.

Weitere Informationen zu KI-generierten Kommentaren finden Sie unter Hinzufügen von KI-generierten Kommentaren zu Unity Catalog-Objekten.

SQL

Sie können einen SQL-Befehl verwenden, um ein Zeichenfolgenliteral als Kommentar zu jedem sicherungsfähigen Objekt in Unity Catalog und Tabellen hinzuzufügen, die im Legacy-Hive-Metastore verwaltet werden. Der verwendete SQL-Befehl hängt vom Objekt ab, für das Sie den Kommentar hinzufügen oder bearbeiten möchten:

• Wenn Sie einen Kommentar für ein vorhandenes sicherungsfähiges Objekt mit Ausnahme von Tabellenspalten hinzufügen oder aktualisieren möchten, verwenden Sie den Befehl COMMENT ON. Weitere Informationen finden Sie unter COMMENT ON.

  Sie können die COMMENT-Option auch mit dem Befehl ALTER <object> für das Objekt verwenden (z. B. ALTER TABLE). Lesen Sie den SQL-Referenzartikel für den Befehl ALTER <object>.

• Wenn Sie einen Spaltenkommentar für eine vorhandene Tabelle hinzufügen oder aktualisieren möchten, verwenden Sie den Befehl ALTER TABLE mit der Klausel ALTER COLUMN und der Option COMMENT in der Spalte. Weitere Informationen finden Sie unter ALTER TABLE und ALTER TABLE … COLUMN-Klausel.

• Wenn Sie beim Erstellen eines Objekts einen Kommentar hinzufügen möchten, verwenden Sie die COMMENT-Option mit dem Befehl CREATE <object>. Lesen Sie den SQL-Referenzartikel für den Befehl CREATE <object>, den Sie verwenden möchten.