Utilisez la recherche par mots clés uniquement dans Knowledge Catalog pour trouver des ressources à l'aide de mots clés et de filtres spécifiques, ainsi que d'une syntaxe définie. La recherche par mots clés uniquement vous permet de contrôler précisément vos requêtes de recherche et d'affiner les résultats en fonction des champs de métadonnées.
Avant de commencer
Avant d'effectuer une recherche, assurez-vous de disposer des rôles requis et d'avoir activé l'API nécessaire.
Rôles requis
Pour obtenir les autorisations nécessaires pour rechercher des entrées et accéder aux résultats de recherche dans Knowledge Catalog, demandez à votre administrateur de vous accorder les rôles IAM suivants :
-
Recherchez des entrées :
- Administrateur de catalogue Dataplex (
roles/dataplex.catalogAdmin) sur le projet utilisé pour la recherche - Éditeur de catalogue Dataplex (
roles/dataplex.catalogEditor) sur le projet utilisé pour la recherche - Lecteur de catalogue Dataplex (
roles/dataplex.catalogViewer) sur le projet utilisé pour la recherche
- Administrateur de catalogue Dataplex (
-
Rechercher les métadonnées des ensembles de données et des tables BigQuery :
Lecteur de métadonnées BigQuery (
roles/bigquery.metadataViewer) sur l'ensemble de données ou la table -
Rechercher des entrées personnalisées : Lecteur de catalogue Dataplex (
roles/dataplex.catalogViewer) sur le projet
Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.
Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.
Utiliser la recherche par mots clés uniquement
Console
Pour rechercher des ressources à l'aide de la recherche par mot clé, procédez comme suit :
Dans la console Google Cloud , accédez à la page Rechercher de Knowledge Catalog.
Dans le champ Rechercher des ressources dans plusieurs projets, saisissez votre requête.
Pour affiner votre recherche, utilisez le panneau Filtres. Les filtres suivants sont disponibles :
- Les systèmes fournissent une liste des systèmes disponibles, tels que BigQuery ou Cloud SQL. Le système Knowledge Catalog contient des entrées personnalisées.
- Les aspects vous permettent de rechercher des éléments tagués à l'aide d'un modèle spécifique. Vous pouvez utiliser le menu Personnaliser pour affiner davantage les résultats et les filtrer par valeurs d'aspect spécifiques.
- La section Projet liste les projets dans lesquels vous pouvez limiter la recherche.
- Les alias de type sont des types de données associés à un type d'entrée. Un type d'entrée peut avoir le nom
projects/test-project/locations/us/entryTypes/my-entry-type, mais vous pouvez le rechercher à l'aide de ses alias de typeTABLEouDATABASE. Vous pouvez définir un ou plusieurs alias de type lorsque vous créez ou mettez à jour un type d'entrée. - Les ensembles de données proviennent de BigQuery.
Vous pouvez ajouter manuellement les filtres suivants :
- Ajouter un filtre de projet : dans Projet, cliquez sur Ajouter un projet. Recherchez un projet précis, sélectionnez-le, puis cliquez sur Ouvrir.
- Ajouter un filtre de type d'aspect : dans Aspects, cliquez sur le menu Ajouter d'autres types d'aspects. Recherchez un modèle précis, sélectionnez-le, puis cliquez sur OK.
Facultatif : En plus des composants auxquels vous avez accès, vous pouvez rechercher des ressources accessibles publiquement dans Google Cloud en sélectionnant Inclure des ensembles de données publics.
Suivez les conseils ci-dessous pour créer une requête de recherche :
- Placez votre expression de recherche entre guillemets si elle contient des espaces Par exemple,
"search terms". - Ajoutez
NOTdevant un mot clé pour appliquer la négation logique du filtrekeyword:term. Vous pouvez également utiliser les opérateurs booléensANDetORpour combiner des expressions de recherche. Les opérateursAND,ORetNOTne sont pas sensibles à la casse.
Par exemple,
NOT column:termliste toutes les colonnes, sauf celles qui correspondent au terme spécifié.- Placez votre expression de recherche entre guillemets si elle contient des espaces Par exemple,
Pour afficher plus d'informations sur la ressource recherchée, cliquez sur son nom dans les résultats de recherche. La page des détails de l'entrée s'ouvre.
gcloud
Pour rechercher des ressources, utilisez la commande gcloud dataplex entries search.
C#
C#
Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Go
Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Java
Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Node.js
Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
PHP
Avant d'essayer cet exemple, suivez les instructions de configuration pour PHP décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour PHP.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Python
Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Ruby
Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.
Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
REST
Pour rechercher des ressources, utilisez la méthode searchEntries.
Syntaxe de recherche par mot clé uniquement
Pour des recherches précises, vous pouvez construire une requête à l'aide d'une syntaxe spécifique, y compris des qualificatifs, des opérateurs logiques et des recherches d'aspects.
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. - Un signe deux-points (
:) après la clé fait correspondre le prédicat à une sous-chaîne ou à un jeton dans la valeur des résultats de recherche.
La tokenisation divise le flux de texte en une série de jetons, chacun correspondant généralement à un seul mot.
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.
La recherche par mot clé Knowledge Catalog est compatible avec les qualificatifs suivants :
| Qualificatif | Description |
|---|---|
name:x |
Correspond à x en tant que sous-chaîne de l'ID de ressource. |
displayname:x |
Correspond à 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é) dans le schéma de la ressource. |
description:x |
Correspond à x en tant que jeton dans la description de la ressource. |
label:bar |
Correspond aux ressources BigQuery qui ont une étiquette (avec une certaine valeur) et dont la clé d'étiquette contient bar en tant que sous-chaîne. |
label=bar |
Correspond aux ressources BigQuery qui ont une étiquette (avec une certaine valeur) et dont la clé d'étiquette est égale à bar sous forme de chaîne. |
label:bar:x |
Correspond à x en tant que sous-chaîne dans la valeur d'un libellé 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 la clé est égale à bar. |
label.foo=bar |
Correspond aux ressources BigQuery dont la clé est égale à foo et la valeur de la clé est égale à bar. |
label.foo |
Correspond aux ressources BigQuery dont la clé de libellé 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 |
Correspond aux 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 hiérarchique d'une ressource. Le chemin d'accès parent est un fully_qualified_name de la ressource parente. |
orgid=number |
Correspond aux ressources d'une organisation Google Cloud avec la valeur d'ID exacte number. |
system=SYSTEM |
Correspond aux ressources d'un système spécifié. |
location=LOCATION |
Correspond aux ressources d'un emplacement spécifié avec un nom exact.
Par exemple, Les éléments BigQuery Omni sont compatibles avec ce qualificatif en utilisant le nom de l'emplacement BigQuery Omni.
Par exemple, |
createtime |
Recherche les ressources créées à une date ou une heure données, ou avant ou après. Exemple :
Format du code temporel : Tous les codes temporels doivent être au format GMT. Les fuseaux horaires ne sont pas acceptés. Les codes temporels partiels, les séparateurs de date avec un tiret ( Exemple :
|
updatetime |
Recherche les ressources qui ont été mises à jour à une date ou une heure données, ou avant ou après. Exemple :
Format du code temporel : Tous les codes temporels doivent être au format GMT. Les fuseaux horaires ne sont pas acceptés. Les codes temporels partiels, les séparateurs de date avec un tiret ( Exemple :
|
fully_qualified_name:x |
Correspond à x en tant que sous-chaîne de fully_qualified_name. |
fully_qualified_name=x |
Correspondances x en tant que fully_qualified_name. |
Recherche d'aspects
Pour rechercher des entrées en fonction de leurs aspects 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 de champ d'aspect. Correspond à La liste des opérateurs compatibles dépend du type de champ de l'aspect, comme suit :
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
|
Opérateurs logiques
Une requête peut se composer de plusieurs prédicats liés par des opérateurs logiques AND, OR ou NOT.
- Si vous ne spécifiez pas d'opérateur, l'opérateur logique
ANDest implicite. Par exemple,foo barrenvoie les ressources qui correspondent à la fois au prédicatfooet au prédicatbar. - Niez un prédicat avec un préfixe
-(trait d'union) ouNOT. Par exemple,-name:foorenvoie les ressources dont le nom ne correspond pas au prédicatfoo.
Dans la recherche par mots clés uniquement, les opérateurs logiques ne sont pas sensibles à la casse.
Syntaxe abrégée
Pour utiliser une syntaxe abrégée dans vos requêtes, utilisez | (barre verticale) pour les opérateurs OR et , (virgule) pour les opérateurs AND.
La syntaxe abrégée fonctionne pour les prédicats qualifiés, à l'exception de label.
Les exemples suivants montrent comment utiliser la syntaxe abrégée avec la recherche par mot clé uniquement.
Rechercher des entrées dans l'un des nombreux projets à l'aide de l'opérateur
ORprojectid:(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:id4Recherchez les entrées dont les noms de colonnes correspondent :
- AND :
column:(name1,name2,name3) - OU :
column:(name1|name2|name3)
- AND :
Étapes suivantes
- En savoir plus sur la gestion des métadonnées dans Knowledge Catalog
- Découvrez comment enrichir des entrées et des liens d'entrée avec des métadonnées à l'aide des aspects.
- Apprenez à gérer les entrées et ingérer des sources personnalisées.