Couchbase

El conector de Couchbase te permite conectarte a una instancia de base de datos de Couchbase y realizar las operaciones de base de datos admitidas.

Versiones compatibles

  • Couchbase Server 4.0 y versiones posteriores (Enterprise Edition o Community Edition)

  • Sofá acolchado

Antes de comenzar

Antes de usar el conector Couchbase, 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.

  • Si es necesario, crea un servidor de Couchbase. Para obtener más información, consulta la Guía de inicio rápido de Couchbase Server.
    • Para obtener información sobre las APIs de Couchbase, consulta este documento de la API de REST de Couchbase.
  • Si es necesario, descarga el certificado SSL. Para obtener más información, consulta Cómo proteger la conexión con TLS.

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 Couchbase 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 conexión no pueden superar los 49 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.

    8. Permitir parámetros JSON: Permite que el JSON sin procesar se use en parámetros cuando QueryPassthrough está habilitado.
    9. Puerto de Analytics: Es el puerto para conectarse al extremo de Analytics de Couchbase.
    10. Separador secundario: Carácter o caracteres que se usan para indicar tablas secundarias.
    11. Servicio de Couchbase: Determina el servicio de Couchbase al que conectarse. El valor predeterminado es N1QL. Las opciones disponibles son N1QL y Analytics.
    12. Cuota de RAM de tabla: la cuota predeterminada de RAM, en megabytes, para usar cuando se insertan buckets a través de la sintaxis CREATE TABLE.
    13. Separador de datos: Es el carácter o los caracteres que se usan para denotar los datos y los alcances o las colecciones de Analytics.
    14. Separador de variantes: Es el carácter o los caracteres que se usan para denotar variantes.
    15. Puerto N1QL: el puerto para conectarse al extremo de Couchbase N1QL.
    16. Separador de puntos: Son los caracteres que se usan para denotar la jerarquía.
    17. Tiempo de espera de la ejecución de la consulta: Establece el tiempo de espera del servidor para la consulta, que regula por cuánto tiempo Couchbase ejecutará la consulta antes de mostrar un error de tiempo de espera.
    18. Comparación estricta: Ajusta la precisión con la que los filtros de las consultas de entrada de SQL deben traducirse en consultas de Couchbase. Se puede establecer como una lista de valores separados por comas, en la que cada valor puede ser una de las siguientes opciones: fecha, número, valor booleano o cadena.
    19. Durabilidad de la transacción: Especifica cómo se debe almacenar un documento para que una transacción se realice correctamente. Especifica si se deben usar transacciones de N1QL cuando se ejecutan consultas.
    20. Tiempo de espera de la transacción: Establece la cantidad de tiempo que puede ejecutarse una transacción antes de que Couchbase agote el tiempo de espera.
    21. Use Collections For DDL: Indica si se debe suponer que las instrucciones CREATE TABLE usan colecciones en lugar de variantes. Solo tiene efecto cuando se conecta a Couchbase v7 y GenerateSchemaFiles se establece en OnCreate.
    22. Usar transacciones: Especifica si se deben usar las transacciones N1QL cuando se ejecutan consultas.
    23. Validar parámetros JSON: Permite que el proveedor valide que los parámetros de cadena sean JSON válidos antes de enviar la consulta a Couchbase.
    24. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
      • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Básico: Autenticación HTTP básica.
        • Resumen: Autenticación de HTTP de resumen.
      • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
      • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
      • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
        • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
        • Siempre: La conexión siempre está habilitada para SSL.
        • Nunca: La conexión no está habilitada para SSL.
        • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
      • En la sección Proxy Server, ingresa los detalles del servidor proxy.
        1. Haz clic en Agregar destino.
        2. Selecciona un Tipo de destino.
          • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

            Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

    25. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
    26. 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 deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido 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 Couchbase es compatible con los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

      2. 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.
    • UseSSL: Este campo configura si SSL está habilitado.
    • SSLServerCert: SSLServerCert para el conector de Couchbase
    • Esquema de autenticación: Esquema de Auth para el conector de Couchbase.
    • Modo de conexión: Determina cómo conectarse al servidor de Couchbase. Debe ser Direct o Cloud. Para Cloud, SSL es obligatorio. Para obtener más información, consulta Cómo proteger las conexiones con TLS.
    • Servidor DNS: Determina qué servidor DNS usar cuando se recupera la información de Couchbase Cloud. Por ejemplo, 8.8.8.8

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra para los distintos campos que configuras cuando creas el conector de Couchbase.

