Extension de base de données Google Cloud Spanner

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

<ph type="x-smartling-placeholder">

Version 1.4.1

Effectuez des opérations d'insertion, de requête et de mise à jour sur une base de données Cloud Spanner.

Ce contenu fournit des informations de référence pour configurer et utiliser cette extension. Avant d'utiliser l'extension depuis un proxy d'API à l'aide de la classe Règle ExtensionAccroche, vous devez:

  1. Créez une instance Cloud Spanner, comme décrit dans la section Créer et gérer des instances, puis créez une base de données.

  2. Une fois que vous disposez de l'instance et d'une base de données, accordez l'autorisation d'y accéder au compte de service GCP qui représente votre extension. Pour en savoir plus sur le rôle à utiliser, consultez la page Rôles Cloud Spanner. Pour en savoir plus sur le contrôle des accès à Cloud Spanner, consultez les pages Appliquer des rôles IAM et Contrôle des accès pour Cloud Spanner.

  3. Lorsque vous disposez d'un compte de service disposant des autorisations nécessaires pour le niveau d'accès à votre base de données, utilisez la console GCP afin de générer une clé pour le compte de service. Utilisez le contenu du fichier JSON de clé obtenu lorsque vous configurez cette extension.

  4. Utilisez le contenu du fichier JSON de clé obtenu lors de l'ajout et de la configuration de l'extension à l'aide de la documentation de référence de configuration.

À propos de Cloud Spanner

Cloud Spanner est un service de base de données relationnelle utile pour les données relationnelles, structurées et semi-structurées, qui nécessitent une haute disponibilité, une cohérence forte, ainsi que des lectures et des écritures transactionnelles.

Si vous faites vos premiers pas avec Cloud Spanner, le guide de démarrage rapide disponible dans la documentation de Cloud Spanner constitue un bon point de départ.

Exemples

Les exemples suivants montrent comment configurer la prise en charge des actions d'extension Cloud Spanner à l'aide de la règle ExtensionCall.

Ajouter des données

Dans l'exemple suivant, l'action insert de l'extension ajoute un utilisateur au tableau des utilisateurs.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Insert-New-User">
    <DisplayName>Insert New User</DisplayName>
    <Connector>spanner-users-products</Connector>
    <Action>insert</Action>
    <Input><![CDATA[{
        "tableName" : "user",
        "rows" : [{
          "username": "jonesy42",
          "firstName": "Floyd",
          "lastName": "Jones",
          "address": "3695 Auctor Street",
          "city": "Gresham",
          "region": "OR",
          "postalCode": "12693",
          "email": "floydster@example.com"
      }]
  }]]></Input>
</ConnectorCallout>

Obtenir les données

Dans cet exemple, une requête récupère les valeurs du nom d'utilisateur et de l'adresse e-mail de la table user.

Tout d'abord, une règle AssignMessage attribue une variable postal.code.value à utiliser dans une clause WHERE de requête. Ceci est un exemple. Votre règle définirait probablement la valeur en fonction des paramètres de requête du client.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Postal-Code">
    <AssignTo createNew="true" transport="http" type="request"/>
    <AssignVariable>
        <Name>postal.code</Name>
        <Value>86519</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

La règle ExtensionAppel suivante exécute une requête sur la base de données à l'aide du contenu de la variable postal.code.value dans la clause WHERE.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-User-Data">
    <DisplayName>Get User Data</DisplayName>
    <Connector>spanner-users-products</Connector>
    <Action>querySQL</Action>
    <Input><![CDATA[{
      "sql" : "SELECT username, email FROM user WHERE postalCode = @postalCode",
      "params" : {
        "postalCode" : "{postal.code.value}"
      }
    }]]></Input>
  <Output>spanner.userdata.retrieved</Output>
</ConnectorCallout>

La règle AssignMessage suivante utilise ensuite la réponse de l'extension, stockée dans la variable spanner.userdata.retrieved, la réponse renvoyée au client.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Query-Response-Data">
    <DisplayName>Get Query Response Data</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{spanner.userdata.retrieved}</Payload>
    </Set>
</AssignMessage>

Dans cet exemple, les données de réponse sont renvoyées au format JSON comme suit.

{
  "rows": [
    {
      "username": "freewill444",
      "email": "freewill@example.com"
    }
  ]
}

Mettre à jour des données

Dans cet exemple, l'élément <Input> contient username (la clé primaire de la table) et une nouvelle valeur pour la colonne email.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Update-User-Data">
    <DisplayName>Update User Data</DisplayName>
    <Connector>spanner-users-products</Connector>
    <Action>update</Action>
    <Input><![CDATA[{
        "tableName" : "user",
        "rows": [{
            "username":"Liz456",
            "email":"lizzard@example.com"
        }]
    }]]></Input>
</ConnectorCallout>

Actions

<ph type="x-smartling-placeholder">

insert

Insère les lignes spécifiées dans la base de données.

Syntaxe

<Action>insert</Action>
<Input><![CDATA[{
  "tableName" : "table-to-insert-into",
  "rows" : "rows-to-insert"
}]]></Input>

Exemple

