Wiki di Unity Catalog

Importante

Questa funzionalità è in versione beta. Gli amministratori dell'account possono gestire l'accesso a questa funzionalità dalla pagina Anteprime della console dell'account. Vedi Gestire le anteprime a livello di account.

Un wiki permette al tuo team di documentare il significato di una tabella, l'uso previsto e le fonti, per poi collaborare su quelle informazioni direttamente in Catalog Explorer. I proprietari dei dati e gli steward redigono e pubblicano wiki per catturare il contesto aziendale associato a una tabella, come definizioni e caveat noti. Chiunque possa visualizzare i metadati della tabella può leggere un wiki pubblicato, commentarlo, suggerire modifiche e reagire ad esso.

Un wiki documenta una tabella. Una Pagina definisce un concetto di business che può abbracciare molti asset. Usa un wiki come contesto per una tabella specifica e usa una pagina per una definizione condivisa.

I wiki coesistono con il commento esistente della tabella. Consulta le Wiki e i commenti delle tabelle.

Cosa c'è in una wiki

Un wiki contiene i seguenti campi:

Campo Description
Description Un riassunto di una riga della tabella, mostrato in cima alla wiki.
Corpo della pagina Documentazione con testo formattato che supporta intestazioni, link, immagini e menzioni in linea di oggetti proteggibili di Unity Catalog e oggetti del workspace.
Sources Collegamenti alle Pagine o alle fonti esterne su cui si basa il contenuto della wiki.

Un wiki pubblicato nella scheda Panoramica di una tabella in Catalog Explorer, con una descrizione, sezioni del corpo della pagina e un link Fonti

Oggetti proteggibili supportati

Puoi creare una wiki sui seguenti oggetti proteggibili del Catalogo Unity:

Note

Le wiki non sono disponibili sugli oggetti proteggibili condivisi tramite OpenSharing.

Permissions

Un wiki non è un oggetto a cui è possibile applicare autorizzazioni. I metadati sono associati alla tabella, quindi i privilegi esistenti nel Catalogo Unity sulla tabella determinano cosa puoi fare con il relativo wiki. Per informazioni di base sui privilegi di Unity Catalog, vedi concetti del modello di permessi di Unity Catalog.

La tabella dei privilegi che segue utilizza i privilegi di utilizzo sugli oggetti genitori per indicare i privilegi d'uso che READ_METADATA, MANAGE, o la titolarità richiedono per entrare in vigore. Dipendono dall'oggetto:

  • Tabella: USE SCHEMA sullo schema genitore e USE CATALOG sul catalogo genitore.
  • Schema: USE CATALOG sul catalogo genitore.
  • Catalogo: Nessuno.
Action Privilegi obbligatori
Visualizza e collabora sui wiki pubblicati: visualizza i wiki pubblicati, aggiungi, modifica o elimina i tuoi commenti, suggerisci modifiche e aggiungi reazioni Uno dei seguenti:
  • SELECT sul tavolo, USE SCHEMA sullo schema e USE CATALOG sul catalogo
  • BROWSE nel catalogo principale
  • READ_METADATA sulla tabella, schema, catalogo o metastore, con privilegi di utilizzo sugli oggetti genitori
  • MANAGE sulla tabella, sullo schema o sul catalogo, con privilegi d'uso sugli oggetti genitori
  • Proprietario della tabella, dello schema genitore o del catalogo genitore, con privilegi di utilizzo sugli oggetti genitori
  • Amministratore del metastore
Visualizza le bozze dei wiki Uno dei seguenti:
  • READ_METADATA sulla tabella, schema, catalogo o metastore, con privilegi di utilizzo sugli oggetti genitori
  • MANAGE sulla tabella, sullo schema o sul catalogo, con privilegi d'uso sugli oggetti genitori
  • Proprietario della tabella, dello schema genitore o del catalogo genitore, con privilegi di utilizzo sugli oggetti genitori
  • Amministratore del metastore
Gestisci wiki e commenti: crea, modifica, pubblica o dispubblica wiki, accetta o rifiuta modifiche suggerite ed elimina qualsiasi commento Uno dei seguenti:
  • MANAGE sulla tabella, sullo schema o sul catalogo, con privilegi d'uso sugli oggetti genitori
  • Proprietario della tabella, dello schema genitore o del catalogo genitore, con privilegi di utilizzo sugli oggetti genitori
  • Amministratore del metastore

Crea un wiki

Per creare un wiki, hai bisogno dei privilegi per gestire i wiki nella tabella. Vedere Autorizzazioni.

Puoi creare una wiki manualmente o redigerne una con Genie Code.

Warning

