Syntaxe de recherche pour Dataplex Universal Catalog

Ce document décrit la syntaxe des requêtes de recherche dans Dataplex Universal Catalog. Avant de lire ce document, il est important de comprendre les concepts de gestion des métadonnées dans Dataplex Universal Catalog, tels que les entrées, les aspects, les types d'aspects, les groupes d'entrées et les types d'entrées. Pour en savoir plus, consultez À propos de la gestion des métadonnées dans Dataplex Universal Catalog.

Dataplex Universal Catalog propose deux modes de recherche : la recherche par mots clés et la recherche en langage naturel (preview).

La recherche par mots clés vous permet de trouver des ressources à l'aide de mots clés spécifiques, de filtres et d'une syntaxe définie.

La recherche en langage naturel étend la recherche par mots clés pour prendre en charge les requêtes en langage naturel. Elle vous permet de trouver des ressources en utilisant le langage courant, sans avoir besoin d'une syntaxe complexe.

Ce document décrit la syntaxe pour la recherche par mots clés et en langage naturel.

Pour lancer une requête de recherche Dataplex Universal Catalog dans la consoleGoogle Cloud , accédez à la page Rechercher de Dataplex Universal Catalog et sélectionnez Dataplex Universal Catalog comme plate-forme de recherche.

Accéder à la recherche

Pour en savoir plus, consultez Rechercher des ressources dans Dataplex Universal Catalog.

Recherche en texte libre

Vous pouvez trouver des composants en saisissant un terme ou une expression sans syntaxe spécifique. Dataplex Universal Catalog effectue une recherche étendue en comparant votre requête à plusieurs champs de métadonnées, y compris les suivants :

  • Nom, nom à afficher ou description d'une ressource
  • Type de ressource
  • ID du projet
  • Description de la vue d'ensemble
  • Nom de colonne (ou de colonne imbriquée) dans le schéma d'une ressource
  • Description de la colonne
  • Nom complet
  • Contacts
  • Aspects

Rechercher avec la syntaxe des requêtes

Pour des recherches plus précises, vous pouvez créer une requête à l'aide d'une syntaxe spécifique, y compris des qualificatifs, des opérateurs logiques et des recherches par aspect.

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 ressources dont le nom contient la sous-chaîne foo, comme foo1 et barfoo.
  • description:foo sélectionne les ressources ayant le jeton foo dans la description, comme bar et foo.
  • location=foo établit une correspondance avec les ressources d'un emplacement spécifié dont le nom est foo.

Le comportement de ces qualificatifs peut varier légèrement selon les modes de recherche, comme indiqué dans les sections suivantes.

Les clés de prédicat type, system, location et orgid n'acceptent que le qualificatif de correspondance exacte (=), et non celui de sous-chaîne (:). Par exemple, type=foo ou orgid=number.

Dataplex Universal Catalog accepte les qualificatifs suivants pour la recherche par mots clés :

Qualificatif Description
name:x Renvoie x en tant que sous-chaîne de l'ID de ressource.
displayname:x Renvoie x en tant que sous-chaîne du nom à afficher de la ressource.
column:x Correspond à x en tant que sous-chaîne du nom de colonne (ou du nom de colonne imbriquée) dans le schéma de la ressource.
description:x Renvoie x en tant que jeton dans la description de la ressource.
label:bar Renvoie les ressources BigQuery comportant une étiquette (avec une certaine valeur) et dont la clé d'étiquette est bar en tant que sous-chaîne.
label=bar Renvoie les ressources BigQuery comportant une étiquette (avec une certaine valeur) et dont la clé d'étiquette est égale à bar en tant que chaîne.
label:bar:x Renvoie x en tant que sous-chaîne dans la valeur d'une étiquette avec la clé bar associée à une ressource BigQuery.
label=foo:bar Renvoie les ressources BigQuery dont la clé est égale à foo et la valeur de la clé est égale à bar.
label.foo=bar Renvoie les ressources BigQuery dont la clé est égale à foo et la valeur de la clé est égale à bar.
label.foo Correspond aux ressources BigQuery comportant un libellé dont la clé est égale à foo sous forme de chaîne.
type=TYPE Correspond aux ressources d'un type d'entrée spécifique ou de son alias de type.
projectid:bar Renvoie les ressources dans les projets Google Cloud qui correspondent àbaren 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'une ressource. Le chemin parent est un fully_qualified_name de la ressource parente.
orgid=number Fait correspondre les ressources d'une organisation Google Cloud avec la valeur d'ID exacte number.
system=SYSTEM Renvoie les ressources d'un système spécifié.
location=LOCATION

