Unity-Katalog-Wikis

Important

Dieses Feature befindet sich in der Betaversion. Kontoadministratoren können den Zugriff auf dieses Feature über die Seite " Vorschauen " der Kontokonsole verwalten. Siehe Verwalten von Vorschauen auf Kontoebene.

Ein Wiki ermöglicht es Ihrem Team, die Bedeutung, den vorgesehenen Zweck und die Quellen einer Tabelle zu dokumentieren und dann direkt im Catalog Explorer an diesen Informationen zusammenzuarbeiten. Datenbesitzer und Stewards entwerfen und veröffentlichen Wikis, um den Geschäftskontext zu erfassen, der zu einer Tabelle gehört, wie Definitionen und bekannte Einschränkungen. Jeder, der die Metadaten der Tabelle einsehen kann, kann ein veröffentlichtes Wiki lesen, kommentieren, Änderungen vorschlagen und darauf reagieren.

Ein Wiki dokumentiert eine Tabelle. Eine Page definiert ein Geschäftskonzept, das viele Assets umfassen kann. Nutze ein Wiki für den Kontext zu einer bestimmten Tabelle und eine Seite für eine gemeinsame Definition.

Wikis funktionieren zusammen mit dem vorhandenen Kommentar der Tabelle. Siehe Wikis und Tabellenkommentare.

Was ist in einem Wiki

Ein Wiki enthält folgende Felder:

Feld Description
Description Eine einzeilige Zusammenfassung der Tabelle, die oben im Wiki gezeigt wird.
Seiteninhalt Rich-Text-Dokumentation, die Überschriften, Links, Bilder und Inline-Erwähnungen von Unity Catalog-Sicherungsobjekten und Arbeitsbereichsobjekten unterstützt.
Sources Links zu den Seiten oder externen Quellen, auf denen der Wiki-Inhalt basiert.

Ein veröffentlichtes Wiki auf dem Übersichtsreiter einer Tabelle im Catalog Explorer, mit einer Beschreibung, Seitentextabschnitten und einem Link zu Quellen

Unterstützte sicherungsfähige Elemente

Sie können ein Wiki über die folgenden sicherbaren Unity Catalog-Objekte erstellen:

Note

Wikis sind nicht auf über OpenSharing geteilten Securables verfügbar.

Erlaubnisse

Ein Wiki ist kein sicherbares Objekt. Es sind Metadaten auf der Tabelle, sodass Ihre bestehenden Unity Catalog-Privilegien auf der Tabelle bestimmen, was Sie mit dem Wiki machen können. Hintergrundinformationen zu den Unity Catalog Berechtigungen finden Sie unter Konzepte des Berechtigungsmodells von Unity Catalog.

Die folgende Privilegientabelle verwendet Nutzungsrechte auf übergeordneten Objekten, um die Nutzungsrechte zu bezeichnen, die READ_METADATA, MANAGE oder Eigentum erfordern, um wirksam zu werden. Sie hängen vom Objekt ab:

  • Tabelle: USE SCHEMA auf dem Elternschema und USE CATALOG im Elternkatalog.
  • Schema: USE CATALOG im übergeordneten Katalog.
  • Katalog: Keine.
Action Erforderliche Berechtigungen
Sehen Sie sich veröffentlichte Wikis an und arbeiten Sie zusammen: Veröffentlichte Wikis ansehen, eigene Kommentare hinzufügen, bearbeiten oder löschen, Bearbeitungen vorschlagen und Reaktionen hinzufügen Eins der folgenden:
  • SELECT auf dem Tisch, USE SCHEMA im Schema und USE CATALOG im Katalog
  • BROWSE im übergeordneten Katalog
  • READ_METADATA für die Tabelle, im Schema, im Katalog oder im Metastore, mit Nutzungsrechten für übergeordnete Objekte
  • MANAGE für die Tabelle, im Schema oder im Katalog mit Nutzungsrechten für übergeordnete Objekte
  • Eigentümer der Tabelle, des übergeordneten Schemas oder übergeordneten Katalogs mit Nutzungsrechten für übergeordnete Objekte
  • Metastore-Administrator
Entwurf-Wikis ansehen Eins der folgenden:
  • READ_METADATA für die Tabelle, im Schema, im Katalog oder im Metastore, mit Nutzungsrechten für übergeordnete Objekte
  • MANAGE für die Tabelle, im Schema oder im Katalog mit Nutzungsrechten für übergeordnete Objekte
  • Eigentümer der Tabelle, des übergeordneten Schemas oder übergeordneten Katalogs mit Nutzungsrechten für übergeordnete Objekte
  • Metastore-Administrator
Wikis und Kommentare verwalten: Wikis erstellen, bearbeiten, veröffentlichen oder die Veröffentlichung aufheben, vorgeschlagene Änderungen akzeptieren oder ablehnen und jeden Kommentar löschen Eins der folgenden:
  • MANAGE für die Tabelle, im Schema oder im Katalog mit Nutzungsrechten für übergeordnete Objekte
  • Eigentümer der Tabelle, des übergeordneten Schemas oder übergeordneten Katalogs mit Nutzungsrechten für übergeordnete Objekte
  • Metastore-Administrator

Erstelle ein Wiki

Um ein Wiki zu erstellen, brauchen Sie die Rechte, Wikis in der Tabelle zu verwalten. Siehe Berechtigungen.

Du kannst ein Wiki manuell erstellen oder eines mit Genie Code entwerfen.

Warning