I dati wiki sono criptati a riposo con chiavi gestite da Microsoft. I wiki non supportano la crittografia con chiavi gestite dal cliente (CMK). Non includere PII, dati regolamentati o altre informazioni sensibili nelle descrizioni wiki o nei corpi delle pagine.

  1. In Catalog Explorer, apri la tabella.

  2. Nella scheda Panoramica generale, clicca su Crea wiki. Se hai chiuso il banner Crea wiki, fai clic sull'icona del menu kebab. nell'angolo in alto a destra della pagina e seleziona invece Crea wiki. Se la tabella ha un commento esistente, questo inizializza il contenuto della pagina del wiki.

    Il banner Crea wiki sopra la descrizione di una tabella nella scheda Panoramica

  3. Aggiungi il contenuto della wiki:

    • Per creare manualmente, compila Descrizione e il corpo della pagina e aggiungi eventuali Fonti.
    • Per redigere con il codice Genie, usa il pannello del codice Genie nell'editor wiki. Allega file o altri contesti su cui Genie Code può lavorare. Vedere Codice Genie.
  4. Clicca su Salva come bozza per continuare a lavorare sulla wiki, oppure clicca su Pubblica per renderla visibile a chiunque possa visualizzare i metadati della tabella.

Dopo aver pubblicato un wiki, appare in cima alla scheda Panoramica della tabella e la Descrizione della tabella si sposta nella scheda Dettagli .

Modifica e pubblica wiki

Per modificare, pubblicare o annullare la pubblicazione di un wiki, hai bisogno dei privilegi per gestire i wiki nella tabella. Vedere Autorizzazioni.

  1. In Catalog Explorer, apri la tabella.

  2. Sul wiki, clicca su Modifica.

  3. Fai le tue modifiche, poi clicca su Salva per salvarle, oppure clicca su Pubblica per rendere visibile una bozza wiki.

    Una bozza wiki in modalità modifica, con i pulsanti Annulla, Salva e Pubblica

Per nascondere un wiki pubblicato senza perdere il suo contenuto, clicca su Modifica, sul menu kebab e poi su Annulla pubblicazione. La wiki torna a una bozza che solo gli utenti che possono visualizzare le bozze possono vedere. Fino a quando non ripubblichi la wiki, la Descrizione della tabella appare in cima alla scheda Panoramica .

L'opzione Annulla la pubblicazione nel menu kebab di una wiki pubblicata in modalità modifica

Collabora su una wiki

Chiunque possa consultare una wiki pubblicata può collaborare alla wiki. Vedere Autorizzazioni.

  • Commento: Fai domande o aggiungi contesto. Puoi modificare o cancellare i tuoi commenti.
  • Suggerisci modifiche: Suggerisci modifiche al corpo della pagina del wiki. Clicca su Suggerisci, modifica il corpo della pagina e poi clicca su Salva. Un utente con i privilegi per gestire il wiki accetta o rifiuta il suggerimento.
  • Reagisci: vota positivamente o negativamente la wiki per segnalare se è stata utile.

Wiki e commenti delle tabelle

Una wiki non sostituisce il commento della tabella, quindi le pipeline esistenti che leggono o scrivono commenti continuano a funzionare:

  • Puoi comunque impostare il commento con COMMENT ON TABLE o ALTER TABLE. Il commento appare ancora in information_schema e nel campo Descrizione di Catalog Explorer.
  • Quando crei un wiki, il commento esistente della tabella inizializza il corpo della pagina del wiki. Dopo di che, la wiki e il commento diventano indipendenti. Le modifiche a uno non aggiornano l'altro.

Per saperne di più sui commenti delle tabelle, vedi Aggiungi commenti ai dati e agli asset di intelligenza artificiale.

Gestisci wiki con l'API REST

Leggi e aggiorna la wiki di una tabella in modo programmativo con l'API REST della wiki. L'API supporta le seguenti operazioni:

  • Recuperare una wiki: Recupera la wiki per una tabella.
  • Aggiorna un wiki: aggiorna il wiki per una tabella, oppure crealo se la tabella non ne ha uno. Impostare lo stato della wiki su pubblicato la pubblica.

L'API richiede gli stessi privilegi dell'interfaccia utente. Vedere Autorizzazioni. Autentica le tue richieste con un token di accesso personale di Databricks per l'utente del workspace oppure con OAuth.

Per i dettagli su richieste e risposte, consulta il riferimento API REST di Wikis.

Limitations

  • I wiki sono disponibili solo sugli oggetti proteggibili elencati in Oggetti proteggibili supportati. I wiki su colonne, schemi, cataloghi e altri oggetti a cui è possibile applicare autorizzazioni non sono supportati.
  • Ogni tabella può avere un wiki.
  • Le wiki non sono disponibili nelle regioni di Azure per enti pubblici, Azure China o FedRAMP.