SSL: Tipo de conexión del certificado

Nombre del campo Detalles
Región us-central1
Conector Couchbase
Versión del conector 1
Nombre del conector Couchbase-basic-auth-conn
Cuenta de servicio NAME-compute@developer.gserviceaccount.com
Nivel de verbosidad 5
Configuración del nodo de conexión: Cantidad mínima o máxima de nodos 2/50
Configuración de SSL: Habilita SSL Verdadero
Almacén de confianza Privada
Almacén de confianza personalizado Un certificado PEM completo (-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----)
Versión del Secret 1
Dirección del host xx.1HOST_NAME.cloud.couchbase.com:18xxx
Autenticación Contraseña de usuario
Nombre de usuario nombre de usuario
Contraseña contraseña
versions 1
Modo de conexión v Nube
Servidor DNS 192.0.2.0
Esquema de OAuth Básico

Tipo de conexión de Couchbase de Analytics

Nombre del campo Detalles
Región us-central1
Conector Couchbase
Versión del conector 1
Nombre del conector Couchbase-basic-auth-Analytics-conn
Cuenta de servicio NAME-compute@developer.gserviceaccount.com
Puerto de estadísticas 18095
Servicio de Couchbase Analytics
Nivel de verbosidad 5
Configuración del nodo de conexión: Cantidad mínima o máxima de nodos 2/50
Dirección del host xx.1HOST_NAME.cloud.couchbase.com:18095
Autenticación Contraseña de usuario
Nombre de usuario nombre de usuario
Contraseña contraseña
versions 1
Modo de conexión v Nube
Servidor DNS 192.0.2.0
Esquema de OAuth Básico

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.

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

    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, estas operaciones no compatibles no se incluyen 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.

Acciones

Este conector admite la ejecución de las siguientes acciones:

  • Funciones y procedimientos almacenados definidos por el usuario. Si tienes funciones y procedimientos almacenados en tu backend, estos se enumeran en la columna Actions del diálogo Configure connector task.
  • Consultas de SQL personalizadas. Para ejecutar consultas personalizadas en SQL, el conector proporciona la acción Ejecutar 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.

      imagen que muestra la acción execute-custom-query Imagen que muestra la acción de ejecutar-custom-query-action

    4. Expande la sección Task input y, luego, haz lo siguiente:
      1. En el campo Timeout after, ingresa la cantidad de segundos que se espera 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.

        imagen que muestra custom-sql-query imagen que muestra custom-sql-query

      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 sentencia SQL para representar un solo parámetro que se debe especificar 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=?

      5. Si usaste signos de interrogación en tu consulta de SQL, debes agregar el parámetro haciendo clic en + Agregar nombre de parámetro para cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), debes agregar tres parámetros en orden de secuencia.

        Imagen que muestra el parámetro add-query-param imagen que muestra add-query-param

        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.

Limitaciones del sistema

El conector Couchbase puede procesar 25 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, los conectores de integración asignan 2 nodos (para una mejor disponibilidad) a una conexión.

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

Acciones

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

Acción AddDocument

Esta acción agrega documentos en Couchbase.

Parámetros de entrada de la acción AddDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
Nombre del bucket String Sí Es el bucket en el que se insertará el documento.
SourceTable Objeto No Es el nombre de la tabla temporal que contiene las columnas ID y Document. Es obligatorio si no se especifica ningún ID.
ID String No Es la clave primaria en la que se insertará el documento. Obligatorio si no se especifica SourceTable.
Documento String No Es el texto JSON del documento que se insertará. Es obligatorio si no se especifica SourceTable.

Parámetros de salida de la acción AddDocument

Esta acción devuelve el estado 200 (OK) si la acción se realizó correctamente.

