Unity Catalog wiki’s

Important

Deze functie bevindt zich in de bètaversie. Accountbeheerders kunnen de toegang tot deze functie beheren via de pagina Previews van de accountconsole. Zie Previews op accountniveau beheren.

Een wiki laat je team de betekenis, het beoogde gebruik en de bronnen van een tabel documenteren, en vervolgens direct samenwerken aan die informatie, direct in Catalog Explorer. Data-eigenaren en -beheerders stellen wiki's op en publiceren ze om de zakelijke context vast te leggen die bij een tabel hoort, zoals definities en bekende kanttekeningen. Iedereen die de metadata van de tabel kan bekijken, kan een gepubliceerde wiki lezen, erop commentaar geven, bewerkingen voorstellen en erop reageren.

Een wiki documenteert één tabel. Een pagina definieert een bedrijfsconcept dat veel assets kan omvatten. Gebruik een wiki voor context over een specifieke tabel en gebruik een pagina voor een gedeelde definitie.

Wikis werken naast de bestaande opmerking in de tabel. Zie Wiki's en tabelcommentaren.

Wat staat er in een wiki

Een wiki bevat de volgende velden:

Veld Description
Description Een samenvatting van één regel van de tabel, weergegeven bovenaan de wiki.
Paginainhoud Rich-text documentatie die koppen, links, afbeeldingen en inline vermeldingen ondersteunt van Unity Catalog securable objects en workspace objects.
Bronnen Links naar de pagina's of externe bronnen waarop de wiki-inhoud is gebaseerd.

Een gepubliceerde wiki op het tabblad Overzicht van een tabel in Catalog Explorer, met een beschrijving, paginadelen en een link naar Bronnen.

Ondersteunde beveiligbare objecten

Je kunt een wiki maken over de volgende Unity Catalog securable objects:

Note

Wiki's zijn niet beschikbaar voor securables die via OpenSharing zijn gedeeld.

Permissions

Een wiki is geen beveiligbaar object. Het is metadata op de tabel, dus je bestaande Unity Catalog-privileges op de tabel bepalen wat je met de wiki kunt doen. Voor achtergrondinformatie over Unity Catalog-privileges, zie concepten van het machtigingenmodel van Unity Catalog.

De volgende privilegetabel gebruikt gebruiksrechten op ouderobjecten om de gebruiksrechten aan te duiden die READ_METADATA, MANAGE of eigenaarschap vereisen om van kracht te worden. Ze hangen af van het object:

  • Tabel: USE SCHEMA op het ouderschema en USE CATALOG op de oudercatalogus.
  • Schema: USE CATALOG in de bovenliggende catalogus.
  • Catalogus: Geen.
Action Vereiste bevoegdheden
Bekijk en werk samen aan gepubliceerde wiki's: bekijk gepubliceerde wiki's, voeg je eigen opmerkingen toe, bewerk of verwijder je eigen opmerkingen, stel bewerkingen voor en voeg reacties toe Een van de volgende:
  • SELECT op de tabel, USE SCHEMA op het schema, en USE CATALOG op de catalogus
  • BROWSE op de bovenliggende catalogus
  • READ_METADATA op de tabel, schema, catalogus of metastore, met gebruiksrechten op ouderobjecten
  • MANAGE op de tabel, het schema of de catalogus, met gebruiksrechten op ouderobjecten
  • Eigenaar van de tabel, het ouderschema of de oudercatalogus, met gebruiksrechten op ouderobjecten
  • Metastore-beheerder
Bekijk conceptwiki's Een van de volgende:
  • READ_METADATA op de tabel, schema, catalogus of metastore, met gebruiksrechten op ouderobjecten
  • MANAGE op de tabel, het schema of de catalogus, met gebruiksrechten op ouderobjecten
  • Eigenaar van de tabel, het ouderschema of de oudercatalogus, met gebruiksrechten op ouderobjecten
  • Metastore-beheerder
Beheer wiki's en reacties: maak, bewerk, publiceer of depubliceer wiki's, accepteer of wijs voorgestelde bewerkingen af, en verwijder elke reactie Een van de volgende:
  • MANAGE op de tabel, het schema of de catalogus, met gebruiksrechten op ouderobjecten
  • Eigenaar van de tabel, het ouderschema of de oudercatalogus, met gebruiksrechten op ouderobjecten
  • Metastore-beheerder

Maak een wiki aan

Om een wiki te maken, heb je de privileges nodig om wiki's in de tabel te beheren. Zie machtigingen.

Je kunt handmatig een wiki maken of er een opstellen met Genie Code.

Warning

