Grant the following IAM roles to the service account that you want to use for the connector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
A service account is a special type of Google account intended to represent a non-human
user that needs to authenticate and be authorized to access data in Google APIs.
If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more
information, see
Creating a service account.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them
when configuring the connector.
Configure the connector
A connection is specific to a data source. It
means that if you have many data sources, you must create a separate connection
for each data source. To create a connection, do the following:
In the Cloud console, go to the Integration Connectors > Connections page
and then select or create a Google Cloud project.
Click + CREATE NEW to open the Create Connection page.
In the Location section, choose the location for the connection.
Region: Select a location from the drop-down list.
For the list of all the supported regions, see Locations.
Click NEXT.
In the Connection Details section, complete the following:
Connector: Select Apache CouchDB from the drop down list of available Connectors.
Connector version: Select the Connector version from the drop down list of available versions.
In the Connection Name field, enter a name for the Connection instance.
Connection names must meet the following criteria:
Connection names can use letters, numbers, or hyphens.
Letters must be lower-case.
Connection names must begin with a letter and end with a letter or number.
Connection names cannot exceed 49 characters.
Optionally, enter a Description for the connection instance.
Optionally, enable Cloud logging,
and then select a log level. By default, the log level is set to Error.
Service Account: Select a service account that has the required roles.
Optionally, configure the Connection node settings:
Minimum number of nodes: Enter the minimum number of connection nodes.
Maximum number of nodes: Enter the maximum number of connection nodes.
A node is a unit (or replica) of a connection that processes transactions.
More nodes are required to process more transactions for a connection and conversely,
fewer nodes are required to process fewer transactions.
To understand how the nodes affect your connector pricing, see
Pricing for connection nodes. If you don't enter any values, by default
the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
Flexible Schema: Set FlexibleSchema to true to scan for additional metadata on the query result set. Otherwise, the metadata will remain the same.
(Optional) In the Advanced settings section, select the Use proxy checkbox to configure a proxy server for the connection and configure the following values:
Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
Basic: Basic HTTP authentication.
Digest: Digest HTTP authentication.
Proxy User: A user name to be used to authenticate with the proxy server.
Proxy Password: The Secret manager secret of the user's password.
Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
Always: The connection is always SSL enabled.
Never: The connection is not SSL enabled.
Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
In the Proxy Server section, enter details of the proxy server.
Click + Add destination.
Select a Destination Type.
Host address: Specify the hostname or IP address of the destination.
If you want to establish a private connection to your backend system, do the following:
Create an endpoint attachment and
then enter the details of the endpoint attachment in the Host address field.
Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
Click NEXT.
In the Destinations section, enter details of the remote host (backend system) you want to connect to.
Destination Type: Select a Destination Type.
To specify the destination hostname or IP address, select Host address and
enter the address in the Host 1 field.
To establish a private connection, select Host Address and add the endpoint attachment created for the SAP Gateway using the HTTPS protocol.
If you want to establish a public connection to your backend systems with additional security, you can
consider configuring static outbound
IP addresses for your connections, and then configure
your firewall rules to allowlist only the specific static IP addresses.
To enter additional destinations, click +ADD DESTINATION.
Click NEXT.
In the Authentication section, enter the authentication details.
Select an Authentication type and enter the relevant details.
The following authentication types are supported by the Apache CouchDB connection:
All the Integration Connectors provide a layer of abstraction for the objects of
the connected application. You can access an application's objects only through
this abstraction. The abstraction is exposed to you as entities, operations, and actions.
Entity: An entity can be thought of as an object, or a collection of properties, in the
connected application or service. The definition of an entity differs from a connector to a
connector. For example, in a database connector, tables are the entities, in a
file server connector, folders are the entities, and in a messaging system connector,
queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the
Entities list will be empty.
Operation: An operation is the activity that you can perform on an entity. You can perform
any of the following operations on an entity:
Selecting an entity from the available list, generates a list of
operations available for the entity. For a detailed description of the operations, see the Connectors task's
entity operations.
However, if a connector doesn't support any of the entity operations, such unsupported
operations aren't listed in the Operations list.
Action: An action is a first class function that is made available to the integration
through the connector interface. An action lets you make changes to an entity or entities, and
vary from connector to connector. Normally, an action will have some input parameters, and an output
parameter. However, it is possible
that a connector doesn't support any action, in which case the Actions list will be empty.
System limitations
The Apache CouchDB connector can process a maximum of 5 transactions per second,
per node,
and throttles any
transactions beyond this limit.
By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.
For information on the limits applicable to Integration Connectors, see Limits.
Entity operation examples
Example - List all customer records
This example lists all customer records in the Customer entity.
In the Configure connector task dialog, click Entities.
Select Customer from the Entity list.
Select the LIST operation, and then click Done.
Optionally, you can enter values in the filterClause to filter the result set.
Example - Get a customer record
This example gets a specific customer record from the Customers entity.
In the Configure connector task dialog, click Entities.
Select Customers from the Entity list.
Select the GET operation, and then click
Done.
In the Task Input section of the Connectors task, click EntityId and
then enter cust-2 in the Default Value field.
Here, cust-2 is the primary key value of the Customers entity.
Example - Add a customer
This example creates a customer record in the Customers entity.
In the Configure connector task dialog, click Entities.
Select Customers from the Entity list.
Select the Create operation, and then click Done.
In the Task Input section of the Connectors task, click
connectorInputPayload and then enter a value similar to the following in the
Default Value field:
{"name":"John","_id":"cust-3"}
If the integration is successful, the connector task's connectorOutputPayload field will have a
value similar to the following:
{"_id":cust-3}
Example - Update a customer record
This example updates the specified customer record in the Customers entity.
In the Configure connector task dialog, click Entities.
Select Customers from the Entity list.
Select the Update operation, and then click Done.
In the Task Input section of the Connectors task, click
connectorInputPayload and then enter a value similar to the following in the
Default Value field:
{"name":"Jason",}
Click entityId, and then enter cust-5 in the Default Value field.
Alternately, instead of specifying the entityId, you can also set the
filterClause to cust-5.
If the integration is successful, the connector task's connectorOutputPayload field will have a
value similar to the following:
{"_id":cust-5}
Example - Delete a customer record
This example deletes the specified customer record from the Customers entity.
In the Configure connector task dialog, click Entities.
Select Customers from the Entity list.
Select the Delete operation, and then click Done.
In the Task Input section of the Connectors task, click entityId and
then enter cust-6 in the Default Value field.
To view a sample terraform template for connection creation, see sample template.
When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:
Parameter name
Data type
Required
Description
flexible_schema
BOOLEAN
False
Set FlexibleSchema to true to scan for additional metadata on the query result set. Otherwise, the metadata will remain the same.
proxy_enabled
BOOLEAN
False
Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme
ENUM
False
The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user
STRING
False
A user name to be used to authenticate to the ProxyServer proxy.
proxy_password
SECRET
False
A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype
ENUM
False
The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL
Use the Apache CouchDB connection in an integration
After you create the connection, it becomes available in both
Apigee Integration and Application Integration. You can use the connection
in an integration through the Connectors task.
To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.
Get help from the Google Cloud community
You can post your questions and discuss this connector in the Google Cloud
community at Cloud Forums.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-09 UTC."],[],[]]