Por ejemplo, sobre cómo configurar la acción AddDocument, consulta Ejemplos de acciones.

Acción CreateCollection

Esta acción crea una colección en un alcance existente.

Parámetros de entrada de la acción CreateCollection

Nombre del parámetro Tipo de datos Obligatorio Descripción
Bucket String Sí El nombre del bucket que contiene la colección.
Alcance String Sí Es el nombre del alcance que contiene la colección.
Nombre String Sí El nombre de la colección que se creará.

Parámetros de salida de la acción CreateCollection

Esta acción muestra el estado 200 (OK) si se realiza correctamente.

Por ejemplo, sobre cómo configurar la acción CreateCollection, consulta Ejemplos de acciones.

Acción DeleteCollection

Esta acción borra una colección en un alcance existente.

Parámetros de entrada de la acción DeleteCollection

Nombre del parámetro Tipo de datos Obligatorio Descripción
Bucket string Verdadero El nombre del bucket que contiene la colección.
Alcance String Verdadero Es el nombre del alcance que contiene la colección.
Nombre string Verdadero Es el nombre de la colección que se borrará.

Parámetros de salida de la acción DeleteCollection

Esta acción muestra el estado 200 (OK) si se realiza correctamente.

Por ejemplo, sobre cómo configurar la acción DeleteCollection, consulta Ejemplos de acciones.

Acción CreateScope

Esta acción crea un permiso en un bucket existente.

Parámetros de entrada de la acción CreateScope

Nombre del parámetro Tipo de datos Obligatorio Descripción
Bucket String Sí Es el nombre del bucket que contiene el permiso.
Nombre String Sí El nombre del alcance que se creará.

Parámetros de salida de la acción CreateScope

Esta acción muestra el estado 200 (OK) si se realiza correctamente.

Para ver ejemplos sobre cómo configurar la acción CreateScope, consulta Ejemplos de acciones.

Acción DeleteScope

Esta acción borra un permiso y todas sus colecciones.

Parámetros de entrada de la acción DeleteScope

Nombre del parámetro Tipo de datos Obligatorio Descripción
Bucket String Sí El nombre del bucket que contiene el permiso.
Nombre String Sí El nombre del permiso que se borrará.

Parámetros de salida de la acción DeleteScope

Esta acción muestra el estado 200 (OK) si se realiza correctamente.

Para ver ejemplos sobre cómo configurar la acción DeleteScope, consulta Ejemplos de acciones.

Acción ListIndices

Esta acción enumera todos los índices disponibles en Couchbase.

Parámetros de entrada de la acción ListIndices

N/A

Parámetros de salida de la acción ListIndices

Esta acción devuelve el estado 200 (OK) si la acción se realizó correctamente.

Para ver ejemplos sobre cómo configurar la acción ListIndices, consulta Ejemplos de acciones.

Acción ManageIndices

Esta acción crea o descarta un índice en un bucket.

Parámetros de entrada de la acción ManageIndices

Nombre del parámetro Tipo de datos Obligatorio Descripción
Nombre del bucket String Sí El bucket de destino desde el que se crea o se descarta el índice.
ScopeName objeto No El alcance de destino desde el que se creará o descartará el índice (Couchbase versión 7 y versiones posteriores)
CollectionName String No La colección de destino desde la que se creará o descartará el índice (Couchbase versión 7 y versiones posteriores)
Acción String Sí Especifica qué acción realizar en el índice, puede ser Crear o Eliminar.
Expresiones String No Es una lista de expresiones o funciones, codificadas como JSON, en las que se basará el índice. Se requiere al menos uno si IsPrimary se establece en "false" y la acción es "Create".
Nombre String No Es el nombre del índice que se creará o descartará, obligatorio si IsPrimary se establece en falso.
IsPrimary String No Especifica si el índice debe ser un índice principal.El valor predeterminado es verdadero.
Filtros String No Una lista de filtros, codificados como JSON, para aplicar en el índice.
IndexType String No El tipo de índice que se creará, puede ser GSI o Vista, solo se usará si la acción es Crear. El valor predeterminado es GSI.
ViewName String No Obsoleto, solo se incluye por compatibilidad. No hace nada.
Nodos String No Una lista, codificada como JSON, de nodos para contener el índice, debe contener el puerto. Solo se usa si la acción es Crear.
NumReplica String No Cuántas réplicas se crearán entre los nodos de índice del clúster.