Fait correspondre les ressources d'un emplacement spécifié avec un nom exact. Par exemple, location=us-central1 correspond aux composants hébergés dans l'Iowa.

Les composants BigQuery Omni sont compatibles avec ce qualificatif en utilisant le nom de l'emplacement BigQuery Omni. Par exemple, location=aws-us-east-1 correspond aux composants BigQuery Omni en Virginie du Nord.

createtime

Recherche les ressources qui ont été créées pendant, avant ou après une date ou une heure donnée.

Exemple :

  • createtime:2019-01-01 correspond aux ressources créées le 1er janvier 2019.
  • createtime<2019-02 correspond aux ressources créées avant le 2019-02-01T00:00:00.
  • createtime>2019-02 correspond aux ressources créées après le 01/02/2019 à 00:00:00.

Format du code temporel : YYYY-MM-DDThh:mm:ss

Tous les horodatages doivent être à l'heure GMT (les fuseaux horaires ne sont pas acceptés). Les codes temporels partiels et les séparateurs de date (tiret - et barre oblique /) sont acceptés.

Exemple :

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
updatetime

Recherche les ressources qui ont été mises à jour pendant, avant ou après une date ou une heure donnée.

Exemple :

  • updatetime:2019-01-01 correspond aux ressources mises à jour le 1er janvier 2019.
  • updatetime<2019-02 correspond aux ressources mises à jour avant le 2019-02-01T00:00:00.
  • updatetime>2019-02 correspond aux ressources mises à jour après le 01/02/2019 à 00:00:00.

Format du code temporel : YYYY-MM-DDThh:mm:ss

Tous les horodatages doivent être à l'heure GMT (les fuseaux horaires ne sont pas acceptés). Les codes temporels partiels et les séparateurs de date (tiret - et barre oblique /) sont acceptés.

Exemple :

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
fully_qualified_name:x Renvoie x en tant que sous-chaîne de fully_qualified_name.
fully_qualified_name=x Correspondances x en tant que fully_qualified_name.

