Gestire gli aspetti e arricchire i metadati

Questo documento descrive come creare e gestire i tipi di aspetto e annotare le voci con gli aspetti.

Dataplex Universal Catalog descrive le voci tramite un insieme di aspetti. Puoi descrivere le tue voci con metadati aggiuntivi utilizzando aspetti e tipi di aspetti.

Per saperne di più, consulta Informazioni sulla gestione del catalogo dati in Dataplex Universal Catalog.

Aspetti

Gli aspetti consentono di acquisire metadati all'interno delle voci. L'aggiunta di aspetti a una voce aiuta a fornire un contesto significativo a chiunque debba utilizzare l'asset. Puoi utilizzare gli aspetti per archiviare i metadati aziendali (ad esempio la classificazione dei dati) e i metadati tecnici (ad esempio lo schema).

Gli aspetti sono considerati parti della risorsa di voce e non risorse separate. Quando modifichi un aspetto, devi modificare la voce che lo contiene.

Puoi specificare gli aspetti a livello di voce per descrivere una voce o a livello di colonna per descrivere una colonna in una voce.

Ogni aspetto è un'istanza di un tipo di aspetto. Un tipo di aspetto definisce un modello per i relativi aspetti. Ogni tipo di aspetto contiene un insieme di campi. Quando crei gli aspetti, devi fornire i valori per questi campi.

Per una determinata voce, può esserci al massimo un aspetto associato alla voce, per tipo di aspetto. Puoi avere più aspetti associati alle colonne di inserimento per tipo di aspetto.

Categorie di aspetti

Gli aspetti sono suddivisi nelle seguenti categorie:

  • Aspetti obbligatori: aspetti obbligatori al momento della creazione di una voce. Questi aspetti sono definiti dal tipo di voce di una determinata voce. Tutte le voci appartenenti a un tipo di voce devono sempre avere tutti gli aspetti obbligatori definiti da quel tipo di voce.

    Dataplex Universal Catalog gestisce gli aspetti richiesti (ad esempio lo schema) per le voci di sistema.

    Tieni presente quanto segue:

    • Puoi associare gli aspetti obbligatori solo alle voci e non alle colonne di una voce.

    • Non puoi eliminare gli aspetti obbligatori da una voce.

    • Puoi leggere gli aspetti richiesti delle voci di sistema, ma non puoi modificarli.

  • Aspetti facoltativi: puoi associare aspetti facoltativi alle voci o alle colonne delle voci. Puoi compilare gli aspetti facoltativi al momento della creazione della voce o in un secondo momento aggiornandola.

    Puoi eliminare gli aspetti facoltativi dopo che sono stati compilati.

Tipi di aspetto

I tipi di aspetto sono risorse riutilizzabili che forniscono modelli per gli aspetti.

Categorie di tipi di aspetto

I tipi di aspetto sono suddivisi nelle seguenti categorie:

  • Tipi di aspetto personalizzati: tipi di aspetto creati in Dataplex Universal Catalog.

  • Tipi di aspetto di sistema: tipi di aspetto forniti, utilizzati e gestiti da Dataplex Universal Catalog.

    I tipi di aspetto di sistema sono ulteriormente suddivisi in riutilizzabili e limitati. La seguente tabella descrive le categorie di tipi di aspetti di sistema e l'elenco dei tipi di aspetti forniti da Dataplex Universal Catalog per ciascuna categoria:

    Categoria del tipo di aspetto di sistema Descrizione Tipi di aspetto forniti da Dataplex Universal Catalog
    Tipo di aspetto di sistema riutilizzabile Puoi utilizzare questi tipi di aspetto per creare o modificare gli aspetti.
    • contacts
    • data-quality-scorecard
    • generic
    • overview
    • schema
    • usage
    Tipo di aspetto di sistema con limitazioni Dataplex Universal Catalog gestisce questi tipi di aspetti.
    Puoi leggere gli aspetti in questi tipi di aspetti, ma non puoi crearli o modificarli.     		Inclusi a titolo esemplificativo:
    • analytics-hub
    • aspecttype-aspect
    • bigquery-dataset
    • bigquery-table
    • cloudsql-database
    • cloudsql-instance
    • cloudsql-table
    • entrygroup-aspect
    • entrytype-aspect
    • sensitive-data-protection-profile
    • storage
    • storage-bucket
    • storage-folder