Parámetros de salida de la acción ManageIndices

Esta acción devuelve el estado 200 (OK) si la acción se realizó correctamente.

Por ejemplo, sobre cómo configurar la acción ManageIndices, 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 desees realizar, selecciona Acciones.
  3. En la lista Acción, selecciona Ejecutar consulta personalizada y, luego, haz clic en Listo.

    imagen que muestra la acción execute-custom-query Imagen que muestra la acción de ejecutar-custom-query-action

  4. Expande la sección Task input y, luego, haz lo siguiente:
    1. En el campo Timeout after, ingresa la cantidad de segundos que se espera 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.

      imagen que muestra custom-sql-query imagen que muestra custom-sql-query

    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 sentencia SQL para representar un solo parámetro que se debe especificar 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=?

    5. Si usaste signos de interrogación en tu consulta de SQL, debes agregar el parámetro haciendo clic en + Agregar nombre de parámetro para cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), debes agregar tres parámetros en orden de secuencia.

      Imagen que muestra el parámetro add-query-param imagen que muestra add-query-param

      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.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Agregar un documento

En este ejemplo, se agrega un documento a un bucket de Couchbase.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddDocument 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: 
    {
"Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
"BucketName": "CouchbaseTestBucket",
"ID": "Test"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea AddDocument tendrá un valor similar al siguiente:

    [{
"RowsAffected": "1"
}]

Ejemplo: Crea una colección

En este ejemplo, se crea una colección.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CreateCollection 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: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

    4. En este ejemplo, se crea una colección en TestScope. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CreateCollection tendrá un valor similar al siguiente:

    [{
"Success": true,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Ejemplo: Cómo borrar una colección

En este ejemplo, se borra una colección.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteCollection 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: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

    4. En este ejemplo, se borra una colección de TestScope. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CreateCollection tendrá un valor similar al siguiente:

    [{
"Success": true,
"uid": "12"
}]

Ejemplo: crea un alcance

En este ejemplo, se crea un alcance.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CreateScope 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: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. En este ejemplo, se crea un alcance en CouchbaseTestBucket. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CreateScope tendrá un valor similar al siguiente:

    [{
"Success": true,
"name": null,
"uid": null,
"collections": null,
"collections.name": null,
"collections.uid": null,
"collections.maxTTL": null,
"collections.history": null
}]

Ejemplo: Borra un permiso

En este ejemplo, se borra un alcance.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteScope 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: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. En este ejemplo, se borra el permiso ScopeFromGoogleCloud. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DeleteScope tendrá un valor similar al siguiente:

    [{
"Success": true,
"uid": "10"
}]

Ejemplo: índices de lista

En este ejemplo, se enumeran todos los índices disponibles en Couchbase.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción ListIndices 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: 
    {
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea ListIndices tendrá un valor similar al siguiente:

    [{
"id": "3d8a78cd2e302ac2",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": null,
"scope_id": null,
"keyspace_id": "CouchbaseTestBucket",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "test",
"state": "online",
"using": "gsi"
}, {
"id": "d6ce8c103b97a00d",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "CouchBaseDatatypes",
"index_key": "",
"condition": null,
"is_primary": "true",
"name": "#primary",
"state": "online",
"using": "gsi"
},
{
"id": "58c25aef49dd32b3",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "TestCollection",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "SearchIndexTest_1",
"state": "online",
"using": "fts"
}]

Ejemplo: administra índices

En este ejemplo, se borra un índice en el bucket especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción ManageIndices 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: 
    {
"BucketName": "CouchbaseTestBucket",
"Action": "DROP",
"Name": "CouchBaseTestIndex"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea ManageIndices tendrá un valor similar al siguiente:

    [{
"Success": "true"
}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: Muestra una lista de todos los registros

En este ejemplo, se enumeran todos los registros de la entidad TestCollection.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona TestCollection de la lista Entity.
  3. Selecciona la operación List y haz clic en Listo.
  4. De forma opcional, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Especifica el valor de la cláusula de filtro siempre entre comillas simples (').

Ejemplo: Cómo obtener un registro de una entidad

En este ejemplo, se obtiene un registro con el ID especificado de la entidad TestCollection.

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

    Aquí, 120 es un ID de registro único en la entidad TestCollection.

Ejemplo: Actualiza un registro en una entidad

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona TestCollection 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: 
    {
"COL_TEXT": "CouchBase Update"
}
  5. Haz clic en entityId y, luego, ingresa 120 en el campo Default Value.

    Si la integración se realiza correctamente, el campo connectorOutputPayload de tu tarea de conector tendrá una valor similar al siguiente:

    [{
"Document.Id": "120"
}]

Ejemplo: Borra un registro de una entidad

En este ejemplo, se borra el registro con el ID especificado en la entidad TestCollection.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona TestCollection de la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 20 en el campo Default Value.

Problemas conocidos

No se admite la operación create en entidades.

Usar Terraform para crear conexiones

Puedes usar el recurso de Terraform 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.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

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
allow_jsonparameters BOOLEAN Falso Permite que el JSON sin procesar se use en parámetros cuando QueryPassthrough está habilitado.
analytics_port STRING Falso Es el puerto para conectarse al extremo de Couchbase Analytics.
child_separator STRING Falso Los caracteres que se usan para denotar tablas secundarias.
couchbase_service ENUM Falso Determina el servicio de Couchbase al que se conectará. El valor predeterminado es N1QL. Las opciones disponibles son N1QL y Analytics. Los valores admitidos son: N1QL y Analytics
create_table_ram_quota STRING Falso Es la cuota predeterminada de RAM, en megabytes, que se debe usar cuando se insertan buckets a través de la sintaxis CREATE TABLE.
dataverse_separator STRING Falso Indica los caracteres que se utilizan para denotar los conjuntos de datos, los alcances y las colecciones de Analytics.
flavor_separator STRING Falso El carácter o los caracteres que se usan para denotar los sabores.
n1_qlport STRING Falso Es el puerto para conectarse al extremo de Couchbase N1QL.
periods_separator STRING Falso El o los caracteres que se usan para denotar la jerarquía.
query_execution_timeout STRING Falso Esto establece el tiempo de espera del servidor para la consulta, que regula por cuánto tiempo Couchbase ejecutará la consulta antes de mostrar un error de tiempo de espera.
strict_comparison STRING Falso Ajusta la precisión con la que se deben traducir filtros en consultas de entrada de SQL en consultas de Couchbase. Se puede establecer como una lista de valores separados por comas, en la que cada valor puede ser una de las siguientes opciones: fecha, número, valor booleano o cadena.
transaction_durability STRING Falso Especifica cómo se debe almacenar un documento para que una transacción se realice correctamente. Especifica si se deben usar transacciones de N1QL cuando se ejecutan consultas.
transaction_timeout STRING Falso Establece la cantidad de tiempo que puede ejecutarse una transacción antes de que Couchbase agote el tiempo de espera.
use_collections_for_ddl BOOLEAN Falso Establece si se supone que las instrucciones CREATE TABLE usan colecciones en lugar de variantes. Solo tiene efecto cuando se conecta a Couchbase v7 y GenerateSchemaFiles se establece en OnCreate.
use_transactions STRING Falso Especifica si se deben usar transacciones de N1QL cuando se ejecutan consultas.
validate_jsonparameters BOOLEAN Falso Permite que el proveedor valide que los parámetros de cadena sean JSON válidos antes de enviar la consulta a Couchbase.
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Es el tipo de autenticación que se usará para autenticarse en el proxy de ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user STRING Falso Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype ENUM Falso Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.
verbosidad STRING Falso El nivel de verbosidad para la conexión varía de 1 a 5. El nivel de verbosidad más alto registrará todos los detalles de la comunicación (solicitud,respuesta y certificados SSL).

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

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • 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 Connectors en la integración de aplicaciones, consulta Tarea Connectors.

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?