Gérer vos ressources AlloyDB à l'aide du catalogue de connaissances

L'intégration du catalogue de connaissances est activée par défaut pour tous les nouveaux clusters AlloyDB. Vous pouvez ainsi rechercher et gérer vos ressources AlloyDB pour PostgreSQL à l'aide du catalogue de connaissances, une plate-forme qui vous permet de stocker, de gérer et d'accéder aux métadonnées. Cette intégration vous aide à découvrir et à comprendre vos métadonnées AlloyDB, en prenant en charge les cas d'utilisation suivants :

  • Analyse : comprenez les dépendances et évaluez l'adéquation à différents cas d'utilisation.
  • Gestion des modifications : suivez et gérez efficacement les modifications apportées aux métadonnées.
  • Évolution du schéma : surveillez et planifiez les modifications du schéma.

Knowledge Catalog récupère automatiquement les métadonnées suivantes à partir des clusters, instances, bases de données, tables, colonnes et vues AlloyDB :

  • Nom
  • Emplacement (région)
  • Libellés (pour les clusters et les instances)
  • Intégration Dataplex activée (pour les clusters)
  • Version de la base de données
  • Nombre de processeurs de la machine (pour les instances)
  • Type de disponibilité (pour les instances)
  • Jeu de caractères (pour les bases de données)
  • Classement (pour les bases de données)
  • Propriétaire
  • Description (pour les tables, les vues, les colonnes et les clés étrangères)
  • Type (pour les clusters, les instances et les machines)
  • Colonnes
    • Type de données
    • Mode
  • Clé primaire
  • Clés étrangères
    • Table référencée
    • Mappages de colonnes
  • Heure de création
  • Date et heure de la dernière modification

Types de découverte de métadonnées

La découverte des métadonnées du catalogue de connaissances est un processus automatisé qui analyse les sources de données connectées, telles qu'AlloyDB, pour identifier les composants de données tels que les tables, les vues et les bases de données. Knowledge Catalog extrait ensuite les métadonnées techniques des composants (schémas, descriptions et emplacements, par exemple) et les importe dans Knowledge Catalog.

Ce processus synchronise les métadonnées en temps quasi réel, ce qui permet de maintenir le catalogue synchronisé avec les systèmes sources. Pour AlloyDB, les métadonnées de cluster et d'instance sont découvertes par défaut. La découverte des métadonnées de base de données, de schéma, de table et de vue est activée par défaut sur les nouveaux clusters. Pour les clusters créés avant l'implémentation de cette valeur par défaut (26 février 2026), activez l'intégration manuellement.

Knowledge Catalog est compatible avec les recherches par mots clés et en langage naturel.

  • La recherche par mots clés vous permet de trouver des ressources à l'aide de mots clés et de filtres spécifiques, ainsi que d'une syntaxe définie. Par exemple, pour afficher toutes les bases de données AlloyDB, saisissez system=AlloyDB AND type=Database.
  • La recherche en langage naturel (version preview) utilise l'IA pour comprendre les requêtes sémantiques. Elle vous permet de trouver des ressources en utilisant un langage courant, sans avoir besoin d'une syntaxe complexe. Par exemple, saisissez une requête telle que List all AlloyDB tables related to sales.

Pour en savoir plus, consultez Syntaxe de recherche pour Knowledge Catalog.

Exemple : Découvrir un schéma de base de données AlloyDB

Pour comprendre le processus de découverte des métadonnées, prenons l'exemple d'un cluster AlloyDB nommé user-data-cluster pour lequel l'intégration de Knowledge Catalog est activée. Dans l'instance principale de ce cluster, une base de données nommée profiles existe. Elle contient une table customers (id, email, signup_date) et une vue active_users (id, email).

Comme AlloyDB se synchronise quasiment en temps réel avec le catalogue de connaissances, les ressources suivantes sont disponibles :

  • Clusters
  • Colonnes
  • Bases de données
  • Instances
  • Tables
  • Vues