I tipi di aspetto personalizzati possono essere globali o regionali. Puoi creare tipi di aspetto personalizzati in una posizione regionale specifica o come risorsa globale.

I tipi di aspetto globali vengono utilizzati per creare aspetti per le voci in qualsiasi regione. Il contenuto dei tipi di aspetto globali viene replicato in tutte le regioni. I tipi di aspetto regionali vengono utilizzati per creare aspetti per le voci nella stessa regione.

La posizione di un tipo di aspetto influisce sull'ambito della sua applicabilità. Per ulteriori informazioni, vedi Vincoli di progetto e località.

I tipi di aspetto di sistema sono sempre globali. I tipi di aspetti di sistema vengono archiviati in un progetto gestito da Google con ID progetto 655216118709. Ad esempio, projects/655216118709/locations/global/aspectTypes/schema.

Prima di iniziare

Prima di creare e gestire tipi di aspetti e aspetti, completa le attività descritte in questa sezione.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per creare e gestire tipi di aspetto e aspetti, chiedi all'amministratore di concederti i seguenti ruoli IAM sulla risorsa:

  • Set completo di autorizzazioni per le risorse di metadati in Dataplex Universal Catalog, inclusi i tipi di aspetto: Amministratore del catalogo Dataplex (roles/dataplex.catalogAdmin)
  • Crea e gestisci risorse di metadati in Dataplex Universal Catalog, inclusi i tipi di aspetto: Dataplex Catalog Editor (roles/dataplex.catalogEditor)
  • Set completo di autorizzazioni sui tipi di aspetto personalizzati (ad eccezione delle autorizzazioni per utilizzare i tipi di aspetto per creare o modificare le voci): Dataplex Aspect Type Owner (roles/dataplex.aspectTypeOwner)
  • Visualizza i tipi di aspetto e le norme IAM associati: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
  • Utilizza i tipi di aspetto per creare e modificare le voci con gli aspetti corrispondenti: Dataplex Aspect Type User (roles/dataplex.aspectTypeUser)
  • Aggiungi aspetti di alcuni tipi di aspetti di sistema, come schema, overview, contacts: Dataplex Entry Owner (roles/dataplex.entryOwner)

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Per saperne di più, consulta la sezione Ruoli IAM per Dataplex Universal Catalog.

Abilita l'API

Abilita l'API Dataplex nel tuo progetto Dataplex Universal Catalog.

Abilitare l'API

Creare un tipo di aspetto

