CockroachDB

El conector de CockroachDB te permite realizar operaciones de inserción, eliminación, actualización y lectura en una base de datos de CockroachDB.

Antes de comenzar

Antes de usar el conector CockroachDB, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Para obtener más información sobre cómo crear un clúster sin servidores y usar todos los parámetros de la aplicación creada, consulta Cómo crear un clúster sin servidores de CockroachDB en Cockroachlabs.

Para obtener información sobre cómo crear un certificado autofirmado , consulta Certificado de cucaracha.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona CockroachDB en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging. y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   8. Base de datos: el nombre de la base de datos de Cockroach.
   9. Permitir la preparación de una declaración: permite la preparación de una declaración de consulta antes de su ejecución.
   10. Metadatos de conjunto de resultados de recuperación: este campo establece si el proveedor obtiene información detallada sobre las columnas del conjunto de resultados del servidor.
   11. UseSSL: Este campo configura si SSL está habilitado.
   12. SSLServerCert: Este campo configura si SSL está habilitado.
   13. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   14. Haga clic en SIGUIENTE.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si quieres establecer una conexión privada con tus sistemas de backend, Selecciona Adjunto de extremo de la lista y, luego, selecciona el adjunto de extremo requerido. de la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y el adjunto de extremos. Después de porque creaste el adjunto de extremo, estará visible en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública con tus sistemas de backend con seguridad adicional, puedes considera configurar la configuración estática de direcciones IP internas para tus conexiones y, luego, para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.

   2. Haga clic en SIGUIENTE.
6. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de CockroachDB admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haga clic en SIGUIENTE.
7. Revisa: Revisa tus detalles de conexión y autenticación.
8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• Nombre de usuario y contraseña
  • Username: Nombre de usuario para el conector
  • Password: El Secret de Secret Manager que contiene la contraseña asociada con el conector.

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra de los diversos campos que configuras cuando creas la conexión de CockroachDB.

CockroachDB: Tipo de conexión de autenticación básica

Nombre del campo	Detalles
Ubicación	us-central1
Conector	CockroachDB
Versión del conector	1
Nombre de la conexión	cockroach-db-cloud-conn
Habilita Cloud Logging	Sí
Cuenta de servicio	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Sí
SSLServerCert	cockroach-db-ssl-cert
SecretVersion	1
Base de datos	TestGCP
Permitir la sentencia preparada	Sí
Recuperar metadatos del conjunto de resultados	Sí
Nivel de verbosidad	5
Cantidad mínima de nodos	2
Cantidad máxima de nodos	50
Tipo de destino (servidor)	Dirección del host
Dirección del host	googlecloud-bcone-cluster-13792.5xj.cockroachlabs.cloud. Este es el nombre del clúster en la nube CockroachDB.
Puerto	26257
Nombre de usuario	Nombre de usuario
Contraseña	contraseña
Versión del Secret	1

CockroachDB: Tipo de conexión de PSC

Nombre del campo	Detalles
Ubicación	us-central1
Conector	CockroachDB
Versión del conector	1
Nombre de la conexión	cockroach-db-cloud-conn-psc
Habilita Cloud Logging	Sí
Cuenta de servicio	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Sí
SSLServerCert	gcp-bcone-crdb-hosted-node-crt
SecretVersion	1
Base de datos	banco
Permitir la sentencia preparada	No
Recuperar metadatos del conjunto de resultados	No
Nivel de verbosidad	5
Cantidad mínima de nodos	2
Cantidad máxima de nodos	50
Tipo de destino (servidor)	Dirección del host
Dirección del host	192.0.2.0/24 (este debería ser el adjunto de extremo creado en función de la IP del servidor que aloja la instancia de la base de datos de cucaracha)
Puerto	26257
Nombre de usuario	Nombre de usuario
Contraseña	contraseña
Versión del Secret	1

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtén
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones operaciones no aparecen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y una parámetro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros como los siguientes: el parámetro nombres y su tipo de datos correspondiente. El esquema (metadatos) para entidades y acciones se recupera a través de la conexión en del entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se se reflejan automáticamente en tus conexiones existentes; debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualiza el esquema de conexión.

Limitaciones del sistema

El conector CockroachDB puede procesar 1 transacción por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors se ajustará automáticamente de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin mientras esperas el ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Se requieren más nodos para procesar más transacciones para una conexión. Por el contrario, hay menos nodos se requieren si una conexión procesa menos transacciones. Cómo configurar el nodo de salida, haz lo siguiente:

• Si eres cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página de edición de la conexión.
• Si estás basado en una suscripción comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que puede controlar un nodo depende de varios factores. Antes de ajustar la cantidad mínima de nodos para mejorar la capacidad de procesamiento, te recomendamos verificar si tus sistemas de backend están configurados de manera óptima para manejar el tráfico requerido.

Ejemplos de operaciones de entidades

Ejemplo: enumera los registros de una entidad