Une fois la découverte terminée, recherchez ces éléments (table customers et active_users) sur la page "Catalogue de connaissances" de la console Google Cloud ou à l'aide de l'API. Ensuite, affichez leurs schémas et enrichissez-les avec des métadonnées métier ou opérationnelles supplémentaires.

Enrichir les métadonnées à l'aide d'aspects

Les types d'aspect sont des ressources réutilisables qui servent de modèles pour les aspects. Les types d'aspects vous aident à éviter de dupliquer des tâches et de créer des aspects incomplets. Créez les types d'aspects nécessaires à l'aide de Knowledge Catalog.

Une fois que vous avez créé des types d'aspects personnalisés, associez des aspects à vos composants AlloyDB. L'association de certains aspects aux éléments AlloyDB vous permet d'effectuer les opérations suivantes :

  • Ajouter des métadonnées métier aux assets.
  • Rechercher des assets par métadonnées métier et autres métadonnées personnalisées.

Pour savoir comment créer des types d'aspects et associer des aspects à AlloyDB, consultez Gérer les aspects et enrichir les métadonnées.

Workflow de découverte des métadonnées

Par défaut, les ressources de cluster et d'instance sont ingérées et détectables. Pour ingérer et découvrir des ressources de base de données, de schéma, de table et de vue, procédez comme suit :

  1. Activez l'intégration de Knowledge Catalog pour votre cluster AlloyDB à l'aide de l'API AlloyDB si ce n'est pas déjà fait. Cette opération est nécessaire pour les clusters créés avant le 26 février 2026.

  2. Recherchez vos composants AlloyDB sur la page de recherche Knowledge Catalog de la console Google Cloud . Pour en savoir plus, consultez Rechercher des ressources dans Knowledge Catalog.

  3. Pour ajouter du contexte à vos composants AlloyDB, associez-leur des aspects. Les aspects sont des entrées de métadonnées personnalisées qui facilitent la gouvernance et l'analyse des données. Par exemple, utilisez un aspect pour libeller une colonne contenant des informations permettant d'identifier personnellement l'utilisateur. Pour en savoir plus, consultez Gérer les aspects et enrichir les métadonnées.

  4. Parcourez vos ressources AlloyDB en suivant cette hiérarchie : Cluster > Base de données > Schéma > Table ou Vue > Colonne. Cette hiérarchie fournit une vue détaillée de votre paysage de données. Pour en savoir plus, consultez Rechercher des ressources dans Knowledge Catalog.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud . Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. Activez l'API Dataplex pour le projet.

    Activer l'API Dataplex

  7. Vérifiez les autorisations.

    Vous devez disposer de certains rôles et autorisations IAM (Identity and Access Management) pour rechercher et associer des entrées aux composants AlloyDB. Pour en savoir plus, consultez la section Rôles et autorisations IAM requis pour Knowledge Catalog.

Rôles IAM requis

Cette section décrit les rôles et les autorisations nécessaires pour rechercher des ressources et accéder aux résultats de recherche.

Rôles requis pour accéder aux résultats de recherche

Pour rechercher et afficher les métadonnées AlloyDB dans Knowledge Catalog, les principaux doivent disposer des autorisations nécessaires pour afficher les ressources AlloyDB, y compris l'autorisation dataplex.projects.search.

Pour accorder ces autorisations à des entités (utilisateurs, groupes ou comptes de service, par exemple), attribuez-leur le rôle IAM Lecteur AlloyDB (roles/alloydb.viewer) sur le projet contenant les ressources AlloyDB.

Opération Knowledge Catalog Ressource AlloyDB Rôles ou autorisations requis
Rechercher des ressources AlloyDB Cluster alloydb.clusters.get
Colonnes alloydb.databases.get
Instance alloydb.instances.get
Base de données alloydb.databases.get
Tables alloydb.databases.get
Vues alloydb.databases.get