Console

  1. Nella console Google Cloud , vai alla pagina Catalogo di Dataplex Universal Catalog.

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetti e modelli di tag > Personalizzato.

  3. Fai clic su Crea tipo di aspetto (Dataplex Catalog).

  4. Nella finestra Crea tipo di aspetto, inserisci quanto segue:

    1. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome per il tipo di aspetto.
    2. Nel campo ID tipo di aspetto, inserisci un ID univoco per il tipo di aspetto.
    3. (Facoltativo) Nel campo Descrizione, inserisci una descrizione per il tipo di aspetto.
    4. Nel campo Località, seleziona una località per il tipo di aspetto. Non puoi modificare la posizione di un tipo di aspetto dopo averlo creato.

  5. (Facoltativo) Definisci un modello per il tipo di aspetto.

    Nella sezione Modello, fai clic su Aggiungi campo. Nella sezione Nuovo campo, inserisci quanto segue:

    1. Nel campo Nome, inserisci un nome.
    2. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome visualizzato.
    3. (Facoltativo) Nel campo Descrizione, inserisci una descrizione.

    4. Nel campo Tipo, seleziona un tipo di dati per il campo. In base alla tua selezione, vengono visualizzati il successivo insieme di campi e opzioni:

      • Se hai selezionato Testo come tipo di dati, segui questi passaggi:

        1. Nel campo Tipo di testo, seleziona il tipo di testo.
        2. Nel campo Valori di testo, fornisci un suggerimento per il campo di testo. Per farlo, fai clic su Aggiungi valore e inserisci il suggerimento. Puoi aggiungere più suggerimenti per un campo di testo.
        3. Fai clic su Fine.

      • Se hai selezionato Enum come tipo di dati, aggiungi un valore enum:

        1. Fai clic su Aggiungi un valore enum.
        2. Nel campo Valore, inserisci un valore enum. Puoi aggiungere più valori enum.
        3. Fai clic su Fine.

      • Se hai selezionato Array come tipo di dati, nella sezione Elemento array definisci i tipi di elementi da includere nell'array:

        1. Fai clic su Aggiungi elemento array.
        2. Nel campo Nome, inserisci un nome per gli elementi dell'array.
        3. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome visualizzato per gli elementi dell'array.
        4. (Facoltativo) Nel campo Descrizione, inserisci una descrizione per gli elementi dell'array.

        5. Nel campo Tipo, seleziona un tipo di dati per gli elementi dell'array.

          In base alla selezione, vengono visualizzati il successivo insieme di campi e opzioni. Sono simili alle opzioni descritte per i tipi di dati Testo, Enum, Mappa, Array e Record in un'altra parte di questa sezione.

        6. Fai clic su Fine.

      • Se hai selezionato Mappa come tipo di dati, nella sezione Valore mappa definisci i tipi di valori da includere nella mappa:

        1. Fai clic su Aggiungi valore mappa.
        2. Nel campo Nome, inserisci un nome per la mappa.
        3. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome visualizzato per la mappa.
        4. (Facoltativo) Nel campo Descrizione, inserisci una descrizione per la mappa.

        5. Nel campo Tipo, seleziona un tipo di dati per la mappa.

          In base alla selezione, vengono visualizzati il successivo insieme di campi e opzioni. Sono simili alle opzioni descritte per i tipi di dati Testo, Enum, Mappa, Array e Record in un'altra parte di questa sezione.

        6. Fai clic su Fine.

      • Se hai selezionato Record come tipo di dati, inserisci quanto segue:

        1. Nel campo ID record, inserisci un ID univoco che gli altri campi del record possono utilizzare per fare riferimento a questo record. Consulta la sezione Esempio di utilizzo dei campi ID record e Riferimento record di questo documento.
        2. (Facoltativo) Se vuoi aggiungere un riferimento a un altro record di questo modello, utilizza il campo Riferimento al record. Non puoi modificare questa impostazione dopo aver creato il tipo di aspetto. Consulta la sezione Esempio di utilizzo dei campi ID record e Riferimento record di questo documento.

        3. Nella sezione Campi record, puoi definire un oggetto complesso con più campi nidificati. Per farlo, fai clic su Aggiungi elemento campo record e specifica quanto segue:

        4. Nel campo Nome, inserisci un nome per il campo del record.

        5. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome visualizzato per il campo del record.

        6. (Facoltativo) Nel campo Descrizione, inserisci una descrizione per il campo del record.

        7. Nel campo Tipo, seleziona un tipo di dati.

          In base alla tua selezione, vengono visualizzati il successivo insieme di campi e opzioni. Sono simili alle opzioni descritte per i tipi di dati Testo, Enum, Mappa, Array e Record descritti in precedenza in questa sezione.

        8. Fai clic su Fine.

    5. Per rendere il campo obbligatorio per un aspetto di questo tipo, seleziona È obbligatorio. Per saperne di più sugli aspetti obbligatori e facoltativi, consulta la sezione Categorie di aspetti di questo documento.

    6. Fai clic su Fine.

    7. Per aggiungere più campi, fai clic su Aggiungi campo e ripeti i passaggi precedenti.

  6. (Facoltativo) Nella sezione Etichette, aggiungi etichette arbitrarie alle risorse sotto forma di coppie chiave-valore:

    1. Fai clic su Aggiungi etichetta.
    2. Nel campo Chiave, inserisci una chiave.
    3. Nel campo Valore, inserisci un valore per la chiave.
    4. Per aggiungere altre etichette, fai clic su Aggiungi etichetta e ripeti i passaggi.

  7. Fai clic su Salva.

