Syntaxe de recherche dans Data�Catalog

Ce document d�crit la syntaxe des requ�tes de recherche dans Data�Catalog. Avant de lire ce document, il est important que vous compreniez les concepts de Data�Catalog, tels que la saisie de donn�es, les balises et les mod�les de balises, ainsi que d'autres types de m�tadonn�es. Consultez la page Qu'est-ce que Data�Catalog ?

Pour lancer une requ�te de recherche Data�Catalog dans le console Google Cloud, acc�dez � la page de recherche de Data�Catalog, puis S�lectionnez le mode de recherche Data�Catalog.

Acc�der � la recherche

Dans sa forme la plus simple, une requ�te de recherche Data�Catalog comprend un seul pr�dicat. Ce pr�dicat peut correspondre � plusieurs m�tadonn�es�:

  • Sous-cha�ne contenant le nom, le nom � afficher ou la description d'un �l�ment de donn�es
  • Type exact d'un �l�ment de donn�es
  • Sous-cha�ne d'un nom de colonne (ou de colonne imbriqu�e) dans le sch�ma d'un �l�ment de donn�es
  • Sous-cha�ne d'un ID de projet
  • La valeur d'un tag public, le nom d'un mod�le de tag public ou dans un mod�le de tag public joint � une entr�e de donn�es.
  • (Aper�u) Cha�ne correspondant � l'adresse e-mail ou au nom d'un responsable des donn�es
  • (Aper�u) Cha�ne provenant d'une description de pr�sentation

La recherche simple n'est pas compatible avec les champs de mod�le de balise de type datetime.

Par exemple, le pr�dicat foo correspond aux entit�s suivantes�:

  • �l�ment de donn�es avec le nom foo.bar
  • �l�ment de donn�es avec le nom � afficher Foo Bar
  • �l�ment de donn�es avec la description This is the foo script.
  • �l�ment de donn�es avec le type foo exact
  • Colonne foo_bar dans le sch�ma d'un �l�ment de donn�es
  • Colonne imbriqu�e foo_bar dans le sch�ma d'un �l�ment de donn�es
  • Projet prod-foo-bar
  • Mod�le de tag public nomm� foo, entr�es de donn�es marqu�es avec le mod�le de tag foo, nom � afficher de mod�le de tag foo, nom de champ de mod�le de tag foo et valeur de champ de tag foo dans une cha�ne, une �num�ration ou du texte enrichi.
  • (Aper�u) �l�ment de donn�es avec un responsable des donn�es appel� foo.
  • (Aper�u) �l�ment de donn�es avec un aper�u contenant le mot foo.

Pour en savoir plus sur les r�les et les autorisations permettant d'afficher les balises publiques et priv�es, consultez la section R�les permettant d'afficher les balises publiques et priv�es.

Pr�dicats qualifi�s

Vous pouvez qualifier un pr�dicat en le pr�fixant avec une cl� qui limite la correspondance � une m�tadonn�e sp�cifique.

Le signe �gal (=) limite la recherche � une correspondance exacte.

Le signe deux-points (:) apr�s la cl� correspond au pr�dicat d'une sous-cha�ne ou d'un jeton compris dans la valeur des r�sultats de recherche.

La tokenisation divise le flux de texte en une s�rie de jetons, chaque jeton correspondant g�n�ralement � un seul mot.

Exemple�:

  • name:foo s�lectionne les entit�s dont le nom contient la sous-cha�ne foo�: foo1 et barfoo.
  • description:foo s�lectionne les entit�s ayant le jeton foo dans la description�: bar and foo.
  • location=foo renvoie tous les �l�ments de donn�es d'un emplacement sp�cifi� avec foo comme nom d'emplacement.

Data�Catalog accepte les qualificatifs suivants�:

Qualificatif Description
name:x Renvoie x en tant que sous-cha�ne de l'ID de l'�l�ment de donn�es.
displayname:x Renvoie x en tant que sous-cha�ne du nom d'affichage de l'�l�ment de donn�es.
column:x Correspond � x en tant que sous-cha�ne du nom de la colonne (ou du nom de la colonne imbriqu�e) dans le sch�ma de l'�l�ment de donn�es.
Vous pouvez rechercher une colonne imbriqu�e par son chemin � l'aide de l'op�rateur logique AND.
Par exemple, column:(foo bar) correspond � une colonne imbriqu�e avec le chemin foo.bar.
description:x Renvoie x en tant que jeton dans la description de l'�l�ment de donn�es.
label:bar Renvoie les �l�ments de donn�es BigQuery comportant une �tiquette (avec une certaine valeur) et dont la cl� d'�tiquette est bar en tant que sous-cha�ne.
label=bar Correspond aux �l�ments de donn�es BigQuery qui ont un libell� (comportant une valeur) et dont la cl� de libell� est �gale � bar en tant que cha�ne.
label:bar:x Correspond � x en tant que sous-cha�ne dans la valeur d'une �tiquette associ�e � la cl� bar et � un �l�ment de donn�es BigQuery.
label=foo:bar Correspond aux �l�ments de donn�es BigQuery dont la cl� est foo et la valeur de cl� bar.
label.foo=bar Correspond aux �l�ments de donn�es BigQuery dont la cl� est foo et la valeur de cl� bar.
label.foo Renvoie les �l�ments de donn�es BigQuery comportant une �tiquette dont la cl� est foo en tant que cha�ne.
type=<type> Renvoie les �l�ments de donn�es d'un type ou sous-type d'objet sp�cifique. Les sous-types peuvent �tre ajout�s au format <type>.<sub-type>.
Les types et sous-types incluent�:
  • type=table correspond � toutes les tables, vues et vues mat�rialis�es.
  • type=dataset renvoie tous les ensembles de donn�es.
  • type=table.view ou type=view correspond � toutes les vues, mais pas aux vues mat�rialis�es.
  • type=materialized_view correspond � toutes les vues mat�rialis�es.
  • type=lake renvoie tous les lacs.
  • type=zone correspond � toutes les zones.
  • type=tag_template renvoie tous les mod�les de tag.
  • type=entry_group renvoie tous les groupes d'entr�es.
  • type=data_stream renvoie tous les sujets Pub/Sub.
  • (Pr�visualisation) type=dataset.linked correspond � tous les ensembles de donn�es associ�s � Analytics�Hub.
projectid:bar Renvoie les �l�ments de donn�es dans les projets cloud qui correspondent � bar en tant que sous-cha�ne dans l'ID.
parent:x Correspond � x en tant que sous-cha�ne du chemin d'acc�s hi�rarchique d'un �l�ment de donn�es BigQuery. Le chemin d'acc�s est au format <project_id>.<dataset_name>.
Par exemple, parent:foo.bar correspond � toutes les tables et vues d'un ensemble de donn�es avec le chemin d'acc�s project-foo.bar-dataset.
orgid=number Fait correspondre les �l�ments de donn�es d'une organisation Cloud avec la valeur d'ID exacte number.
system=<system> Renvoie tous les �l�ments de donn�es d'un syst�me sp�cifi�.
Les syst�mes incluent�:
  • system=bigquery renvoie tous les �l�ments de donn�es de BigQuery.
  • system=cloud_bigtable �tablit une correspondance avec tous les �l�ments de donn�es de Bigtable.
  • system=cloud_pubsub renvoie tous les �l�ments de donn�es de Pub/Sub.
  • system=cloud_spanner correspond � tous les �l�ments de donn�es de Spanner.
  • system=dataproc_metastore renvoie tous les �l�ments de donn�es de Dataproc�Metastore.
  • system=data_catalog renvoie tous les �l�ments de donn�es cr��s dans Data�Catalog.
  • system=dataplex renvoie tous les �l�ments de donn�es cr��s dans Dataplex.
location=<location> Fait correspondre tous les �l�ments de donn�es d'un emplacement sp�cifi� avec un nom exact. Par exemple, location=us-central1 correspond � tous les �l�ments h�berg�s dans l'Iowa.
Pour obtenir la liste compl�te des emplacements accept�s, consultez la page R�gions de Data�Catalog.
cluster_location=<location> Fait correspondre tous les �l�ments de donn�es Bigtable d'un emplacement sp�cifi� avec un nom exact.
Par exemple, cluster_location=us-central1 correspond � tous les �l�ments h�berg�s dans l'Iowa.
Pour obtenir la liste compl�te des emplacements accept�s, consultez la page R�gions Bigtable.
tag:x Renvoie les �l�ments de donn�es o� x correspond � une sous-cha�ne dans <tag_template_project_id>.<tag_template_id>.<tag_field_id> d'une balise priv�e ou publique.
Exemples�:
  • tag:data_owner renvoie les �l�ments de donn�es associ�s au tag data_owner.
  • tag:data_gov_template renvoie les �l�ments de donn�es auxquels des tags ont �t� ajout�s � l'aide du mod�le de tag data_gov_template.
  • tag:mycloudproject.data_gov_template renvoie les �l�ments de donn�es auxquels des tags ont �t� ajout�s � l'aide du mod�le data_gov_template dans le projet mycloudproject.