Wiki-Daten werden im Ruhezustand mit von Microsoft verwalteten Schlüsseln verschlüsselt. Wikis unterstützen keine Verschlüsselung mit kundenseitig verwaltetem Schlüssel (CMK). Fügen Sie keine PII, regulierte Daten oder andere sensible Informationen in Wiki-Beschreibungen oder Seiteninhalte ein.

  1. Öffnen Sie im Katalog-Explorer die Tabelle.

  2. Klicken Sie auf der Registerkarte „Übersicht“ auf Wiki erstellen. Wenn du das Create-Wiki-Banner geschlossen hast, klicke oben rechts auf der Seite auf das Kebab-Menü Kebab-Menüsymbol und wähle stattdessen Create wiki. Wenn die Tabelle einen bestehenden Kommentar hat, wird der Seitentext des Wikis vorbefüllt.

    Das Create-Wiki-Banner über der Beschreibung einer Tabelle auf der Registerkarte „Übersicht“

  3. Fügen Sie den Wiki-Inhalt hinzu:

    • Um manuell zu verfassen, füllen Sie die Beschreibung und den Seiteninhalt aus und fügen Sie gegebenenfalls Quellen hinzu.
    • Um mit Genie Code Entwürfe zu erstellen, benutzen Sie das Genie-Code-Fenster im Wiki-Editor. Fügen Sie Dateien oder anderen Kontext an, aus dem Genie Code arbeiten kann. Siehe Genie Code.
  4. Klicken Sie auf Als Entwurf speichern , um weiter am Wiki zu arbeiten, oder klicken Sie auf Veröffentlichen , um es für alle sichtbar zu machen, die die Metadaten der Tabelle einsehen können.

Nachdem du ein Wiki veröffentlicht hast, erscheint es oben im Übersichtstab der Tabelle , und die Beschreibung der Tabelle wechselt zum Reiter Details .

Wikis bearbeiten und veröffentlichen

Um ein Wiki zu erstellen, zu veröffentlichen oder die Veröffentlichung aufzuheben, brauchen Sie die Rechte, Wikis in der Tabelle zu verwalten. Siehe Berechtigungen.

  1. Öffnen Sie im Katalog-Explorer die Tabelle.

  2. Im Wiki klicke auf Bearbeiten.

  3. Nimm deine Änderungen vor, dann klicke auf Speichern, um sie zu speichern, oder auf Veröffentlichen, um einen Wiki-Entwurf sichtbar zu machen.

    Ein Entwurfs-Wiki im Bearbeitungsmodus mit Knöpfen für Abbrechen, Speichern und Veröffentlichen

Um ein veröffentlichtes Wiki auszublenden, ohne dessen Inhalt zu verlieren, klicken Sie auf Bearbeiten, klicken Sie auf das Kebab-Menü und dann auf Veröffentlichung aufheben. Das Wiki kehrt zu einem Entwurf zurück, den nur Nutzer sehen können, die Entwürfe einsehen können. Bis Sie das Wiki erneut veröffentlichen, erscheint die Beschreibung der Tabelle oben im Übersichtsreiter .

Die Option

Arbeiten Sie an einem Wiki zusammen

Jeder, der ein veröffentlichtes Wiki einsehen kann, kann daran mitarbeiten. Siehe Berechtigungen.

  • Kommentar: Stellen Sie Fragen oder fügen Sie Kontext hinzu. Du kannst deine eigenen Kommentare bearbeiten oder löschen.
  • Änderungen vorschlagen: Änderungen am Seitentext des Wikis vorschlagen. Klicken Sie auf Vorschlagen, bearbeiten Sie den Seitentext und klicken Sie auf Speichern. Ein Nutzer mit den Rechten zur Verwaltung des Wikis akzeptiert oder lehnt den Vorschlag ab.
  • React: Upvote oder downvote das Wiki, um zu signalisieren, ob es hilfreich war.

Wikis und Tabellenkommentare

Ein Wiki ersetzt den Kommentar der Tabelle nicht, daher funktionieren bestehende Pipelines, die Kommentare lesen oder schreiben, weiter:

  • Du kannst den Kommentar weiterhin mit COMMENT ON TABLE oder ALTER TABLEfestlegen. Der Kommentar erscheint weiterhin im Bereich information_schema und im Feld Beschreibung im Katalog-Explorer.
  • Wenn du ein Wiki erstellst, dient der bestehende Kommentar der Tabelle als Grundlage für den Seitentext des Wikis. Danach sind das Wiki und der Kommentar unabhängig. Änderungen an der einen aktualisieren die andere nicht.

Weitere Informationen zu Tabellenkommentaren finden Sie unter Kommentare zu Daten und KI-Assets hinzufügen.

Verwaltung von Wikis mit der REST-API

Lesen und aktualisieren Sie das Wiki einer Tabelle programmatisch mit der Wiki-REST-API. Die API unterstützt folgende Operationen:

  • Wiki abrufen: Rufen Sie das Wiki für eine Tabelle ab.
  • Aktualisieren Sie ein Wiki: Aktualisieren Sie das Wiki für eine Tabelle oder erstellen Sie es, wenn die Tabelle keines hat. Wenn man den Status des Wikis auf veröffentlicht setzt, wird es veröffentlicht.

Die API benötigt die gleichen Rechte wie die Benutzeroberfläche. Siehe Berechtigungen. Authentifizieren Sie Ihre Anfragen mit einem Databricks Personal Access Token für Ihren Workspace-Benutzer oder OAuth.

Für Details zur Anfrage und Antwort siehe die Wikis REST API-Referenz.

Limitations

  • Wikis sind nur auf den in Supported Securables aufgeführten Objekten verfügbar. Wikis zu Spalten, Schemata, Katalogen und anderen sicherbaren Objekten werden nicht unterstützt.
  • Jede Tabelle kann ein Wiki haben.
  • Wikis sind in den Regionen Azure Government, Azure China oder FedRAMP nicht verfügbar.