Si vous ne souhaitez pas utiliser le rôle prédéfini Lecteur AlloyDB, attribuez un rôle personnalisé incluant les autorisations alloydb.clusters.get, alloydb.instances.get et alloydb.databases.get.

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès. Pour en savoir plus sur les rôles AlloyDB IAM, consultez Rôles et autorisations IAM pour AlloyDB.

Rôles requis pour rechercher des entrées

Vous devez disposer d'au moins l'un des rôles IAM suivants dans le projet utilisé pour la recherche :

Les autorisations applicables aux résultats de recherche sont vérifiées indépendamment du projet sélectionné. Pour en savoir plus, consultez Rechercher des éléments de données avec Knowledge Catalog.

Fraîcheur des données d'intégration Knowledge Catalog

Par défaut, Knowledge Catalog ingère et détecte les ressources de cluster et d'instance, et la fraîcheur de leurs métadonnées est quasi en temps réel.

L'intégration du catalogue de connaissances pour les ressources de base de données, de schéma, de table et de vue est activée par défaut lorsque vous créez un cluster AlloyDB. Pour empêcher la synchronisation de ces métadonnées, désactivez l'intégration.

L'activation de l'intégration permet d'exporter les métadonnées AlloyDB (comme les bases de données, les schémas et les tables) vers des buckets Cloud Storage pour une synchronisation périodique ou vers des thèmes Pub/Sub pour une synchronisation quasi en temps réel, ce qui les rend disponibles pour Knowledge Catalog. Cette fonctionnalité ne s'applique qu'aux clusters principaux. Les clusters secondaires utilisés pour la réplication multirégionale ne sont pas compatibles avec l'intégration de Knowledge Catalog pour les métadonnées de base de données, de schéma, de table et de vue.

La fraîcheur des métadonnées pour ces ressources dépend de la date de création ou de restauration du cluster :

  • Temps quasi réel : les clusters créés ou restaurés à partir du 3 avril 2026 synchronisent les métadonnées avec Knowledge Catalog en temps quasi réel. Les mises à jour sont disponibles dans le catalogue de connaissances en cinq minutes maximum. Le processus d'extraction prend généralement quelques secondes.

  • Toutes les quelques heures : les clusters créés ou restaurés entre le 26 février 2026 et le 3 avril 2026 actualisent les métadonnées dans Knowledge Catalog toutes les quelques heures. Les mises à jour sont disponibles dans le catalogue de connaissances sous 48 heures. Le processus d'extraction prend généralement quelques minutes, mais la durée d'exécution dépend de la taille du processeur et du nombre de tables.

Créer un cluster AlloyDB avec l'intégration Knowledge Catalog désactivée

Vous pouvez contrôler cette intégration lorsque vous créez ou mettez à jour un cluster à l'aide de Google Cloud CLI ou de l'API AlloyDB :

gcloud

Utilisez la commande gcloud alloydb clusters create pour créer un cluster AlloyDB. Si vous omettez l'indicateur --enable-dataplex-integration, l'intégration de Knowledge Catalog est activée par défaut pour les métadonnées de base de données, de schéma, de table et de vue. Pour obtenir la liste complète des paramètres de cet appel, consultez gcloud alloydb clusters create. Pour en savoir plus sur les paramètres de cluster, consultez Afficher les paramètres des clusters et des instances.

N'incluez pas d'informations sensibles ou permettant d'identifier personnellement l'utilisateur dans l'ID de votre cluster, car il peut être visible dans différents contextes opérationnels, tels que les journaux système, les tableaux de bord de surveillance et les communications avec l'assistance. Vous n'avez pas besoin d'indiquer l'ID du projet dans le nom du cluster. Le système l'inclut automatiquement le cas échéant, par exemple dans les fichiers journaux.

Pour désactiver l'intégration de Knowledge Catalog pour les ressources de base de données, de schéma, de table et de vue, incluez l'indicateur --no-enable-dataplex-integration :

gcloud alloydb clusters create CLUSTER_ID \
    --password=PASSWORD \
    --region=REGION \
    --no-enable-dataplex-integration