tag:key<operator>val Tout d'abord, �tablit une correspondance entre key et n'importe quelle sous-cha�ne de l'ID du champ de tag, de l'ID du mod�le de tag ou de l'ID de projet Google Cloud d'un mod�le de tag. Ensuite, fait correspondre val � la valeur de tag de key en fonction du type du champ de tag.
Les ensembles <operator> d�pendant du type autoris�s pour les valeurs de tag sont les suivants�:
  • string/richtext: ":"
    Remarque: Dans cette recherche de cha�ne, le signe deux-points d�signe une correspondance de jeton exacte, et non une sous-cha�ne.
  • boolean (bool�en) et enum (�num�r�)�: "="
  • double�: "=", "<", ">", "<=", ">="
  • timestamp�: ":", "=", "<", ">", "<=", ">="
Exemples�:
  • string�: tag:data_owner:@mail.com renvoie les �l�ments de donn�es qui ont des valeurs @mail.com.
  • boolean�: tag:data_gov_template.hasPII=true renvoie les tags bool�ens hasPII dans le mod�le data_gov_template qui sont d�finis sur true.
  • enum�: tag:certification_level_1=HIGHEST.
  • double�: tag:datascore=9 renvoie les �l�ments de donn�es avec des doubles tags datascore associ�s � la valeur 9.
  • timestamp�: tag:expiredDate:2019-01-01 renvoie les �l�ments de donn�es associ�s au tag expiredDate d�fini sur 2019-01-01.
  • timestamp�: tag:expiredDate<2019-02 renvoie les �l�ments de donn�es associ�s � un tag expiredDate ant�rieur � 2019-02-01T00:00:00.
createtime Recherche les �l�ments de donn�es qui ont �t� cr��s pendant, avant ou apr�s une date ou une heure donn�e.
Exemples�:
  • createtime:2019-01-01 renvoie les �l�ments de donn�es cr��s le 2019-01-01.
  • createtime<2019-02 renvoie les �l�ments de donn�es cr��s avant le 2019-02-01T00:00:00.
  • createtime>2019-02 renvoie les �l�ments de donn�es cr��s apr�s le 2019-02-01T00:00:00.
updatetime Recherche les �l�ments de donn�es qui ont �t� mis � jour pendant, avant ou apr�s une date ou une heure donn�e.
Exemples�:
  • updatetime:2019-01-01 renvoie les �l�ments de donn�es mis � jour le 2019-01-01.
  • updatetime<2019-02 renvoie les �l�ments de donn�es mis � jour avant le 2019-02-01T00:00:00.
  • updatetime>2019-02 renvoie les �l�ments de donn�es mis � jour apr�s le 2019-02-01T00:00:00.
policytag:x Renvoie x en tant que sous-cha�ne du nom � afficher du tag avec strat�gie. Recherche tous les �l�ments en utilisant le tag avec strat�gie correspondant ou ses descendants.
policytagid=x Correspond � x en tant qu'ID de tag avec strat�gie ou classification. Recherche tous les �l�ments en utilisant le tag avec strat�gie correspondant ou ses descendants.
term:x Correspond aux �l�ments de donn�es associ�s � un terme de glossaire m�tier o� une sous-cha�ne du nom, de la description ou du responsable des donn�es correspond � x.
fully_qualified_name:x Renvoie x en tant que sous-cha�ne de fully_qualified_name.
fully_qualified_name=x Correspond � x et � fully_qualified_name.

Op�rateurs logiques

Une requ�te peut �tre compos�e de plusieurs pr�dicats contenant des op�rateurs logiques. Si vous ne sp�cifiez pas d'op�rateur, l'op�rateur logique AND est implicite. Par exemple, foo bar renvoie les entit�s qui correspondent � la fois au pr�dicat foo et au pr�dicat bar.

Les op�rateurs logique AND et OR logique sont accept�s (par exemple, foo OR bar).

Vous pouvez annuler un pr�dicat avec un pr�fixe - ou NOT. Par exemple, -name:foo renvoie Toutes les entit�s dont le nom ne correspond pas au pr�dicat foo

Syntaxe abr�g�e

Une syntaxe de recherche abr�g�e est �galement disponible, en utilisant | pour les op�rateurs OR et , pour les op�rateurs AND.

Par exemple, pour rechercher des entr�es dans l'un des nombreux projets � l'aide de l'op�rateur OR, vous pouvez utiliser�:

projectid:(pid1|pid2|pid3|pid4)

� la place de�:

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

Pour rechercher des entr�es avec des noms de colonne correspondants�:

  • ET�: column:(name1, name2, name3)
  • OU�: column:(name1|name2|name3)

Cette syntaxe abr�g�e fonctionne pour la valeur qualifi�e les pr�dicats list�s pr�c�demment, � l'exception de tag, term, policytag, policytagid et label.