Syntaxe de recherche pour Dataplex Catalog

Ce document décrit la syntaxe des requêtes de recherche Dataplex. Avant de lire ce document, il est important que vous compreniez les concepts du catalogue Dataplex, 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 la page Présentation de Dataplex Catalog.

Pour lancer une requête de recherche Dataplex Catalog dans la console Google Cloud, accédez à la page Recherche de Dataplex et sélectionnez Dataplex Catalog comme mode de recherche.

Accéder à la recherche

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

Dans sa forme la plus simple, une requête de recherche dans le catalogue Dataplex se compose d'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'une ressource
  • Une sous-chaîne du type d'une ressource
  • Sous-chaîne d'un nom de colonne (ou de colonne imbriquée) dans le schéma d'une ressource
  • Sous-chaîne d'un ID de projet
  • Chaîne issue d'une description générale

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

  • Ressource portant le nom foo.bar
  • Ressource avec le nom à afficher Foo Bar
  • Ressource avec la description This is the foo script
  • Ressource avec le type exact foo
  • Colonne foo_bar dans le schéma d'une ressource
  • Colonne imbriquée foo_bar dans le schéma d'une ressource
  • Projet prod-foo-bar
  • Ressource avec un aperçu contenant le mot foo

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, comme foo1 et barfoo.
  • description:foo sélectionne les entités ayant le jeton foo dans la description, comme bar et foo.
  • location=foo fait correspondre les ressources d'un emplacement spécifié avec foo comme nom de l'emplacement.

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

Dataplex Catalog accepte les qualificatifs suivants:

Qualificatif Description
name:x Correspond à x en tant que sous-chaîne de l'ID 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 la colonne (ou du nom de la 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 Correspond aux 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 bar en tant que chaîne.
label:bar:x Correspond à 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 Correspond aux ressources BigQuery dont la clé est égale à foo et la valeur de clé est égale à bar.
label.foo=bar Correspond aux ressources BigQuery dont la clé est égale à foo et la valeur de clé est égale à bar.
label.foo Correspond aux ressources BigQuery comportant un libellé dont la clé est foo en tant que 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 des projets Google 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'une ressource. Le chemin d'accès parent est un fully_qualified_name de la ressource parente.
orgid=number Fait correspondre les ressources d'une Google Cloud organisation avec la valeur d'ID exacte number.
system=SYSTEM Correspond aux 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 éléments hébergés dans l'Iowa.

Les composants BigQuery Omni acceptent ce qualificatif à l'aide du nom de l'emplacement BigQuery Omni. Par exemple, location=aws-us-east-1 correspond aux éléments BigQuery Omni situés en Virginie du Nord.

createtime

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

Exemple :

  • createtime:2019-01-01 renvoie les ressources créées le 01/01/2019.
  • createtime<2019-02 recherche les ressources créées avant le 2019-02-01T00:00:00.
  • createtime>2019-02 renvoie les ressources créées après le 01/02/2019 00:00:00.

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

Tous les horodatages doivent être à l'heure GMT. Les fuseaux horaires ne sont pas acceptés. Les horodatages partiels, les séparateurs de date avec trait d'union (-) et les séparateurs de date avec 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 01/01/2019.
  • updatetime<2019-02 recherche les ressources mises à jour avant le 01/02/2019 00:00:00.
  • updatetime>2019-02 renvoie les ressources mises à jour après le 2019-02-01T00:00:00.

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

Tous les horodatages doivent être à l'heure GMT. Les fuseaux horaires ne sont pas acceptés. Les horodatages partiels, les séparateurs de date avec trait d'union (-) et les séparateurs de date avec 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 Correspond à x en tant que fully_qualified_name.

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

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 du champ "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: comme pour les nombres, mais les valeurs à comparer sont traitées comme des dates/heures au lieu de nombres.
  • Booléen: =

Seuls les champs de niveau supérieur de l'aspect sont disponibles pour la recherche.

Par exemple, toutes les requêtes suivantes correspondent aux entrées dont 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

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 logiques AND et OR sont acceptés. Par exemple, foo OR bar.

Vous pouvez annuler un prédicat avec les préfixes - (trait d'union) ou NOT. Par exemple, -name:foo renvoie les entités dont le nom ne correspond pas au prédicat foo.

Les opérateurs logiques ne sont pas sensibles à la casse. Par exemple, or et OR sont tous deux acceptables.

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

Étape suivante