Effectuez les remplacements suivants :

  • CLUSTER_ID : ID du cluster que vous créez. L'ID de cluster doit commencer par une lettre minuscule et peut contenir des lettres minuscules, des chiffres et des traits d'union.
  • PASSWORD : mot de passe que vous utilisez pour l'utilisateur postgres par défaut.
  • REGION : ID de la région du cluster.

REST

Utilisez la méthode POST pour créer un cluster AlloyDB. Si vous omettez dataplexConfig dans la requête, l'intégration de Knowledge Catalog est activée par défaut pour les métadonnées de base de données, de schéma, de table et de vue. Pour obtenir la liste complète des paramètres de cet appel, consultez Méthode : projects.locations.clusters.create. Pour en savoir plus sur les paramètres de cluster, consultez Afficher les paramètres des clusters et des instances.

N'incluez pas d'informations sensibles ou permettant d'identifier personnellement l'utilisateur dans l'ID de votre cluster, car il peut être visible dans divers contextes opérationnels, tels que les journaux système, les tableaux de bord de surveillance et les communications avec l'assistance. Vous n'avez pas besoin d'indiquer l'ID du projet dans le nom du cluster. Le système l'inclut automatiquement le cas échéant, par exemple dans les fichiers journaux.

Pour désactiver l'intégration de Knowledge Catalog pour les ressources de base de données, de schéma, de table et de vue, incluez "dataplexConfig": { "enabled": false } dans le corps de la requête :

{
  "databaseVersion": "DATABASE_VERSION",
  "initialUser": {
    "user": "INITIAL_USERNAME",
    "password": "INITIAL_USER_PASSWORD"
  },
  "labels": {
    "test": "alloydb-cluster-full"
  },
  "dataplexConfig" : {
    "enabled" : false
  }
}

Effectuez les remplacements suivants :

  • DATABASE_VERSION : chaîne d'énumération de la version de base de données (par exemple, POSTGRES_16).
  • INITIAL_USERNAME : nom d'utilisateur que vous utilisez pour l'utilisateur postgres par défaut.
  • INITIAL_USER_PASSWORD : mot de passe que vous utilisez pour l'utilisateur postgres par défaut.

Utilisez la méthode HTTP et l'URL suivantes :

POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID

Effectuez les remplacements suivants :

  • PROJECT_ID : ID ou numéro de projet du projet Google Cloud contenant le cluster.
  • LOCATION_ID : ID de la région du cluster.
  • CLUSTER_ID : ID du cluster que vous créez. L'ID de cluster doit commencer par une lettre minuscule et peut contenir des lettres minuscules, des chiffres et des traits d'union.

Pour envoyer votre demande, utilisez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"

PowerShell (Windows)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"| Select-Object -Expand Content

Vous recevez une réponse JSON de ce type :

Réponse

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Activer l'intégration de Knowledge Catalog pour votre cluster AlloyDB

Pour activer l'intégration de Knowledge Catalog sur un cluster existant, utilisez l'une des procédures suivantes :

gcloud

Pour activer l'intégration de Knowledge Catalog sur un cluster existant, utilisez la commande gcloud alloydb clusters update avec l'option --enable-dataplex-integration.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --enable-dataplex-integration

Effectuez les remplacements suivants :

  • CLUSTER_ID : nom du cluster.
  • REGION : ID de la région du cluster.

REST

Pour mettre à jour des champs spécifiques d'un cluster existant, utilisez la méthode PATCH sur projects.locations.clusters resource.

Utilisez la méthode HTTP et l'URL suivantes :

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Effectuez les remplacements suivants :

  • PROJECT_ID : ID ou numéro de projet du projet Google Cloud contenant le cluster.
  • LOCATION_ID : ID de la région du cluster.
  • CLUSTER_ID : nom du cluster.

Corps JSON de la requête :

{
  "dataplexConfig": {
    "enabled": true
  }
}

Pour envoyer votre demande, utilisez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

    curl -X PATCH \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Vous recevez une réponse JSON de ce type :