gcloud

Per creare un tipo di aspetto, utilizza il comando gcloud dataplex aspect-types create.

REST

Per creare un tipo di aspetto, utilizza il metodo aspectType.create.

Dopo aver creato un tipo di aspetto, puoi aggiungere aspetti alle voci.

Esempio di utilizzo dei campi ID record e Riferimento record

Puoi utilizzare i campi ID record e Riferimento record per i riferimenti ricorsivi. Il seguente esempio mostra come utilizzare questi campi:

Prendiamo in considerazione un tipo di aspetto chiamato Employee, con i seguenti campi:

  • Nome (tipo:Text)
  • Data di inizio (tipo:Date & time)
  • Designazione (tipo:Text)
  • Indirizzo attuale (tipo:Record)
  • Indirizzo permanente (tipo:Record)

I due campi indirizzo Indirizzo attuale e Indirizzo permanente sono dello stesso tipo di dati Record. Per evitare duplicazioni, puoi impostare i valori di ID record e Riferimento record quando definisci questi campi.

Quando definisci il campo Indirizzo attuale, puoi specificare ID record come address-field. Per Indirizzo permanente, puoi specificare lo stesso valore (address-field) per Riferimento record. Ad esempio:

  • Nome (tipo:Text)
  • Data di inizio (tipo:Date & time)
  • Designazione (tipo:Text)
  • Indirizzo attuale (tipo:Record, ID record:address-field)
  • Indirizzo permanente (tipo:Record, riferimento record:address-field)

In questo modo, non è necessario duplicare i campi di un altro indirizzo.

Aggiungere aspetti a una voce

Dopo aver creato un tipo di aspetto, puoi creare aspetti di quel tipo. Per aggiungere aspetti a una voce, devi aggiornarla, in quanto gli aspetti sono memorizzati all'interno delle voci.

Tieni presente quanto segue:

  • Puoi aggiungere aspetti a una voce o alle colonne di una voce.
  • Puoi modificare gli aspetti richiesti solo per le voci personalizzate. Non puoi eliminare gli aspetti obbligatori.
  • Puoi modificare ed eliminare gli aspetti facoltativi sia per le voci personalizzate sia per quelle di sistema.

Console

  1. Nella Google Cloud console, vai alla pagina Cerca di Dataplex Universal Catalog.

    Vai a Cerca

  2. Per Scegli la piattaforma di ricerca, seleziona Dataplex Catalog come modalità di ricerca.

  3. Cerca la voce a cui vuoi aggiungere aspetti e fai clic sulla voce. Si apre la pagina dei dettagli della voce.

  4. Per aggiungere aspetti alla voce:

    1. Fai clic sulla scheda Dettagli.
    2. Per aggiungere aspetti obbligatori o facoltativi alla voce, nella sezione Tag e aspetti, fai clic su Aggiungi per la rispettiva categoria.
      Non puoi aggiungere aspetti obbligatori se il tipo di voce della voce selezionata non ha aspetti obbligatori definiti.
    3. Cerca e seleziona l'aspetto che vuoi aggiungere.
    4. Nella finestra Aggiungi aspetto, inserisci i valori per i campi.
    5. Fai clic su Salva.

  5. Per aggiungere aspetti a una colonna della voce:

    1. Nella pagina dei dettagli della voce, fai clic sulla scheda Schema.
    2. Seleziona le colonne a cui vuoi aggiungere gli aspetti.
    3. Fai clic su Aggiungi aspetto.
    4. Cerca e seleziona l'aspetto che vuoi aggiungere.
    5. Nella finestra Aggiungi aspetto, inserisci i valori per i campi.
    6. Fai clic su Salva.

