Sintassi di ricerca di Data Catalog

Questo documento descrive la sintassi per le query di ricerca di Data Catalog. Prima di leggere questo documento, è importante aver compreso i concetti di Data Catalog come voce di dati, tag e modelli di tag e altri tipi di metadati. Consulta la sezione Che cos'è Data Catalog?

Per avviare una query di ricerca di Data Catalog nella console Google Cloud, vai alla pagina Ricerca di Data Catalog e seleziona Data Catalog come modalità di ricerca.

Vai alla Ricerca

Nella sua forma più semplice, una query di ricerca di Data Catalog comprende un singolo predicato. Un predicato di questo tipo può corrispondere a diversi metadati:

  • Una sottostringa di un nome, un nome visualizzato o una descrizione di un asset di dati
  • Tipo esatto di un asset di dati
  • Una sottostringa del nome di una colonna (o del nome di una colonna nidificata) nello schema di un asset di dati
  • Una sottostringa di un ID progetto
  • Il valore di un tag pubblico, il nome di un modello di tag pubblico o il nome di un campo in un modello di tag pubblico associato a una voce di dati.
  • (Anteprima) Una stringa per un indirizzo email o il nome di un gestore dati
  • (Anteprima) Una stringa da una descrizione panoramica

La ricerca semplice non supporta i campi dei modelli di tag di tipo datetime.

Ad esempio, il predicato foo corrisponde alle seguenti entità:

  • Asset di dati con il nome foo.bar
  • Asset di dati con nome visualizzato Foo Bar
  • Asset di dati con descrizione This is the foo script.
  • Asset di dati del tipo esatto foo
  • Colonna foo_bar nello schema di un asset di dati
  • Colonna foo_bar nidificata nello schema di un asset di dati
  • Progetto prod-foo-bar
  • Modello di tag pubblico denominato foo, voci di dati codificate con il modello di tag foo, nome visualizzato del modello di tag foo, nome del campo modello di tag foo e valore del campo tag foo in una stringa, enum o RTF.
  • (Anteprima) Asset di dati con un gestore dati chiamato foo.
  • (Anteprima) Asset di dati con una panoramica contenente la parola foo.

Per saperne di più sui ruoli e sulle autorizzazioni per visualizzare i tag pubblici e privati, vedi Ruoli per visualizzare i tag pubblici e privati.

Predicati qualificati

Puoi qualificare un predicato aggiungendo un prefisso a una chiave che limita la corrispondenza a una parte specifica di metadati.

Il segno di uguale (=) limita la ricerca a una corrispondenza esatta.

I due punti (:) dopo la chiave associa il predicato a una sottostringa o a un token all'interno del valore nei risultati di ricerca.

La tokenizzazione suddivide il flusso di testo in una serie di token, dove ciascun token corrisponde solitamente a una singola parola.

Ad esempio:

  • name:foo seleziona le entità i cui nomi contengono la sottostringa foo: foo1 e barfoo.
  • description:foo seleziona le entità con il token foo nella descrizione: bar and foo.
  • location=foo associa tutti gli asset di dati in una località specificata con foo come nome della località.

Data Catalog supporta i seguenti qualificatori:

Qualificatore Descrizione
name:x Corrisponde a x come sottostringa dell'ID risorsa di dati.
displayname:x Trova x come sottostringa del nome visualizzato dell'asset di dati.
column:x Corrisponde a x come una sottostringa del nome della colonna (o del nome della colonna nidificata) nello schema dell'asset di dati.
Puoi cercare una colonna nidificata in base al relativo percorso utilizzando l'operatore logico AND.
Ad esempio, column:(foo bar) corrisponde a una colonna nidificata con il percorso foo.bar.
description:x Corrisponde a x come token nella descrizione dell'asset di dati.
label:bar Corrisponde agli asset di dati BigQuery che hanno un'etichetta (con un certo valore) e la chiave di etichetta ha bar come sottostringa.
label=bar Corrisponde agli asset di dati BigQuery che hanno un'etichetta (con un certo valore) e la chiave di etichetta è uguale a bar come stringa.
label:bar:x Corrisponde a x come una sottostringa nel valore di un'etichetta con chiave bar associata a un asset di dati BigQuery.
label=foo:bar Corrisponde agli asset di dati BigQuery dove la chiave è uguale a foo e la coppia chiave-valore è uguale a bar.
label.foo=bar Corrisponde agli asset di dati BigQuery dove la chiave è uguale a foo e la coppia chiave-valore è uguale a bar.
label.foo Corrisponde agli asset di dati BigQuery che hanno un'etichetta la cui chiave equivale a foo come stringa.
type=<type> Corrisponde agli asset di dati di un tipo o sottotipo di oggetto specifico. I sottotipi possono essere aggiunti con il formato <type>.<sub-type>.
I tipi e i sottotipi includono:
  • type=table corrisponde a tutte le tabelle.
  • type=dataset corrisponde a tutti i set di dati.
  • type=table.view o type=view corrisponde a tutte le viste.
  • type=lake corrisponde a tutti i lake.
  • type=zone corrisponde a tutte le zone.
  • type=tag_template corrisponde a tutti i modelli di tag.
  • type=entry_group corrisponde a tutti i gruppi di voci.
  • type=data_stream corrisponde a tutti gli argomenti Pub/Sub.
  • (Anteprima) type=dataset.linked corrisponde a tutti i set di dati collegati ad Analytics Hub.
projectid:bar Corrisponde agli asset di dati all'interno dei progetti Cloud che corrispondono a bar come sottostringa nell'ID.
parent:x Corrisponde a x come una sottostringa del percorso gerarchico di un asset di dati BigQuery. Il percorso è nel formato <project_id>.<dataset_name>.
Ad esempio, parent:foo.bar associa tutte le tabelle e le visualizzazioni di un set di dati con il percorso project-foo.bar-dataset.
orgid=number Abbina gli asset di dati all'interno di un'organizzazione Cloud con il valore ID esatto di number.
system=<system> Corrisponde a tutti gli asset di dati di un sistema specificato.
I sistemi includono:
  • system=bigquery associa tutti gli asset di dati di BigQuery.
  • system=cloud_bigtable corrisponde a tutti gli asset di dati di Bigtable.
  • system=cloud_pubsub corrisponde a tutti gli asset di dati di Pub/Sub.
  • system=cloud_spanner corrisponde a tutti gli asset di dati di Spanner.
  • system=dataproc_metastore corrisponde a tutti gli asset di dati di Dataproc Metastore.
  • system=data_catalog corrisponde a tutti gli asset di dati creati in Data Catalog.
  • system=dataplex corrisponde a tutti gli asset di dati creati in Dataplex.
location=<location> Corrisponde a tutti gli asset di dati in una località specificata con un nome esatto. Ad esempio, location=us-central1 corrisponde a tutti gli asset ospitati in Iowa.
Per un elenco completo delle località supportate, consulta Regioni di Data Catalog.
cluster_location=<location> Corrisponde a tutti gli asset di dati Bigtable in una località specificata con un nome esatto.
Ad esempio, cluster_location=us-central1 corrisponde a tutti gli asset ospitati in Iowa.
Per un elenco completo delle località supportate, consulta Regioni di Bigtable.
tag:x Corrisponde agli asset di dati in cui x corrisponde a qualsiasi sottostringa in <tag_template_project_id>.<tag_template_id>.<tag_field_id> di un tag privato o pubblico.
Esempi:
  • tag:data_owner corrisponde agli asset di dati che contengono il tag data_owner.
  • tag:data_gov_template corrisponde agli asset di dati taggati con il modello di tag data_gov_template.
  • tag:mycloudproject.data_gov_template corrisponde agli asset di dati taggati con il modello data_gov_template nel progetto mycloudproject.