Réponse

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Vérifier l'intégration de Knowledge Catalog sur votre cluster AlloyDB

Pour vérifier que l'intégration de Knowledge Catalog est activée sur un cluster existant, utilisez l'une des procédures suivantes :

gcloud

Pour vérifier que l'intégration de Knowledge Catalog est activée sur un cluster existant, utilisez la commande gcloud alloydb clusters describe.

gcloud alloydb clusters describe CLUSTER_ID --region=REGION

Effectuez les remplacements suivants :

  • CLUSTER_ID : ID du cluster.
  • REGION : ID de la région du cluster.

Le résultat inclut la section dataplexConfig au format YAML. Si enabled est défini sur true, l'intégration de Knowledge Catalog est activée :

dataplexConfig:
  enabled: true

REST

Pour vérifier que l'intégration de Knowledge Catalog est activée sur un cluster existant, utilisez la méthode GET.

Utilisez la méthode HTTP et l'URL suivantes :

GET https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID

Effectuez les remplacements suivants :

  • PROJECT_ID : ID ou numéro de projet du projet Google Cloud contenant le cluster.
  • LOCATION_ID : ID de la région du cluster.
  • CLUSTER_ID : ID du cluster.

Pour envoyer votre demande, utilisez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"

PowerShell (Windows)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"| Select-Object -Expand Content

Vous recevez une réponse JSON pour l'ensemble du proto Cluster, qui inclut le message dataplexConfig :

{
  "dataplexConfig": {
    "enabled": true
  }
}

Désactiver l'intégration de Knowledge Catalog sur votre cluster AlloyDB

Lorsque vous désactivez l'intégration de Knowledge Catalog sur votre cluster AlloyDB, seules les métadonnées du cluster et de l'instance sont disponibles.

gcloud

Exécutez la commande gcloud alloydb clusters update avec l'option --no-enable-dataplex-integration pour désactiver l'intégration.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --no-enable-dataplex-integration

Effectuez les remplacements suivants :

  • CLUSTER_ID : ID du cluster.
  • REGION : ID de la région du cluster.

REST

Utilisez l'exemple suivant pour désactiver l'intégration.

Utilisez la méthode HTTP et l'URL suivantes :

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Effectuez les remplacements suivants :

  • PROJECT_ID : ID ou numéro de projet du projet Google Cloud contenant le cluster.
  • LOCATION_ID : ID de la région du cluster.
  • CLUSTER_ID : ID du cluster.

Corps JSON de la requête :

{
  "dataplexConfig": {
    "enabled": false
  }
}

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Enregistrez le corps de la requête dans un fichier nommé request.json et exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Vous recevez une réponse JSON de ce type :

Réponse

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Enrichir les éléments AlloyDB avec des aspects

Les types d'aspects sont des ressources réutilisables qui servent de modèles pour les aspects. Les types d'aspects vous aident à éviter de dupliquer des tâches et de créer des aspects incomplets. Créez les types d'aspects nécessaires à l'aide de Knowledge Catalog.

Une fois que vous avez créé des types d'aspects personnalisés, associez des aspects à vos ressources AlloyDB. L'association d'aspects aux éléments AlloyDB offre les fonctionnalités suivantes :

  • Ajouter des métadonnées métier aux éléments
  • Rechercher des éléments par métadonnées métier et autres métadonnées personnalisées

Pour savoir comment créer des types d'aspects et associer des aspects à AlloyDB, consultez Gérer les aspects et enrichir les métadonnées.

Rechercher des composants AlloyDB

Utilisez la page de recherche Knowledge Catalog dans la console Google Cloud pour rechercher des composants AlloyDB.

  1. Accédez à la page Rechercher du catalogue de connaissances.

    Accéder à la recherche

  2. Dans Choisir une plate-forme de recherche, sélectionnez Catalogue de connaissances.

  3. Dans le panneau Filtres, cliquez sur Systèmes, puis sélectionnez AlloyDB.

  4. Facultatif. Dans Alias de type, filtrez les résultats de la recherche pour un type spécifique d'élément AlloyDB en sélectionnant un ou plusieurs des alias de type suivants :

    • Base de données
    • Schéma de base de données
    • Cluster
    • Instance
    • Service
    • Table
    • Afficher