gcloud

Per aggiungere aspetti a una voce o a una colonna di una voce, utilizza il comando gcloud dataplex entries update.

REST

Per aggiungere aspetti a una voce o a una colonna di una voce, utilizza il metodo entry.patch.

La creazione e l'utilizzo di aspetti in una voce in cui il tipo di aspetto e la voce si trovano in organizzazioni Google Cloud diverse non sono supportati.

Gestire gli aspetti esistenti per una voce

Questa sezione descrive come aggiornare ed eliminare gli aspetti esistenti di una voce.

Aggiorna un aspetto

Puoi modificare gli aspetti facoltativi sia per le voci personalizzate sia per quelle di sistema. Puoi modificare gli aspetti richiesti solo per le voci personalizzate.

Console

  1. Nella Google Cloud console, vai alla pagina Cerca di Dataplex Universal Catalog.

    Vai a Cerca

  2. Per Scegli la piattaforma di ricerca, seleziona Dataplex Catalog come modalità di ricerca.

  3. Cerca la voce di cui vuoi aggiornare gli aspetti e fai clic sulla voce.

    Si apre la pagina dei dettagli della voce.

  4. Fai clic sulla scheda Dettagli.

  5. Nella sezione Tag e aspetti, espandi l'aspetto o il tag che vuoi aggiornare e fai clic su Modifica.

  6. Nella finestra Modifica aspetto, aggiorna i campi obbligatori.

  7. Fai clic su Salva.

gcloud

Per aggiornare gli aspetti di una voce o di una colonna di una voce, utilizza il comando gcloud dataplex entries update.

REST

Per aggiornare gli aspetti di una voce o di una colonna di una voce, utilizza il metodo entry.update.

Eliminare un aspetto

Console

  1. Nella Google Cloud console, vai alla pagina Cerca di Dataplex Universal Catalog.

    Vai a Cerca

  2. Per Scegli la piattaforma di ricerca, seleziona Dataplex Catalog come modalità di ricerca.

  3. Cerca la voce di cui vuoi eliminare gli aspetti e fai clic sulla voce.

    Si apre la pagina dei dettagli della voce.

  4. Fai clic sulla scheda Dettagli.

  5. Nella sezione Tag e aspetti, espandi l'aspetto o il tag che vuoi eliminare, fai clic su Elimina.

  6. Fai clic su Conferma.

gcloud

Per eliminare un aspetto per una voce, utilizza il comando gcloud dataplex entries update.

REST

Per eliminare un aspetto per una voce, utilizza il metodo entry.update.

Gestire i tipi di aspetto

Questa sezione descrive come visualizzare, aggiornare ed eliminare i tipi di aspetto.

Visualizza l'elenco dei tipi di aspetti e dei modelli di tag disponibili

Console

  1. Nella console Google Cloud , vai alla pagina Catalogo di Dataplex Universal Catalog.

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetti e modelli di tag.

    Questa pagina elenca tutti i tipi di aspetto di Dataplex Universal Catalog e i modelli di tag di Data Catalog disponibili.

  3. Per visualizzare i tipi di aspetti e i modelli di tag personalizzati, fai clic sulla scheda Personalizzato. Nella scheda Personalizzato, la colonna Origine catalogo mostra dove si trova la risorsa: Dataplex Universal Catalog o Data Catalog.

    Per visualizzare i tipi di aspetti di sistema, fai clic sulla scheda Sistema.

    Per saperne di più sui tipi di aspetti personalizzati e di sistema, consulta la sezione Categorie di tipi di aspetti di questo documento.

  4. (Facoltativo) Per visualizzare l'elenco dei tipi di aspetto e dei modelli di tag nel progetto selezionato, fai clic sulla scheda Personalizzato e poi sul pulsante di attivazione/disattivazione Mostra da tutti i progetti.

    Il pulsante di attivazione/disattivazione Mostra da tutti i progetti è attivo per impostazione predefinita e l'elenco include le risorse di Dataplex Universal Catalog dell'organizzazione selezionata e le risorse di Data Catalog di tutte le organizzazioni a cui puoi accedere.

