Visualizzare gli approfondimenti di Knowledge Catalog

Puoi cercare e gestire le tue risorse Cloud Firestore utilizzando Knowledge Catalog, una piattaforma per archiviare, gestire e accedere ai tuoi metadati. Puoi utilizzare Knowledge Catalog per analizzare i metadati Cloud Firestore e aiutarti con attività come:

  • Analisi, incluse le dipendenze e l'idoneità per un caso d'uso
  • Gestione dei cambiamenti
  • Evoluzione dello schema

Knowledge Catalog è abilitato per impostazione predefinita nei database Cloud Firestore nuovi ed esistenti e recupera automaticamente i seguenti metadati:

Risorsa Tipo Campi
Database Control plane
  • Edizione
  • Modalità
  • Località (incluse le multiregioni)
  • ID progetto
  • Nome database
  • Data/ora creazione
Schema del database Piano dati
  • Nome
  • Raccolta
  • Campo - Tipo/i di dati
  • Schema

Prima di iniziare

Per utilizzare gli approfondimenti di Knowledge Catalog con Cloud Firestore, devi prima disporre di un database Cloud Firestore. Per saperne di più, vedi Creare e gestire database.

Ruoli richiesti per accedere ai risultati di ricerca

Per cercare e visualizzare i metadati di Cloud Firestore in Knowledge Catalog, i principal devono disporre delle autorizzazioni per visualizzare le risorse Cloud Firestore, inclusa l'autorizzazione dataplex.projects.search.

Per concedere queste autorizzazioni alle entità, come utenti, gruppi o service account, assegna loro il ruolo IAM Visualizzatore Cloud Datastore (roles/datastore.viewer) nel progetto che contiene le risorse Cloud Firestore.

Operazione Knowledge Catalog Cloud Firestore risorsa Ruoli o autorizzazioni richiesti
Cercare risorse Cloud Firestore Database datastore.databases.getMetadata
Schema del database datastore.schemas.get

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso. Per saperne di più sui ruoli IAM Cloud Firestore, consulta Ruoli e autorizzazioni Cloud Firestore.

Ruoli obbligatori per la ricerca di voci

Per cercare le voci, devi avere almeno uno dei seguenti ruoli IAM nel progetto utilizzato per la ricerca:

Le autorizzazioni sui risultati di ricerca vengono controllate indipendentemente dal progetto selezionato. Per ulteriori informazioni, consulta la pagina Cercare asset di dati con Knowledge Catalog.

Tipi di rilevamento dei metadati

Il rilevamento dei metadati di Knowledge Catalog è un processo automatizzato che analizza le origini dati connesse, come Cloud Firestore, per identificare gli asset di dati (come raccolte e database) ed estrarre i relativi metadati tecnici, come schemi, descrizioni e posizioni, nel catalogo Knowledge Catalog. Questo processo viene eseguito periodicamente per mantenere il catalogo sincronizzato con i sistemi di origine.

Knowledge Catalog supporta le ricerche per parole chiave e in linguaggio naturale.

  • La ricerca per parole chiave ti consente di trovare risorse utilizzando parole chiave, filtri e una sintassi definiti. Ad esempio, puoi inserire system=Firestore AND type=Database per visualizzare tutti i database Cloud Firestore.
  • La ricerca in linguaggio naturale (anteprima) utilizza l'AI per comprendere le query semantiche. Ti consente di trovare risorse utilizzando un linguaggio naturale, eliminando la necessità di una sintassi complessa. Ad esempio, puoi inserire query come List all Firestore databases related to sales.

Per ulteriori informazioni, vedi Sintassi di ricerca per Knowledge Catalog.

Esempio: scopri uno schema del gruppo di raccolte Cloud Firestore

Per comprendere il processo di rilevamento dei metadati, considera un database Cloud Firestore denominato user-firestore-database. In questo database hai uno schema di gruppo di raccolta denominato user-schema.

Al termine dell'individuazione, puoi cercare questi asset, user-firestore-database e user-schema, nella pagina Knowledge Catalog della console Google Cloud o utilizzando l'API Knowledge Catalog. Puoi quindi visualizzare i dettagli sugli asset e arricchirli con metadati aziendali o operativi aggiuntivi.

Arricchire i metadati utilizzando gli aspetti

I tipi di aspetto sono risorse riutilizzabili che puoi utilizzare come modelli per gli aspetti. I tipi di aspetto ti aiutano a evitare la duplicazione del lavoro e gli aspetti incompleti. Puoi utilizzare Knowledge Catalog per creare i tipi di aspetto di cui hai bisogno.

Dopo aver creato tipi di aspetto personalizzati, puoi allegare gli aspetti alle tue risorse Cloud Firestore. L'allegato degli aspetti alle risorse ti consente di:

  • Aggiungere metadati aziendali agli asset
  • Cercare asset in base ai metadati aziendali e ad altri metadati personalizzati

Per scoprire di più sulla creazione di tipi di aspetto e sull'aggiunta di aspetti a Cloud Firestore, consulta Gestire gli aspetti e arricchire i metadati.

Cerca asset Cloud Firestore

Utilizza la pagina di ricerca di Knowledge Catalog nella console Google Cloud per cercare asset Cloud Firestore.

  1. Vai alla pagina Ricerca di Knowledge Catalog.

    Vai a Cerca

  2. Nel riquadro Filtri, fai clic su Sistemi e poi seleziona Firestore.

  3. Facoltativo. In Alias di tipo, puoi filtrare i risultati di ricerca in base a un tipo specifico di asset Cloud Firestore selezionando uno o più dei seguenti alias di tipo:

    • Database
    • Schema del database
    • Altro