Les clés de prédicat type, system, location et description, ainsi que la recherche par aspect (à l'exclusion de has) n'acceptent que le qualificatif de correspondance exacte (=), et non le qualificatif de sous-chaîne (:). Par exemple, type=foo.

Dataplex Universal Catalog est compatible avec les qualificatifs suivants pour la recherche en langage naturel :

Qualificatif Description
name:x Renvoie x en tant que sous-chaîne de l'ID ou du nom à afficher de la ressource.
displayname:x Renvoie x en tant que sous-chaîne du nom à afficher de la ressource.
column:x Correspond à x en tant que sous-chaîne du nom de colonne (ou du nom de colonne imbriquée) dans le schéma de la ressource.
description:x Renvoie x en tant que jeton dans la description de la ressource.
labels:bar Renvoie les ressources BigQuery comportant une étiquette (avec une certaine valeur) et dont la clé d'étiquette est bar en tant que sous-chaîne.
labels=bar Renvoie les ressources BigQuery comportant une étiquette (avec une certaine valeur) et dont la clé d'étiquette est égale à bar en tant que chaîne.
labels.bar:x Renvoie x en tant que sous-chaîne dans la valeur d'une étiquette avec la clé bar associée à une ressource BigQuery.
labels.foo=bar Renvoie les ressources BigQuery dont la clé est égale à foo et la valeur de la clé est égale à bar.
type=TYPE Correspond aux ressources d'un type d'entrée spécifique ou de son alias de type.
projectid:bar Renvoie les ressources dans les projets Google Cloud qui correspondent àbaren 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'une ressource.
system=SYSTEM Renvoie les ressources d'un système spécifié.
location=LOCATION

Fait correspondre les ressources d'un emplacement spécifié avec un nom exact. Par exemple, location=us-central1 correspond aux composants hébergés dans l'Iowa.

Les composants BigQuery Omni sont compatibles avec ce qualificatif en utilisant le nom de l'emplacement BigQuery Omni. Par exemple, location=aws-us-east-1 correspond aux composants BigQuery Omni en Virginie du Nord.

createtime

Recherche les ressources qui ont été créées pendant, avant ou après une date ou une heure donnée.

Exemple :

  • createtime:2019-01-01 correspond à toutes les ressources créées le 1er janvier 2019.
  • createtime<2019-02 correspond à toutes les ressources créées avant le 1er février 2019 à 00h00.
  • createtime>2019-02 correspond à toutes les ressources créées après le 01/02/2019 à 00:00:00.
  • createtime>-30d correspond à toutes les ressources créées au cours des 30 derniers jours.
  • createtime<=-30d correspond à toutes les ressources créées il y a 30 jours ou plus.
  • createtime<=-1d correspond à toutes les ressources créées la veille.

Format du code temporel : YYYY-MM-DDThh:mm:ss

Tous les horodatages doivent être à l'heure GMT (les fuseaux horaires ne sont pas acceptés). Les codes temporels partiels et les séparateurs de date (tiret - et barre oblique /) sont acceptés.

Exemple :

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
updatetime

Recherche les ressources qui ont été mises à jour pendant, avant ou après une date ou une heure donnée.

Exemple :

  • updatetime:2019-01-01 correspond à toutes les ressources mises à jour le 1er janvier 2019.
  • updatetime<2019-02 correspond à toutes les ressources mises à jour avant le 1er février 2019 à 00:00:00.
  • updatetime>2019-02 correspond à toutes les ressources mises à jour après le 1er février 2019 à 00h00.
  • updatetime>-30d correspond à toutes les ressources mises à jour au cours des 30 derniers jours.
  • updatetime<-30d correspond à toutes les ressources mises à jour il y a 30 jours ou plus.
  • updatetime=-1d correspond à toutes les ressources mises à jour la veille.
  • updatetime>=-30d correspond à toutes les ressources mises à jour au cours des 30 derniers jours.
  • updatetime<=-30d correspond à toutes les ressources mises à jour il y a 30 jours ou plus.

Format du code temporel : YYYY-MM-DDThh:mm:ss

Tous les horodatages doivent être à l'heure GMT (les fuseaux horaires ne sont pas acceptés). Les codes temporels partiels et les séparateurs de date (tiret - et barre oblique /) sont acceptés.

Exemple :

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22

Pour rechercher des entrées en fonction de leurs aspects associés, utilisez la syntaxe de requête suivante.

Recherche par mots clés

Qualificatif Description
aspect:x Correspond à x en tant que sous-chaîne du chemin d'accès complet au type d'aspect d'un aspect associé à l'entrée, au format projectid.location.ASPECT_TYPE_ID
aspect=x Correspond à x en tant que chemin d'accès complet au type d'aspect d'un aspect associé à l'entrée, au format projectid.location.ASPECT_TYPE_ID
aspect:xOPERATORvalue

Recherche des valeurs de champ d'aspect. Correspond à x en tant que sous-chaîne du chemin d'accès complet au type d'aspect et au nom de champ d'un aspect associé à l'entrée, au format projectid.location.ASPECT_TYPE_ID.FIELD_NAME.

La liste des opérateurs acceptés dépend du type de champ dans l'aspect, comme suit :

  • Chaîne : = (correspondance exacte) et : (sous-chaîne)
  • Tous les types de nombres : =, :, <, >, <=, >=, =>, =<
  • Enum : =
  • Date/Heure : identique à la comparaison de nombres, mais les valeurs à comparer sont traitées comme des valeurs de date et heure au lieu de nombres.
  • Booléen : =

Seuls les champs de premier niveau de l'aspect peuvent faire l'objet d'une recherche.

Par exemple, toutes les requêtes suivantes correspondent aux entrées où la valeur du champ is-enrolled dans l'aspect employee-info est true. D'autres entrées correspondant à la sous-chaîne sont également renvoyées.

  • aspect:example-project.us-central1.employee-info.is-enrolled=true
  • aspect:example-project.us-central1.employee=true
  • aspect:employee=true

Recherche en langage naturel

Qualificatif Description
has:x Correspond à x en tant que sous-chaîne du chemin d'accès complet au type d'aspect d'un aspect associé à l'entrée, au format projectid.location.ASPECT_TYPE_ID
has=x Correspond à x en tant que chemin d'accès complet au type d'aspect d'un aspect associé à l'entrée, au format projectid.location.ASPECT_TYPE_ID
has:xOPERATORvalue

Recherche des valeurs de champ d'aspect. Correspond à x en tant que sous-chaîne du chemin d'accès complet au type d'aspect et au nom de champ d'un aspect associé à l'entrée, dans les formats suivants :

  • Syntaxe pour les types d'aspect système :

    • ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.LOCATION.ASPECT_TYPE_ID.FIELD_NAME

    Par exemple, les requêtes suivantes correspondent aux entrées où la valeur du champ type dans l'aspect bigquery-dataset est default :

    • bigquery-dataset.type=default
    • dataplex-types.bigquery-dataset.type=default
    • dataplex-types.global.bigquery-dataset.type=default

  • Syntaxe pour les types d'aspects personnalisés :

    • Si l'aspect est créé dans la région "global" : PROJECT_ID.ASPECT_TYPE_ID.FIELD_NAME
    • Si l'aspect est créé dans une région spécifique : PROJECT_ID.REGION.ASPECT_TYPE_ID.FIELD_NAME

    Par exemple, les requêtes suivantes correspondent aux entrées où la valeur du champ is-enrolled dans l'aspect employee-info est true.

    • example-project.us-central1.employee-info.is-enrolled=true
    • example-project.employee-info.is-enrolled=true

    La liste des opérateurs acceptés dépend du type de champ dans l'aspect, comme suit :

    • Chaîne : = (correspondance exacte)
    • Tous les types de nombres : =, :, <, >, <=, >=, =>, =<
    • Enum : =
    • Date/Heure : identique à la comparaison de nombres, mais les valeurs à comparer sont traitées comme des valeurs de date et heure au lieu de nombres.
    • Booléen : =

Seuls les champs de premier niveau de l'aspect peuvent faire l'objet d'une recherche.

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 ressources qui correspondent à la fois au prédicat foo et au prédicat bar.

Les opérateurs logiques AND et OR sont acceptés. Par exemple, foo OR bar.

Vous pouvez annuler un prédicat avec les préfixes - (tiret) ou NOT. Par exemple, -name:foo renvoie les ressources 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 | (barre verticale) pour les opérateurs OR et , (virgule) 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 la syntaxe abrégée suivante :

projectid:(id1|id2|id3|id4)

La même recherche sans utiliser la syntaxe abrégée se présente comme suit :

projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4

Pour rechercher des entrées avec des noms de colonne correspondants, utilisez la méthode suivante :

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

Cette syntaxe abrégée fonctionne pour les prédicats qualifiés, à l'exception de label dans la recherche par mot clé.

Étapes suivantes