Ce document explique comment rechercher des composants de données dans Knowledge Catalog.
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 :
-
Rechercher 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 (
-
Recherchez 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 utilisé pour la recherche
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.
Autorisations au niveau des composants
Les résultats de recherche sont limités à votre niveau d'accès, indépendamment du projet sélectionné. Pour trouver un élément dans Knowledge Catalog, vous devez disposer des autorisations de lecture appropriées pour cette ressource dans son système source sous-jacent.
Par exemple, pour trouver une table BigQuery, vous avez besoin du rôle roles/bigquery.metadataViewer, tandis que pour trouver une instance Cloud SQL, vous avez besoin des autorisations Cloud SQL équivalentes. Pour en savoir plus, consultez Portée de la recherche.
Activer l'API
Activer l'API Dataplex
Rôles requis pour activer les API
Pour activer les API, vous devez disposer de l'autorisation serviceusage.services.enable. Si vous avez créé le projet, vous disposez probablement déjà de cette autorisation grâce au rôle Propriétaire (roles/owner). Sinon, vous pouvez obtenir cette autorisation grâce au rôle Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin). Découvrez comment attribuer des rôles.
Rechercher des ressources
Console
Pour rechercher des ressources, procédez comme suit :
Dans la console Google Cloud , accédez à la page Rechercher de Knowledge Catalog.
Si l'invite Essayer la recherche en langage naturel s'affiche, cliquez dessus. Par défaut, la recherche en langage naturel est sélectionnée.
Dans le champ Rechercher des ressources dans plusieurs projets en langage naturel, saisissez votre requête, puis cliquez sur Entrée.
Pour affiner votre recherche, cliquez sur Filtres.
- Les filtres de plusieurs sections sont évalués avec l'opérateur logique
AND. - Lorsque plusieurs filtres sont sélectionnés dans une même section, ils sont pris en compte selon l'opérateur logique
OR.
Les filtres suivants sont disponibles :
- Champ d'application : effectuez une recherche dans l'ensemble de l'organisation (par défaut), dans le projet actuel ou uniquement pour les ressources suivies. Pour en savoir plus, consultez Champ d'application de la recherche.
- Systèmes : service Google Cloud auquel appartient la ressource, comme BigQuery. Le système Knowledge Catalog contient des groupes d'entrées.
- Projets : projets dans lesquels effectuer la recherche.
- Type : type de ressource, comme une connexion BigQuery, un bucket Cloud Storage ou une base de données. Selon le type de ressource, vous pouvez également filtrer par sous-type, comme le type de connexion ou le dialecte SQL.
- Sélectionner des zones géographiques : les zones géographiques dans lesquelles effectuer la recherche.
- Sélectionner des ensembles de données : les résultats de recherche sont limités aux ressources BigQuery appartenant aux ensembles de données BigQuery sélectionnés. Dans le champ Saisissez le nom du filtre, saisissez le nom de l'ensemble de données.
- Types d'aspects : types d'aspects Knowledge Catalog associés à la ressource que vous recherchez. Pour filtrer par valeurs d'aspect, cliquez sur Filtrer sur les valeurs de type d'aspect, puis sélectionnez les valeurs.
- Les filtres de plusieurs sections sont évalués avec l'opérateur logique
Pour afficher plus d'informations sur la ressource recherchée, cliquez sur son nom dans les résultats de recherche pour ouvrir la page d'informations.
Google Cloud CLI
Pour rechercher des ressources, utilisez la commande gcloud dataplex entries search :
gcloud dataplex entries search 'foo' \ --project=PROJECT_ID \ --semantic-search
Remplacez PROJECT_ID par l'ID du projet Google Cloud .
C#
C#
Avant d'essayer cet exemple, suivez les instructions de configuration pour C# du 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 du 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 du 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 du 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 du 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 du 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 du 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 avec le paramètre SemanticSearch défini sur true.
POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchEntries?query=foo&semanticSearch=true
Remplacez les éléments suivants :
- PROJECT_ID : ID de votre projet Google Cloud
- LOCATION : région où se trouve le projet (par exemple,
us-central1)
Afficher les détails d'un composant renvoyé par la recherche
Console
Utilisez la recherche Knowledge Catalog pour afficher les détails d'un élément.
Recherchez un élément dans Knowledge Catalog.
Dans les résultats de recherche, cliquez sur le composant dont vous souhaitez afficher les détails.
La page des détails de l'entrée s'ouvre. Elle comprend les sections suivantes :
- Détails de l'entrée : informations telles que le type d'entrée, le système, la plate-forme, le nom complet, la date et l'heure de création, la date et l'heure de la dernière modification, la description et les responsables.
- Aperçu : aperçu de l'entrée, si disponible.
- Aspects : aspects obligatoires et facultatifs définis pour l'entrée. Pour en savoir plus, consultez Catégories d'aspects.
gcloud
Commande gcloud dataplex entries lookup :
gcloud dataplex entries lookup ENTRY_ID \ --entry-group=ENTRY_GROUP_ID \ --location=LOCATION \ --project=PROJECT_ID
Remplacez les éléments suivants :
ENTRY_ID: ID de l'entréeENTRY_GROUP_ID: ID du groupe d'entréesLOCATION: région où se trouve le projetPROJECT_ID: ID du projet Google Cloud .
C#
C#
Avant d'essayer cet exemple, suivez les instructions de configuration pour C# du 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 du 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 du 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 du 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 du 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 du 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 du 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 afficher les détails d'un élément, utilisez la méthode lookupEntry.
Limites
La recherche présente les limites suivantes :
- Les ressources publiques ne sont pas incluses dans la recherche en langage naturel.
- Les aspects associés aux liens d'entrée ne sont pas inclus dans la recherche en langage naturel.
Étapes suivantes
- Comprendre la syntaxe de recherche pour Knowledge Catalog.
- En savoir plus sur les métadonnées dans Knowledge Catalog
- Découvrez comment enrichir des entrées et des liens vers des entrées avec des métadonnées à l'aide des aspects.
- Apprenez à gérer les entrées et ingérer des sources personnalisées.
- Découvrez les cas d'utilisation de Knowledge Catalog.
- Exploitez l'agent de découverte du Knowledge Catalog pour répondre à des requêtes complexes en langage naturel.