Puoi utilizzare il campo di ricerca in Knowledge Catalog per eseguire query di ricerca per parole chiave. Ad esempio, puoi inserire system=Firestore AND type=Database per visualizzare tutti i database Cloud Firestore.

Per ulteriori informazioni, vedi Sintassi di ricerca per Knowledge Catalog.

Per visualizzare tutti gli asset Cloud Firestore, inserisci system=Firestore. Puoi inserire parole chiave specifiche. Ad esempio, per visualizzare tutti i database Cloud Firestore:

system=Firestore AND type=Database

Puoi anche utilizzare le parentesi e gli operatori logici AND e OR per espressioni complesse. Per scoprire di più sulle espressioni che puoi utilizzare nel campo di ricerca, consulta Sintassi di ricerca per Knowledge Catalog.

Puoi inserire direttamente le query di ricerca per asset Cloud Firestore specifici nel campo di ricerca. Il formato della stringa di query è il seguente:

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Sostituisci quanto segue:

  • QUERY_STRING: utilizza il seguente elenco per identificare una stringa di query in base al tipo di asset Cloud Firestore per cui vuoi eseguire una query:

    • firestore-database
    • firestore-schema

Una query di esempio potrebbe avere il seguente aspetto:

type="projects/1234567890/locations/global/entryTypes/firestore-schema"

Cercare per tipo di aspetto

Knowledge Catalog include alcuni tipi di aspetto integrati che puoi utilizzare per eseguire ricerche.

Per eseguire la ricerca in base al tipo di aspetto:

  1. Nel riquadro Aspetti, fai clic sul menu Aggiungi altri tipi di aspetti.
  2. Inserisci Firestore, poi seleziona uno o più dei seguenti tipi di aspetto per limitare i risultati di ricerca a quel tipo.
    • Cloud Firestore database
    • Cloud Firestore schema
  3. Fai clic su OK.
  4. Nella tabella dei risultati, fai clic sul nome della risorsa per visualizzarne i metadati.
  5. (Facoltativo) Migliora o visualizza i tuoi asset. Puoi eseguire una delle seguenti operazioni:
    • Per aggiungere una descrizione in formato RTF dell'asset, in Panoramica, fai clic su Aggiungi .
    • Per allegare un aspetto all'asset, in Aspetti, fai clic su Aggiungi .
    • Per visualizzare i database dei membri di un'istanza, fai clic sulla scheda Elenco voci, quindi fai clic su Mostra tutte le voci secondarie nella ricerca.
    • In Dettagli voce, visualizza i dettagli completi dell'asset. Fai clic sul nome della voce per visualizzare ulteriori voci.

Ricerca in linguaggio naturale in Cloud Firestore

La ricerca in linguaggio naturale (anteprima) utilizza l'AI per comprendere le query semantiche. Ti consente di trovare risorse utilizzando un linguaggio naturale, eliminando la necessità di una sintassi complessa. Ad esempio, puoi inserire query come List all Firestore collections related to sales.

Per ulteriori informazioni, vedi Sintassi di ricerca per Knowledge Catalog.

Ricerca della sintassi in Cloud Firestore

La ricerca per parole chiave ti consente di trovare risorse utilizzando parole chiave, filtri e una sintassi definiti. Ad esempio, puoi inserire system=Firestore AND type=Database per visualizzare tutti i database Cloud Firestore.

Per ulteriori informazioni, vedi Sintassi di ricerca per Knowledge Catalog.

Flusso di lavoro di esempio: visualizzare in dettaglio dal database allo schema

Per visualizzare in dettaglio un database fino a uno schema:

  1. Vai alla pagina Ricerca di Knowledge Catalog.

    Vai a Cerca

  2. Nel riquadro Filtri, seleziona Sistemi e poi Firestore. In alternativa, inserisci system=Firestore nel campo di ricerca.

  3. Seleziona un database.

  4. Nella pagina Dettagli Firestore, fai clic sulla scheda Elenco voci, quindi fai clic su Mostra tutte le voci secondarie nella ricerca.

  5. Nella pagina Dettagli database Firestore, fai clic sulla scheda Elenco voci, quindi su Mostra tutte le voci secondarie nella ricerca. Knowledge Catalog mostra i gruppi di raccolte nel database.

  6. Seleziona un nome di gruppo di raccolta, quindi nella pagina Dettagli gruppo di raccolta, fai clic su Schema per visualizzare lo schema.

  7. (Facoltativo) Per aggiungere un tipo di aspetto a un database, fai clic sul pulsante Aggiungi aspetto.

Prezzi

Non è previsto alcun costo per l'archiviazione dei metadati tecnici Cloud Firestore in Knowledge Catalog. Si applicano i prezzi standard di Knowledge Catalog per le chiamate API e l'arricchimento dei metadati aziendali aggiuntivi. Per ulteriori informazioni, consulta la pagina dei prezzi di Knowledge Catalog.

Limitazioni

  • I risultati della query vengono troncati dopo l'importazione di 10.000 gruppi di raccolta.
  • Durante l'importazione batch, potrebbero essere necessarie fino a 48 ore prima che gli aggiornamenti al database vengano visualizzati in Knowledge Catalog.
  • Durante l'importazione live, possono essere necessari fino a 5 minuti prima che gli aggiornamenti al database vengano visualizzati in Knowledge Catalog.
  • I gruppi di raccolte non vengono aggiornati durante l'importazione live.
  • Gli schemi dei gruppi di raccolte vengono aggiornati durante l'importazione in tempo reale, ma questo aggiornamento riguarda solo i primi 100 campi primitivi di primo livello in ordine alfabetico. Le informazioni rimanenti dello schema vengono aggiornate 24-48 ore dopo l'importazione in tempo reale.
  • Il processo di estrazione può richiedere diversi minuti.

Passaggi successivi