En este ejemplo, se muestran los registros de la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users de la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, puedes establecer la filterClause según tus requisitos.

   Por ejemplo, configurar la cláusula de filtro como employeeCode='5100' and startDate='2010-01-01 00:00:00', muestra solo esos registros. cuyo employeeCode es 5100 y startDate es 2010-01-01 00:00:00.

Ejemplo: Obtén un solo registro de una entidad

En este ejemplo, se recupera un registro de la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona User en la lista Entity.
3. Selecciona la operación Get y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 103032 en el campo Valor predeterminado.

   Aquí, 103032 es el valor de clave primaria de la entidad Users.

Ejemplo: Borra un registro de una entidad

En este ejemplo, se borra un registro de la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users de la lista Entity.
3. Selecciona la operación Delete y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 113132 en el campo Valor predeterminado.

   De manera alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes establecer la filterClause. Por ejemplo, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Ejemplo: crea un registro en una entidad

En este ejemplo, se crea un registro en la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

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

Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector obtendrás la respuesta de la operación de creación.

Ejemplo: actualiza un registro en una entidad

En este ejemplo, se actualiza un registro en la entidad Users.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users de la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "country": "IN"
   }

5. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 113132 en el campo Valor predeterminado.

   Como alternativa, si la entidad tiene claves primarias compuestas en lugar de especificar entityId, puedes establecer filterClause. Por ejemplo, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector para tener la respuesta de la operación de actualización.

Acciones

En esta sección, se enumeran las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Acción ExecuteCustomQuery

Esta acción te permite ejecutar una consulta personalizada.

Para crear una consulta personalizada, sigue estos pasos:

1. Sigue las instrucciones detalladas para agregar una tarea de conectores.
2. Cuando configures la tarea del conector, en el tipo de acción que deseas realizar, selecciona Acciones.
3. En la lista Acción, selecciona Ejecutar consulta personalizada y, luego, haz clic en Listo.

   

4. Expande la sección Task input y haz lo siguiente:
   1. En el campo Tiempo de espera después, ingresa la cantidad de segundos que se debe esperar hasta que se ejecute la consulta.

      Valor predeterminado: 180 segundos.

   2. En el campo Cantidad máxima de filas, ingresa la cantidad máxima de filas que se mostrarán en la base de datos.

      Valor predeterminado: 25.

   3. Para actualizar la consulta personalizada, haz clic en Edit Custom Script (Editar secuencia de comandos personalizada). Se abrirá el diálogo Editor de secuencia de comandos.

      

   4. En el diálogo Editor de secuencia de comandos, ingresa la consulta en SQL y haz clic en Guardar.

      Puedes usar un signo de interrogación (?) en una instrucción de SQL para representar un parámetro único que debe especificarse en la lista de parámetros de consulta. Por ejemplo, la siguiente consulta de SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados para la columna LastName:

      SELECT * FROM Employees where LastName=?

      Nota: Se admiten las declaraciones de lenguaje de manipulación de datos (DML) y lenguaje de definición de datos (DDL).
   5. Si usaste signos de interrogación en tu consulta en SQL, debes agregar el parámetro. Para ello, haz clic en + Agregar nombre del parámetro en cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta en SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), debes agregar tres parámetros en orden de secuencia.

      

      Para agregar parámetros de consulta, haz lo siguiente:

      1. En la lista Tipo, selecciona el tipo de datos del parámetro.
      2. En el campo Valor, ingresa el valor del parámetro.
      3. Para agregar varios parámetros, haz clic en + Agregar parámetro de consulta.

Si la ejecución se realiza correctamente, esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que tiene los resultados de la consulta.

Nota: Las funciones definidas en CockroachDB se enumeran como acciones. en la tarea de conector. Por lo tanto, puedes ejecutar una función ejecutando el comando acción. Para ver un ejemplo sobre cómo ejecutar una función, consulta .

Ejemplos de acciones

Ejemplo: Encuentra el valor mayor

En este ejemplo, se muestra cómo ejecutar una función definida por el usuario. La función find_greater en este ejemplo compara dos números enteros y muestra el número entero que es mayor.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción find_greater y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:

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

Si la ejecución de la acción se realiza correctamente, la connectorOutputPayload de la tarea del conector tendrán un valor similar al siguiente:

[{
"bignum": 5.0
}]

Usar Terraform para crear conexiones

Puedes usar Terraform resource para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
use_ssl	BOOLEAN	Falso	Este campo establece si SSL está habilitada.
ssl_server_cert	SECRET	Falso	Este campo establece si SSL está habilitada.
base de datos	STRING	Verdadero	Es el nombre de la base de datos de la cucaracha.
allow_prepared_statement	BOOLEAN	Falso	Permite la preparación de una instrucción de consulta antes de que se ejecute.
fetch_result_set_metadata	BOOLEAN	Falso	Este campo establece si el proveedor obtiene información detallada sobre las columnas del conjunto de resultados del servidor.

Usa la conexión de CockroachDB en una integración

Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
• Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información para suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Aprende a ver los registros del conector.