Gestisci gli aspetti e arricchisci i metadati

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

Dataplex Catalog descrive le voci in base a un insieme di aspetti. Puoi descrivere le voci con metadati aggiuntivi utilizzando aspetti e tipi di aspetti.

Per ulteriori informazioni, consulta la panoramica di Dataplex Catalog.

Aspetti

Gli aspetti ti consentono di acquisire i metadati all'interno delle voci. L'aggiunta di aspetti a una voce aiuta a fornire un contesto significativo a chiunque abbia bisogno di utilizzare la risorsa. 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 come parte della risorsa di ingresso e non di risorse separate. La modifica di un aspetto comporta la modifica della voce che lo contiene.

Puoi specificare aspetti a livello di base per la descrizione di 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 suoi 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 delle voci per tipo di aspetto.

Categorie di aspetti

Gli aspetti sono classificati come segue:

  • 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 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 obbligatori delle voci di sistema, ma non puoi modificarli.

  • Aspetti facoltativi: puoi associare gli aspetti facoltativi a voci o a colonne di voci. Puoi completare gli aspetti facoltativi al momento della creazione della voce o in un secondo momento aggiornando la voce.

    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 dei tipi di aspetto

I tipi di aspetto sono classificati come segue:

  • Tipi di aspetto personalizzato: tipi di aspetto che crei in Dataplex Catalog.

  • Tipi di aspetto del sistema: tipi di aspetto che Dataplex fornisce, utilizza e gestisce.

    I tipi di aspetto del sistema sono ulteriormente classificati in riutilizzabili e con restrizioni. La tabella seguente descrive le categorie dei tipi di aspetto di sistema e l'elenco dei tipi di aspetto che Dataplex fornisce per ciascuna delle categorie:

    Categoria del tipo di aspetto di sistema Descrizione Tipi di aspetto forniti da Dataplex
    Tipo di aspetto di sistema riutilizzabile Puoi utilizzare questi tipi di aspetto per creare o modificare aspetti.
    • generic
    • storage
    Tipo di aspetto del sistema con restrizioni Dataplex gestisce questi tipi di aspetto.
    Puoi leggere gli aspetti con questi tipi di aspetto, ma non puoi crearli o modificarli.
    • bigquery-connection
    • bigquery-dataset
    • bigquery-model
    • bigquery-routine
    • bigquery-table
    • bigquery-view
    • cloudsql-database
    • cloudsql-instance
    • cloudsql-schema
    • cloudsql-table
    • cloudsql-view
    • storage
    • sql-access
    • storage-bucket
    • storage-folder

    Non utilizzare i tipi di aspetto di sistema overview, contacts e schema.

    Puoi creare tipi di aspetto personalizzati in una località regionale specifica o come risorsa globale. I tipi di aspetto del sistema sono sempre globali. La posizione di un tipo di aspetto influisce sull'ambito della sua applicabilità. Per ulteriori informazioni, consulta la sezione Limitazioni di progetti e località.

Prima di iniziare

Prima di creare e gestire tipi di aspetto 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 per la risorsa:

  • Set completo di autorizzazioni per tutte le risorse Dataplex Catalog, inclusi i tipi di aspetto: Amministratore Dataplex Catalog (roles/dataplex.catalogAdmin)
  • Crea e gestisci tutte le risorse Dataplex Catalog, inclusi i tipi di aspetto: Editor Dataplex Catalog (roles/dataplex.catalogEditor)
  • Set completo di autorizzazioni per i tipi di aspetto personalizzato (tranne le autorizzazioni per utilizzare i tipi di aspetto per creare o modificare voci): Proprietario del tipo di aspetto Dataplex (roles/dataplex.aspectTypeOwner)
  • Visualizza i tipi di aspetti e i criteri IAM associati: Visualizzatore Dataplex Catalog (roles/dataplex.catalogViewer)
  • Utilizza i tipi di aspetto per creare e modificare le voci con gli aspetti corrispondenti: Utente tipo di aspetto Dataplex (roles/dataplex.aspectTypeUser)
  • Aggiungi aspetti di alcuni tipi di aspetto di sistema, ad esempio schema, overview, contacts: Proprietario voci Dataplex (roles/dataplex.entryOwner)

Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso.

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

Per maggiori informazioni, consulta Ruoli IAM di Dataplex.

Abilita l'API

Abilitare l'API Dataplex nel progetto Dataplex.

Abilitare l'API

Crea un tipo di aspetto