Wiki-data wordt in rust versleuteld met door Microsoft beheerde sleutels. Wikis ondersteunen geen encryptie met klantbeheerde sleutels (CMK). Neem geen PII, gereguleerde gegevens of andere gevoelige informatie op in wiki-beschrijvingen of pagina-inhoud.

  1. Open de tabel in Catalog Explorer.

  2. Klik op het tabblad Overzicht op Wiki aanmaken. Als je de Create wiki-banner hebt gesloten, klik dan op het Kebab-menu-icoon. Kebab-menu rechtsboven op de pagina en kies in plaats daarvan Create wiki. Als de tabel een bestaande opmerking heeft, wordt de paginainhoud van de wiki ermee gevuld.

    De Wiki-banner Create boven de beschrijving van een tabel op het tabblad Overzicht

  3. Voeg de wiki-inhoud toe:

    • Om handmatig inhoud te maken, vul je de beschrijving en pagina-inhoud in en voeg je eventuele bronnen toe.
    • Om met Genie Code een concept op te stellen, gebruik je het Genie Code-paneel in de wiki-editor. Voeg bestanden of andere context toe waar Genie Code mee kan werken. Zie Genie Code.
  4. Klik op Opslaan als concept om verder te werken aan de wiki, of klik op Publiceren om deze zichtbaar te maken voor iedereen die de metadata van de tabel kan bekijken.

Nadat je een wiki hebt gepubliceerd, verschijnt deze bovenaan het tabblad Overzicht van de tabel, en de beschrijving van de tabel verschuift naar het tabblad Details .

Bewerk en publiceer wiki's

Om een wiki te bewerken, publiceren of depubliceren, heb je de rechten nodig om wiki's in de tabel te beheren. Zie machtigingen.

  1. Open de tabel in Catalog Explorer.

  2. Klik op de wiki op Bewerken.

  3. Maak je wijzigingen, klik dan op Opslaan om ze op te slaan, of klik op Publiceren om een conceptwiki zichtbaar te maken.

    Een conceptwiki in bewerkingsmodus, met knoppen Annuleren, Opslaan en Publiceren

Om een gepubliceerde wiki te verbergen zonder de inhoud te verliezen, klik je op Bewerken, klik je op het kebabmenu en vervolgens op Publicatie opheffen. De wiki keert terug naar een concept dat alleen gebruikers die concepten kunnen bekijken kunnen zien. Totdat je de wiki opnieuw publiceert, verschijnt de beschrijving van de tabel bovenaan het tabblad Overzicht .

De optie Onpubliceren in het kebabmenu van een gepubliceerde wiki in bewerkingsmodus

Werk samen aan een wiki

Iedereen die een gepubliceerde wiki kan bekijken, kan eraan meewerken. Zie machtigingen.

  • Opmerking: Stel vragen of voeg context toe. Je kunt je eigen reacties bewerken of verwijderen.
  • Bewerkingen voorstellen: Stel wijzigingen voor aan de paginainhoud van de wiki. Klik op Suggesteren, bewerk de paginainhoud en klik op Opslaan. Een gebruiker met de rechten om de wiki te beheren accepteert of wijst het voorstel af.
  • React: Geef de wiki een upvote of downvote om aan te geven of het nuttig was.

Wiki's en tabelcommentaren

Een wiki vervangt de commentaar van de tabel niet, dus bestaande pijplijnen die commentaar lezen of schrijven blijven werken:

  • Je kunt de opmerking nog steeds instellen met COMMENT ON TABLE of ALTER TABLE. De opmerking verschijnt nog steeds in information_schema en in het Beschrijvingsveld in Catalog Explorer.
  • Wanneer je een wiki aanmaakt, vormt de bestaande reactie in de tabel de paginainhoud van de wiki. Daarna zijn de wiki en de reactie onafhankelijk. Wijzigingen in het ene werken niet door in het andere.

Voor meer informatie over tabelcommentaren, zie Opmerkingen toevoegen aan data en AI-assets.

Beheer wiki's met de REST API

Lees en werk de wiki van een tabel programmatisch bij met de REST API voor wiki's. De API ondersteunt de volgende bewerkingen:

  • Haal een wiki: Haal de wiki op voor een tabel.
  • Werk een wiki bij: Werk de wiki bij voor een tabel, of maak er een aan als de tabel er geen heeft. Als je de staat van de wiki op gepubliceerd zet, publiceer je het.

De API vereist dezelfde privileges als de UI. Zie machtigingen. Authenticeer je verzoeken met een persoonlijk toegangstoken van Databricks voor je workspace-gebruiker of OAuth.

Voor details over verzoeken en antwoorden, zie de Wikis REST API-referentie.

Limitations

  • Wiki's zijn alleen beschikbaar op de beveiligbare objecten die in Ondersteunde beveiligbare objecten zijn vermeld. Wiki's over kolommen, schema's, catalogi en andere beveiligbare objecten worden niet ondersteund.
  • Elke tabel kan één wiki hebben.
  • Wiki's zijn niet beschikbaar in Azure Government, Azure China of FedRAMP regio's.