gcloud

Per elencare tutti i tipi di aspetto disponibili, utilizza il comando gcloud dataplex aspect-types list.

REST

Per elencare tutti i tipi di aspetto disponibili, utilizza il metodo aspectTypes.list.

Visualizzare i dettagli di un tipo di aspetto o di un modello di tag

Console

  1. Nella console Google Cloud , vai alla pagina Catalogo di Dataplex Universal Catalog.

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetti e modelli di tag.

  3. Per visualizzare i dettagli di un tipo di aspetto di Dataplex Universal Catalog, fai clic sul tipo di aspetto. Si apre la pagina dei dettagli del tipo di aspetto, in cui puoi accedere a dettagli come nome visualizzato, ID tipo di aspetto, descrizione, ID progetto, posizione, etichette, data di creazione e data dell'ultima modifica.

    • Per visualizzare la struttura del tipo di aspetto selezionato, fai clic sulla scheda Modello.
    • Per visualizzare l'elenco delle 10 voci correlate create di recente, fai clic sulla scheda Voci di esempio.
    • Per cercare tutte le voci correlate, fai clic su Mostra tutte le voci correlate nella ricerca. Questo pulsante viene visualizzato solo se è presente almeno una voce correlata.

  4. Per visualizzare i dettagli di un modello di tag Data Catalog, fai clic sul modello di tag. La pagina dei dettagli del modello di tag si apre in Data Catalog, dove puoi accedere a dettagli quali nome visualizzato, ID modello, ID progetto, località, visibilità ed etichette.

gcloud

Per ottenere i dettagli di un tipo di aspetto, utilizza il comando gcloud dataplex aspect-types describe.

REST

Per ottenere i dettagli di un tipo di aspetto, utilizza il metodo aspectTypes.get.

Aggiornare un tipo di aspetto

Puoi aggiornare il nome visualizzato, la descrizione, i campi del modello e le etichette di un tipo di aspetto. Non puoi eliminare un campo esistente in un modello.

Non puoi aggiornare l'ID e la posizione del tipo di aspetto dopo averlo creato.

Console

  1. Nella console Google Cloud , vai alla pagina Catalogo di Dataplex Universal Catalog.

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetti e modelli di tag.

  3. Fai clic sul tipo di aspetto che vuoi aggiornare.

  4. Nella pagina Dettagli tipo di aspetto, fai clic su Modifica.

  5. Modifica il nome visualizzato, la descrizione, i campi del modello e le etichette, come richiesto.

  6. (Facoltativo) Per contrassegnare un campo nel tipo di aspetto come ritirato, segui questi passaggi:

    1. Nella sezione Modello, espandi il campo.
    2. Seleziona Is Deprecated (È obsoleta).
    3. Nel campo Motivo della deprecazione, inserisci un motivo per deprecare il campo selezionato.
    4. Fai clic su Fine.

  7. Fai clic su Salva.

gcloud

Per aggiornare un tipo di aspetto, utilizza il comando gcloud dataplex aspect-types update.

REST

Per aggiornare un tipo di aspetto, utilizza il metodo aspectTypes.patch.

Eliminare un tipo di aspetto

Console

  1. Nella console Google Cloud , vai alla pagina Catalogo di Dataplex Universal Catalog.

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetti e modelli di tag.

  3. Fai clic sul tipo di aspetto che vuoi eliminare.

  4. Nella pagina Dettagli tipo di aspetto, fai clic su Elimina. Conferma quando richiesto.

gcloud

Per eliminare un tipo di aspetto, utilizza il comando gcloud dataplex aspect-types delete.

REST

Per eliminare un tipo di aspetto esistente, utilizza il metodo aspectTypes.delete.

Passaggi successivi