tag:key<operator>val Innanzitutto, associa key a qualsiasi sottostringa dell'ID campo del tag, dell'ID modello di tag o dell'ID progetto Google Cloud di un modello di tag. Successivamente, associa val al valore del tag key a seconda del tipo di campo tag.
Gli insiemi di <operator> dipendenti dal tipo consentiti per i valori del tag sono:
  • string/richtext: ":"
    Nota: i due punti in questa stringa di ricerca indicano una corrispondenza esatta del token, non una sottostringa.
  • boolean ed boolean: "="
  • double: "=", "<", ">", "<=", ">="
  • timestamp: ":", "=", "<", ">", "<=", ">="
Esempi:
  • string: tag:data_owner:@mail.com corrisponde agli asset di dati che hanno valori @mail.com.
  • boolean: tag:data_gov_template.hasPII=true corrisponde ai tag booleani hasPII in data_gov_template che sono true.
  • enum: tag:certification_level_1=HIGHEST.
  • double: tag:datascore=9 abbina gli asset di dati con datascore tag doppi che hanno il valore 9.
  • timestamp: tag:expiredDate:2019-01-01 corrisponde agli asset di dati che hanno un tag expiredDate di 2019-01-01.
  • timestamp: tag:expiredDate<2019-02 corrisponde agli asset di dati provvisti di un tag expiredDate prima del giorno 2019-02-01T00:00:00.
createtime Trova gli asset di dati creati entro, prima o dopo una determinata data o ora.
Esempi:
  • createtime:2019-01-01 corrisponde agli asset di dati creati in data 2019-01-01.
  • createtime<2019-02 corrisponde agli asset di dati creati prima del giorno 2019-02-01T00:00:00.
  • createtime>2019-02 corrisponde agli asset di dati creati dopo il giorno 2019-02-01T00:00:00.
updatetime Trova gli asset di dati che sono stati aggiornati entro, prima o dopo una determinata data o ora.
Esempi:
  • updatetime:2019-01-01 corrisponde agli asset di dati aggiornati il giorno 2019-01-01.
  • updatetime<2019-02 corrisponde agli asset di dati aggiornati prima del giorno 2019-02-01T00:00:00.
  • updatetime>2019-02 corrisponde agli asset di dati aggiornati dopo il giorno 2019-02-01T00:00:00.
policytag:x Trova x come una sottostringa del nome visualizzato del tag criterio. Trova tutti gli asset utilizzando il tag di criteri corrispondente o i relativi discendenti.
policytagid=x Corrisponde a x come ID tag criterio o tassonomia. Trova tutti gli asset utilizzando il tag di criteri corrispondente o i relativi discendenti.
term:x Corrisponde agli asset di dati collegati a un termine del glossario aziendale in cui una sottostringa di nome, descrizione o gestore dati corrisponde a x.
fully_qualified_name:x Corrisponde a x come una sottostringa di fully_qualified_name.
fully_qualified_name=x Corrisponde a x come fully_qualified_name.

Operatori logici

Una query può essere composta da più predicati con operatori logici. Se non specifichi un operatore, è implicito AND logico. Ad esempio, foo bar restituisce entità che corrispondono sia al predicato foo sia al predicato bar.

Sono supportati gli operatori logici AND e gli operatori logici, ad esempio foo OR bar.

Puoi negare un predicato con un prefisso - o NOT. Ad esempio, -name:foo restituisce tutte le entità con nomi che non corrispondono al predicato foo.

Sintassi abbreviata

È disponibile anche una sintassi di ricerca abbreviata, che utilizza | per gli operatori OR e , per gli operatori AND.

Ad esempio, per cercare voci all'interno di uno dei numerosi progetti utilizzando l'operatore OR, puoi utilizzare:

projectid:(pid1|pid2|pid3|pid4)

Invece di:

projectid:pid1 OR projectid:pid2 OR projectid:pid3 OR projectid:pid4

Per cercare voci con nomi di colonna corrispondenti:

  • E: column:(name1, name2, name3)
  • OPPURE: column:(name1|name2|name3)

Questa sintassi abbreviata funziona per i predicati idonei elencati in precedenza, ad eccezione di tag, term, policytag, policytagid e label.