CockroachDB

Le connecteur CockroachDB vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur une base de données CockroachDB.

Avant de commencer

Avant d'utiliser le connecteur CockroachDB, effectuez les tâches suivantes:

• Dans votre projet Google Cloud :
  • Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du connecteur.
  • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

  • Activez les services suivants :
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Pour savoir comment activer des services, consultez la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

   Accéder à la page "Connexions"

2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
   1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

   2. Cliquez sur NEXT (Suivant).
4. Dans la section Informations de connexion, procédez comme suit :
   1. Connecteur : sélectionnez CockroachDB dans la liste déroulante des connecteurs disponibles.
   2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
   3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 63 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   6. Vous pouvez également configurer les paramètres du nœud de connexion :
      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   7. Base de données : nom de la base de données Cockroach.
   8. Autoriser une instruction préparée : permet d'autoriser la préparation d'une instruction de requête avant son exécution.
   9. Récupérer les métadonnées de l'ensemble de résultats : ce champ indique si le fournisseur obtient des informations détaillées sur les colonnes d'ensemble de résultats du serveur.
   10. UseSSL : ce champ indique si SSL est activé.
   11. SSLServerCert : ce champ indique si SSL est activé.
   12. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
   13. Cliquez sur NEXT (Suivant).
5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
   1. Type de destination : sélectionnez un type de destination.
      • Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.
        Remarque : Pour savoir comment créer un rattachement du point de terminaison, consultez Rattachement de service PSC et Rattachement du point de terminaison. Une fois le rattachement du point de terminaison créé, il apparaît dans la liste Rattachement du point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

   2. Cliquez sur NEXT (Suivant).
6. Dans la section Authentification, saisissez les informations d'authentification.
   1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion CockroachDB :

      • Nom d'utilisateur et mot de passe

   Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

   2. Cliquez sur NEXT (Suivant).
7. Vérifiez vos informations de connexion et d'authentification.
8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

• Nom d'utilisateur et mot de passe
  • Nom d'utilisateur : nom d'utilisateur du connecteur
  • Mot de passe : Secret de Secret Manager contenant le mot de passe associé au connecteur.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • Créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et une sortie . Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions seront associées à un schéma. Par exemple, un schéma d'action comportera les détails des paramètres tels que : le paramètre noms et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion à partir de votre backend. En cas de mises à jour du schéma, elles ne sont pas automatiquement répercutée dans vos connexions existantes. vous devez actualiser le schéma manuellement. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualisez le schéma de connexion.

Limites du système

Le connecteur CockroachDB peut traiter une transaction par seconde, par nœud, et régule toutes les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Remarque:Le nombre de nœuds Integration Connectors effectue l'autoscaling de manière dynamique. en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour des volumes importants sans en attente de l'autoscaling, vous pouvez ajuster la valeur minimale du nombre de nœuds pour une connexion. Plus sont nécessaires pour traiter davantage de transactions pour une connexion. À l'inverse, le nombre de nœuds sont requis si une connexion traite moins de transactions. Pour configurer le nœud, procédez comme suit : , procédez comme suit:

• Si vous avez opté pour le paiement à l'usage, configurez les valeurs minimale et maximale du nœud sur la page "Modifier la connexion".
• Si vous disposez d'un abonnement client, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de divers facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Exemples d'opérations sur les entités

Exemple : Lister les enregistrements d'une entité

Cet exemple répertorie les enregistrements de l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Users dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le paramètre filterClause selon vos besoins.

   Par exemple, définir la clause de filtre sur employeeCode='5100' and startDate='2010-01-01 00:00:00' (affiche uniquement ces enregistrements) dont le codeemployee est 5100 et startDate est 2010-01-01 00:00:00.

Exemple : Obtenir un enregistrement unique à partir d'une entité

Cet exemple extrait un enregistrement de l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez User dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et puis saisissez 103032 dans le champ Default Value (Valeur par défaut).

   Ici, 103032 est la valeur de clé primaire de l'entité Users.

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime un enregistrement de l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Users dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et puis saisissez 113132 dans le champ Default Value (Valeur par défaut).

   Si l'entité utilise des clés primaires composites au lieu de spécifier entityId, vous pouvez également Définissez la clause filterClause. Exemple : employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Exemple – Créer un enregistrement dans une entité

Cet exemple crée un enregistrement dans l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Users dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:

   {
   "employeeCode": "5100",
   "startDate": "2010-01-01 00:00:00.0",
   "country": "US"
   }
   

Si l'intégration réussit, le champ connectorOutputPayload de la tâche de connecteur pour obtenir la réponse de l'opération de création.

Exemple – Mettre à jour un enregistrement dans une entité

Cet exemple met à jour un enregistrement dans l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Users dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:

   {
   "country": "IN"
   }

5. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et puis saisissez 113132 dans le champ Default Value (Valeur par défaut).

   Si l'entité utilise des clés primaires composites au lieu de spécifier entityId, vous pouvez également Définissez la clause filterClause. Exemple : employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Si l'intégration réussit, le champ connectorOutputPayload de la tâche de connecteur obtenir la réponse de l'opération de mise à jour.

Actions

Cette section liste les actions compatibles avec le connecteur. Pour comprendre comment configurer consultez la section Exemples d'actions.

Action ExecuteCustomQuery

Cette action vous permet d'exécuter une requête personnalisée.

Pour créer une requête enregistrée, procédez comme suit :

1. Suivez les instructions détaillées pour ajouter une tâche de connecteurs.
2. Lorsque vous configurez la tâche de connecteur, sélectionnez Actions dans le type d'action à effectuer.
3. Dans la liste Action, sélectionnez Exécuter une requête personnalisée, puis cliquez sur OK.

   

4. Développez la section Entrée de la tâche, puis procédez comme suit :
   1. Dans le champ Délai d'inactivité après, saisissez le nombre de secondes d'attente jusqu'à l'exécution de la requête.

      Valeur par défaut : 180 secondes.

   2. Dans le champ Nombre maximal de lignes, saisissez le nombre maximal de lignes à renvoyer à partir de la base de données.

      Valeur par défaut : 25

   3. Pour mettre à jour la requête personnalisée, cliquez sur Modifier le script personnalisé. La boîte de dialogue Éditeur de script s'affiche.

      

   4. Dans la boîte de dialogue Éditeur de script, saisissez la requête SQL, puis cliquez sur Enregistrer.

      Vous pouvez utiliser un point d'interrogation (?) dans une instruction SQL pour représenter un seul paramètre devant être spécifié dans la liste des paramètres de requête. Par exemple, la requête SQL suivante sélectionne toutes les lignes de la table Employees correspondant aux valeurs spécifiées pour la colonne LastName :

      SELECT * FROM Employees where LastName=?

      Remarque : Les instructions LMD (langage de manipulation de données) et LDD (langage de définition de données) sont acceptées.
   5. Si vous avez utilisé des points d'interrogation dans votre requête SQL, vous devez ajouter le paramètre en cliquant sur + Ajouter un nom de paramètre pour chaque point d'interrogation. Lors de l'exécution de l'intégration, ces paramètres remplacent les points d'interrogation (?) de la requête SQL de manière séquentielle. Par exemple, si vous avez ajouté trois points d'interrogation (?), vous devez ajouter trois paramètres dans l'ordre.

      

      Pour ajouter des paramètres de requête, procédez comme suit :

      1. Dans la liste Type, sélectionnez le type de données du paramètre.
      2. Dans le champ Valeur, saisissez la valeur du paramètre.
      3. Pour ajouter plusieurs paramètres, cliquez sur + Ajouter un paramètre de requête.

Si l'exécution réussit, cette action renvoie l'état 200 (OK) avec un corps de réponse contenant les résultats de la requête.

Remarque : Les fonctions définies dans CockroachDB sont répertoriées en tant qu'actions. dans la tâche du connecteur. Par conséquent, vous pouvez exécuter une fonction en exécutant la requête action. Pour découvrir comment exécuter une fonction, consultez la section .

Exemples d'actions

Exemple – Déterminer la valeur la plus élevée

Cet exemple montre comment exécuter une fonction définie par l'utilisateur. find_greater dans cet exemple, compare deux entiers et renvoie le nombre entier le plus élevé.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action find_greater, puis cliquez sur OK.
3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value:

   {
   "$1": 1.0,
   "$2": 5.0
   }

Si l'exécution de l'action aboutit, l'état (connectorOutputPayload) de la tâche de connecteur aura une valeur semblable à celle-ci:

[{
"bignum": 5.0
}]

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Requis	Description
use_ssl	VALEUR BOOLÉENNE	Faux	Ce champ indique si SSL est activé.
ssl_server_cert	SECRET	Faux	Ce champ indique si SSL est activé.
base de données	STRING	Vrai	Nom de la base de données Cockroach.
allow_prepared_statement	VALEUR BOOLÉENNE	Faux	Cette option permet de préparer une instruction de requête avant son exécution.
fetch_result_set_metadata	VALEUR BOOLÉENNE	Faux	Ce champ détermine si le fournisseur obtient du serveur des informations détaillées sur les colonnes de l'ensemble de résultats.

Utiliser la connexion CockroachDB dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".

• Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
• Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante

• Découvrez comment suspendre et réactiver une connexion.
• Découvrez comment surveiller l'utilisation des connecteurs.
• Découvrez comment afficher les journaux du connecteur.