Dans l'exemple suivant, l'action insert de l'extension ajoute un utilisateur au tableau des utilisateurs. Une ligne est ajoutée.

<Action>insert</Action>
<Input><![CDATA[{
    "tableName" : "user",
    "rows" : [{
      "username": "jonesy42",
      "firstName": "Floyd",
      "lastName": "Jones",
      "address": "3695 Auctor Street",
      "city": "Gresham",
      "region": "OR",
      "postalCode": "12693",
      "email": "floydster@example.com"
  }]
}]]></Input>

Paramètres de requête

Paramètre Description Type Par défaut Obligatoire
tableName Table de la base de données dans laquelle les lignes doivent être insérées. Chaîne Aucun Oui.
lignes Lignes à insérer, exprimées sous forme de tableau dans un objet JSON rows. Tableau Aucun Oui.

Réponse

Aucun

querySQL

Interroge la base de données à l'aide de l'instruction SQL avec les paramètres spécifiés. Les paramètres sont indiqués dans l'instruction SQL avec des noms précédés du symbole @. sont spécifiées dans le paramètre params de cette action.

Pour en savoir plus sur la syntaxe des requêtes Cloud Spanner, consultez la page Syntaxe des requêtes.

Syntaxe

<Action>querySQL</Action>
<Input><![CDATA[{
  "sql" : "sql-query-statement",
  "params" : {
    "param1" : "columnValue"
  }
}]]></Input>

Exemple

Dans cet exemple, une requête récupère les valeurs des colonnes username et email de la table user. L'instruction SQL spécifie un paramètre postalCode défini à partir de la variable de flux postal.code.value.

<Action>querySQL</Action>
<Input><![CDATA[{
  "sql" : "SELECT username, email FROM user WHERE postalCode = @postalCode",
  "params" : {
    "postalCode" : "{postal.code.value}"
  }
}]]></Input>

Paramètres de requête

Paramètre Description Type Par défaut Obligatoire
sql Requête SQL à exécuter. Vous pouvez spécifier les paramètres avec des noms de paramètres précédés du symbole @. Les noms de ces paramètres doivent correspondre aux clés du paramètre params de cette action. Chaîne Aucun Oui.
params Objet dont les clés et les valeurs sont les noms et les valeurs des paramètres utilisés dans la requête SQL. Vous pouvez indiquer plusieurs paramètres ici. Objet Aucun Non.

Réponse

Un objet rows contenant un tableau de paires nom/valeur de colonne renvoyées par la requête. Exemple :

{
  "rows": [
    {
      "username": "freewill444",
      "email": "freewill@example.com"
    }
  ]
}

update

Met à jour les lignes de la base de données avec les données spécifiées.

Syntaxe

<Input><![CDATA[{
  "tableName" : "table-with-rows-to-update",
  "rows" : "rows-to-update"
}]]></Input>

Exemple

Dans cet exemple, l'adresse e-mail de l'utilisateur dont l'username est Liz456 a été remplacée par une nouvelle valeur. Une ligne est mise à jour.

<Action>update</Action>
<Input><![CDATA[{
  "tableName" : "user",
  "rows": [{
      "username":"Liz456",
      "email":"lizzard@example.com"
  }]
}]]></Input>

Paramètres de requête

Paramètre Description Type Par défaut Obligatoire
tableName Table de la base de données dans laquelle les lignes doivent être mises à jour. Chaîne Aucun Oui.
lignes Tableau de données de ligne à mettre à jour. Chaque entité du tableau doit contenir l'identifiant unique (tel que la clé primaire) de la ligne à mettre à jour. Tableau Aucun Oui.

Réponse

Aucun

Documentation de référence sur la configuration

Procédez comme suit lorsque vous configurez et déployez cette extension afin de l'utiliser dans des proxys d'API. Pour savoir comment configurer une extension à l'aide de la console Apigee, consultez Ajouter et configurer une extension.

Propriétés courantes des extensions

Les propriétés suivantes sont présentes pour chaque extension.

Propriété Description Par défaut Obligatoire
name Nom que vous attribuez à cette configuration de l'extension. Aucune Oui
packageName Nom du package d'extension tel qu'indiqué par Apigee Edge. Aucune Oui
version Numéro de version du package d'extension à partir duquel vous configurez une extension. Aucune Oui
configuration Valeur de configuration spécifique à l'extension que vous ajoutez. Consultez Propriétés de ce package d'extension. Aucune Oui

Propriétés de ce package d'extension

Spécifiez des valeurs pour les propriétés de configuration suivantes, spécifiques à cette extension.

Propriété Description Par défaut Obligatoire
projectId ID du projet GCP contenant la base de données. Aucun Oui.
instanceId ID de l'instance Cloud Spanner dans votre projet GCP. Aucun Oui.
databaseId ID de la base de données Cloud Spanner. Aucun Oui.
credentials Lorsque vous le saisissez dans la console Apigee Edge, il s'agit du contenu de votre fichier de clé de compte de service. Lorsqu'elle est envoyée via l'API de gestion, il s'agit d'une valeur encodée en base64 générée à partir du fichier de clé du compte de service. Aucun Oui.