Console

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

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetto > Personalizzato.

  3. Nella sezione Dettagli, 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 Posizione, seleziona una località per il tipo di aspetto. Non puoi modificare la posizione di un tipo di aspetto dopo averlo creato.
  4. (Facoltativo) Definisci un modello per il tipo di aspetto.

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

    1. Inserisci un nome nel campo 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 selezione, viene visualizzato 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, viene visualizzato il set di campi e opzioni successivo. Sono simili alle opzioni descritte per i tipi di dati Text, Enum, Map, Array e Record altrove in 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, viene visualizzato il set di campi e opzioni successivo. Sono simili alle opzioni descritte per i tipi di dati Text, Enum, Map, Array e Record altrove in questa sezione.

        6. Fai clic su Fine.

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

        1. Nel campo Record ID, inserisci un ID univoco che può essere utilizzato da altri campi del record per fare riferimento al record. Consulta la sezione Esempio di utilizzo dei campi di riferimento Record ID e Record di questo documento.
        2. (Facoltativo) Se vuoi aggiungere un riferimento a un altro record da questo modello, utilizza il campo Riferimento record. Non puoi modificarlo dopo aver creato il tipo di aspetto. Consulta la sezione Esempio di utilizzo dei campi di riferimento Record ID e Record di questo documento.
        3. Nella sezione Registra campi, puoi definire un oggetto complesso con più campi nidificati. Per farlo, fai clic su Aggiungi elemento campo record e specifica quanto segue:

          1. Nel campo Nome, inserisci un nome per il campo del record.
          2. (Facoltativo) Nel campo Nome visualizzato, inserisci un nome visualizzato per il campo del record.
          3. (Facoltativo) Nel campo Descrizione, inserisci una descrizione per il campo del record.
          4. Nel campo Tipo, seleziona un tipo di dati.

            In base alla selezione, viene visualizzato il set di campi e opzioni successivo. Sono simili alle opzioni descritte per i tipi di dati Text, Enum, Map, Array e Record precedentemente in questa sezione.

        4. Fai clic su Fine.

    5. Per rendere il campo obbligatorio per un aspetto di questo tipo, seleziona È obbligatorio. Per ulteriori informazioni sugli aspetti obbligatori e facoltativi, consulta la sezione sulle categorie degli aspetti di questo documento.

    6. Fai clic su Fine.

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

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

    1. Fai clic su Aggiungi etichetta.
    2. Inserisci una chiave nel campo 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.
  6. Fai clic su Salva.

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

REST

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

Esempio di utilizzo dei campi di riferimento Record ID e Record

Per i riferimenti ricorsivi, puoi utilizzare i campi ID record e Riferimento record. Nell'esempio seguente viene illustrato come utilizzare questi campi:

Considera 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 hanno lo stesso tipo di dati Record. Per evitare la duplicazione, puoi impostare i valori di ID record e Riferimento record durante la definizione di questi campi.

Quando definisci il campo Indirizzo attuale, puoi specificare Record ID 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.

Aggiungi 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, poiché gli aspetti vengono archiviati all'interno delle voci.

Tieni presente quanto segue:

  • Puoi aggiungere aspetti a una voce o alle relative colonne.
  • Puoi modificare gli aspetti obbligatori 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 le voci di sistema.

Console

  1. Nella console Google Cloud, vai alla pagina Ricerca in Dataplex.

    Vai alla Ricerca

  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 a una voce, segui questi passaggi:

    1. Nella pagina dei dettagli della voce, fai clic sulla scheda Details.
    2. Per aggiungere aspetti obbligatori o facoltativi alla voce, nella sezione Aspetti, fai clic su Aggiungi per la rispettiva categoria.
      Non puoi aggiungere aspetti obbligatori se per il tipo di voce della voce selezionata non sono stati definiti aspetti obbligatori.
    3. Cerca e seleziona l'aspetto da aggiungere.
    4. Nella finestra Aggiungi aspetto, inserisci i valori dei campi.
    5. Fai clic su Salva.
  5. Per aggiungere aspetti a una colonna di una voce:

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

REST

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

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

Gestire gli aspetti esistenti di una voce

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

Aggiornare un aspetto

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

Console

  1. Nella console Google Cloud, vai alla pagina Ricerca in Dataplex.

    Vai alla Ricerca

  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. Per l'aspetto che vuoi aggiornare, fai clic su Modifica.

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

  7. Fai clic su Salva.

REST

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

Eliminare un aspetto

Console

  1. Nella console Google Cloud, vai alla pagina Ricerca in Dataplex.

    Vai alla Ricerca

  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. In corrispondenza dell'aspetto che vuoi eliminare, fai clic su Elimina.

  6. Fai clic su Conferma.

REST

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

Gestisci i tipi di aspetto

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

Visualizza l'elenco dei tipi di aspetto disponibili

Console

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

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetto.

    Puoi accedere all'elenco dei tipi di aspetto personalizzato e di sistema. Per ulteriori informazioni, consulta la sezione sulle categorie dei tipi di aspetto di questo documento.

    Nella scheda Personalizzato, i tipi di aspetto con suffisso (Data Catalog) sono i modelli di tag di cui viene eseguita la migrazione da Data Catalog.

  3. Per visualizzare l'elenco dei tipi di aspetto in tutti i progetti, fai clic sulla scheda Personalizzata, quindi fai clic sul pulsante di attivazione/disattivazione Mostra da tutti i progetti per attivare la funzionalità.

REST

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

Visualizzare i dettagli di un tipo di aspetto

Console

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

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetto.

  3. Fai clic sul tipo di aspetto.

    Si apre la pagina dei dettagli del tipo di aspetto. Puoi visualizzare informazioni come nome visualizzato, ID del tipo di aspetto, descrizione, ID progetto, località, etichette, data di creazione e data dell'ultima modifica del tipo di aspetto selezionato.

  4. Per visualizzare la struttura del tipo di aspetto selezionato, fai clic sulla scheda Modello.

  5. Per visualizzare l'elenco delle 10 voci correlate create di recente, fai clic sulla scheda Voci di esempio.

  6. Per cercare tutte le voci correlate, fai clic su Mostra tutte le voci correlate nella Ricerca. Questo pulsante viene visualizzato solo se esiste almeno una voce correlata.

REST

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

Aggiorna 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 aver creato il tipo di aspetto.

Console

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

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetto.

  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 necessario.

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

    1. Nella sezione Modello, espandi il campo.
    2. Seleziona È deprecato.
    3. Nel campo Motivo del ritiro, inserisci un motivo per il ritiro del campo selezionato.
    4. Fai clic su Fine.
  7. Fai clic su Salva.

REST

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

Eliminare un tipo di aspetto

Console

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

    Vai al catalogo

  2. Fai clic sulla scheda Tipi di aspetto.

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

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

REST

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

Passaggi successivi