Utilisez le champ de recherche de Knowledge Catalog pour effectuer des requêtes de recherche par mots clés. Par exemple, saisissez system=AlloyDB AND type=Database pour afficher toutes les bases de données AlloyDB.

Pour en savoir plus, consultez Syntaxe de recherche pour Knowledge Catalog.

Pour afficher tous les composants AlloyDB, saisissez system=AlloyDB.

Saisissez ensuite des mots clés spécifiques. Par exemple, pour afficher toutes les bases de données AlloyDB :

system=AlloyDB AND type=Database

Pour afficher toutes les tables AlloyDB, saisissez la requête suivante :

system=AlloyDB AND type=Table

Vous pouvez également utiliser des parenthèses et les opérateurs logiques AND et OR pour les expressions complexes. Pour en savoir plus sur les expressions que vous pouvez utiliser dans le champ de recherche, consultez la section Syntaxe de recherche pour Knowledge Catalog.

Vous pouvez saisir directement des requêtes de recherche pour des composants AlloyDB spécifiques dans le champ de recherche. Le format de la chaîne de requête est le suivant :

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Remplacez les éléments suivants :

  • QUERY_STRING : utilisez la liste suivante pour identifier une chaîne de requête en fonction du type d'élément AlloyDB que vous souhaitez interroger :

    • alloydb-database
    • alloydb-cluster
    • alloydb-instance
    • alloydb-table
    • alloydb-schema
    • alloydb-view

Voici un exemple de requête :

type="projects/1234567890/locations/global/entryTypes/alloydb-cluster"

Rechercher par type d'aspect

Knowledge Catalog inclut quelques types d'aspects intégrés qui vous aident à effectuer des recherches.

Pour effectuer une recherche par type d'aspect :

  1. Dans le panneau Aspects, cliquez sur le menu Ajouter d'autres types d'aspects.
  2. Facultatif. Sélectionnez AlloyDB Access pour filtrer les résultats par dialecte AlloyDB.
  3. Sélectionnez un ou plusieurs des types d'aspects suivants pour limiter les résultats de recherche à ce type.
    • Base de données AlloyDB
    • Cluster AlloyDB
    • Instance AlloyDB
    • Vue AlloyDB
    • Schéma AlloyDB
    • Table AlloyDB
  4. Cliquez sur OK.
  5. Dans le tableau des résultats, cliquez sur le nom de l'asset pour en afficher les métadonnées.
  6. Facultatif : Améliorez ou affichez vos éléments. Vous pouvez améliorer ou afficher vos composants de différentes manières :
    • Pour ajouter une description en texte enrichi de l'élément, cliquez sur Ajouter dans Présentation.
    • Pour associer un aspect à l'élément, cliquez sur Ajouter dans Aspects.
    • Pour afficher les bases de données des membres d'une instance, cliquez sur l'onglet Liste d'entrées, puis sur Afficher toutes les entrées enfants dans la recherche. Si l'onglet Liste des entrées n'apparaît pas, cela signifie que le cluster ne comporte aucune base de données.
    • Affichez tous les détails du composant dans Détails de l'entrée. Cliquez sur le nom de l'entrée pour afficher d'autres entrées.

Recherche en langage naturel dans AlloyDB

La recherche en langage naturel (version preview) utilise l'IA pour comprendre les requêtes sémantiques. Elle vous permet de trouver des ressources en utilisant un langage courant, sans avoir besoin d'une syntaxe complexe. Par exemple, saisissez des requêtes telles que List all AlloyDB tables related to sales.

Pour en savoir plus, consultez Syntaxe de recherche pour Knowledge Catalog.

Recherche de syntaxe dans AlloyDB

