Extensión de bases de datos de Google Cloud Spanner

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X.
información

Versión 1.2.1

Realizar operaciones de inserción, consulta y actualización en una base de datos de Cloud Spanner

En este contenido, se proporciona referencia para configurar y usar esta extensión. Antes de usar la extensión desde un proxy de API con la política ExtensionLlamadas, usted debe hacer lo siguiente:

  1. Crea una instancia de Cloud Spanner, como se describe en Crea y administra instancias, y crea una base de datos.

  2. Una vez que tengas la instancia y una base de datos, otorga permiso para acceder a tu base de datos a la cuenta de servicio de GCP que representa tu extensión. Para obtener más información sobre el rol que debes usar, consulta Roles de Cloud Spanner. Para obtener más información sobre el control de acceso de Cloud Spanner, consulta Cómo aplicar roles de IAM y Control de acceso para Cloud Spanner.

  3. Si tienes una cuenta de servicio que tiene permiso para acceder al nivel de acceso a tu base de datos que deseas, usa GCP Console a fin de generar una clave para esa cuenta. Usa el contenido del archivo JSON de clave resultante cuando configures esta extensión.

  4. Usa el contenido del archivo JSON de claves resultante cuando agregues y configures la extensión con la referencia de configuración.

Acerca de Cloud Spanner

Cloud Spanner es un servicio de bases de datos relacionales que es útil para datos relacionales, estructurados y semiestructurados que requieren alta disponibilidad, coherencia sólida y lecturas y escrituras transaccionales.

Si recién comienzas a usar Cloud Spanner, la guía de inicio rápido de la documentación de Cloud Spanner es un buen punto de partida.

Ejemplos

En los siguientes ejemplos, se muestra cómo configurar la compatibilidad con las acciones de extensión de Cloud Spanner con la política ExtensionReference.

Agregar datos

En el siguiente ejemplo, la acción insert de la extensión agrega un usuario nuevo a la tabla de usuarios.

<?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>

Cómo obtener datos

En este ejemplo, una consulta recupera los valores de nombre de usuario y correo electrónico de la tabla user.

Primero, una política de AssignMessage asigna una variable postal.code.value para usarla en una cláusula WHERE de consulta. Este es un ejemplo. Tu política probablemente establecería el valor según los parámetros de solicitud del cliente.

<?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 siguiente política ExtensionReference ejecuta una consulta en la base de datos, con el contenido de la variable postal.code.value en la cláusula 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>

Luego, la siguiente política AssignMessage usa la respuesta de la extensión. almacenado en la variable spanner.userdata.retrieved, como la respuesta mostró al cliente.

<?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>

En este ejemplo, los datos de respuesta se muestran en formato JSON, tal como se muestra a continuación.

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

Cómo actualizar datos

En este ejemplo, el elemento <Input> contiene username, la clave primaria de la tabla, y un valor nuevo para la columna 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>

Acciones

insert

Inserta las filas especificadas en la base de datos.

Sintaxis

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

Ejemplo

En el siguiente ejemplo, la acción insert de la extensión agrega un usuario nuevo a la tabla de usuarios. Se agrega una fila.

<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>

parámetros de solicitud

Parámetro Descripción Tipo Predeterminada Obligatorio
tableName La tabla de la base de datos en la que se deben insertar las filas. String Ninguno Sí.
filas Las filas que se insertarán se expresan como un array en un objeto JSON rows. Arreglo Ninguno Sí.

Respuesta

Ninguno

querySQL

Consulta la base de datos mediante la instrucción de SQL con los parámetros especificados. Los parámetros se proporcionan en la instrucción de SQL con nombres con el prefijo @; los valores del parámetro se especifican en el parámetro params de esta acción.

Para obtener detalles sobre la sintaxis de consulta de Cloud Spanner, visita Sintaxis de consultas.

Sintaxis

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

Ejemplo

En este ejemplo, una consulta recupera los valores de las columnas username y email de la tabla user. La instrucción de SQL especifica un parámetro postalCode que se establece a partir de la variable de flujo postal.code.value.

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

parámetros de solicitud

Parámetro Descripción Tipo Predeterminada Obligatorio
sql La consulta SQL que se ejecutará. Puedes especificar parámetros con nombres de parámetros precedidos por @. Esos nombres de parámetros deben corresponder a claves en el parámetro params de esta acción. String Ninguno Sí.
params Un objeto cuyas claves y valores son los nombres y valores de los parámetros usados en la consulta en SQL. Puedes enumerar varios parámetros aquí. Objeto Ninguno No.

Respuesta

Un objeto rows que contiene un array de pares de nombre-valor de columnas que muestra la consulta. Por ejemplo:

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

update

Actualiza las filas de la base de datos con los datos especificados.

Sintaxis

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

Ejemplo

En este ejemplo, la dirección de correo electrónico del usuario cuyo username es Liz456 se actualiza con un valor nuevo. Se actualizó una fila.

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

parámetros de solicitud

Parámetro Descripción Tipo Predeterminada Obligatorio
tableName La tabla de la base de datos en la que se deben actualizar las filas. String Ninguno Sí.
filas Un array de datos de filas para actualizar. Cada entidad del array debe contener el valor de ID único (como la clave primaria) para la fila que se actualizará. Arreglo Ninguno Sí.

Respuesta

Ninguno

Referencia de configuración

Usa la siguiente información cuando configures e implementes esta extensión para usarla en proxies de API. Si quieres conocer los pasos para configurar una extensión con la consola de Apigee, consulta Agrega y configura una extensión.

Propiedades de extensión comunes

Las siguientes propiedades están presentes para cada extensión.

Propiedad Descripción Predeterminado Obligatorio
name Nombre que asignas a esta configuración de la extensión. Ninguna
packageName Nombre del paquete de extensiones proporcionado por Apigee Edge. Ninguna
version El número de versión del paquete de extensiones desde el que quieres configurar la extensión. Ninguna
configuration Es un valor de configuración específico para la extensión que agregas. Consulta Propiedades para este paquete de extensiones Ninguna

Propiedades de este paquete de extensión

Especifica valores para las siguientes propiedades de configuración específicas de esta extensión.

Propiedad Descripción Predeterminado Obligatorio
ID de proyecto ID del proyecto de GCP que contiene la base de datos. Ninguno Sí.
instanceId ID de la instancia de Cloud Spanner en tu proyecto de GCP. Ninguno Sí.
IDdebasededatos ID de la base de datos de Cloud Spanner. Ninguno Sí.
credenciales Cuando se ingresa en la consola de Apigee Edge, este es el contenido de su archivo de claves de cuenta de servicio. Cuando se envía a través de la API de Management, es un valor codificado en base64 que se genera a partir del archivo de claves de la cuenta de servicio. Ninguno Sí.