La recherche par mots clés vous permet de trouver des ressources à l'aide de mots clés et de filtres spécifiques, ainsi que d'une syntaxe définie. Par exemple, saisissez system=AlloyDB AND type=Database pour afficher toutes les bases de données AlloyDB.

Pour en savoir plus, consultez Syntaxe de recherche pour Knowledge Catalog.

Exemple de workflow : afficher le détail d'un cluster dans les colonnes

Pour passer d'un cluster à des colonnes, procédez comme suit :

  1. Accédez à la page Rechercher du catalogue de connaissances.

    Accéder à la recherche

  2. Pour l'option Choisir une plate-forme de recherche, sélectionnez Catalogue de connaissances.

  3. Dans le panneau Filtres, sélectionnez Systèmes, puis AlloyDB. Vous pouvez également saisir system=AlloyDB dans le champ de recherche.

  4. Sélectionnez un nom de cluster.

  5. Sur la page Informations sur AlloyDB, cliquez sur l'onglet Liste d'entrées, puis sur Afficher toutes les entrées enfants dans la recherche. Knowledge Catalog affiche les bases de données du cluster.

  6. Sur la page Informations sur la base de données AlloyDB, cliquez sur l'onglet Liste d'entrées, puis sur Afficher les entrées enfants dans la recherche. Knowledge Catalog affiche les tables du cluster.

  7. Sélectionnez un nom de table, puis cliquez sur Schéma sur la page Informations sur la table AlloyDB pour afficher les colonnes de la table.

  8. Facultatif : Pour ajouter un type d'aspect à une colonne, cliquez sur le bouton Ajouter un aspect.

Tarifs

Le stockage des métadonnées techniques AlloyDB dans Knowledge Catalog est sans frais. La tarification standard de Knowledge Catalog s'applique aux appels d'API et à l'enrichissement supplémentaire des métadonnées métier. Pour en savoir plus, consultez la page des tarifs du catalogue de connaissances.

Utilisation des ressources

Knowledge Catalog extrait régulièrement les métadonnées de vos clusters AlloyDB. Ce processus d'extraction consomme des ressources de processeur sur votre cluster. L'utilisation du processeur est généralement minime. Par exemple, les clusters avec des types de machines plus petits (tels que n2-highmem-2-icelake) qui gèrent des schémas volumineux (tels que ceux comportant 100 000 tables ou plus) peuvent connaître une augmentation de l'utilisation du processeur pouvant atteindre 5 % pendant l'extraction.

Limites

  • L'intégration accepte un maximum d'un million de tables par base de données et une moyenne de 150 colonnes par table. Si l'une de ces limites est dépassée, les métadonnées des ressources telles que les bases de données, les schémas, les tables et les vues ne sont pas extraites. Seules les métadonnées de cluster et d'instance sont disponibles dans Knowledge Catalog.
  • Lorsqu'un cluster est créé pour la première fois, la synchronisation initiale de toutes les métadonnées avec Knowledge Catalog peut prendre jusqu'à 48 heures. Après la synchronisation initiale, les mises à jour suivantes sont disponibles quasiment en temps réel.
  • En cas de taux élevé de modifications de métadonnées (plus de 100 modifications LDD par seconde) dans votre base de données, la synchronisation des métadonnées quasi en temps réel avec Knowledge Catalog peut être suspendue pendant 30 minutes maximum avant de reprendre.
  • Si une mise à jour est manquée en raison d'un taux élevé de modifications des métadonnées, de problèmes de réseau ou d'une interruption du processus de synchronisation, elle finira par être visible dans le catalogue de connaissances sous 48 heures.
  • Lorsqu'une instance n'existe pas ou n'est pas en cours d'exécution, la suppression des métadonnées peut prendre sept jours.
  • Lorsqu'une base de données est renommée, seule la mise à jour de la base de données est disponible dans Knowledge Catalog en temps quasi réel. Le mappage sous-jacent de la base de données et de toutes les tables correspondantes sera mis à jour dans le catalogue de connaissances sous 48 heures.

Étapes suivantes