Skip to Content

Couchbase connection


A Couchbase connection, created using the Couchbase connector, establishes access to Couchbase. These activities, once configured, interact with Couchbase through the connection.

Create or edit a Couchbase connection

A new Couchbase connection is created using the Couchbase connector from one of these locations:

An existing Couchbase connection can be edited from these locations:

Configure a Couchbase connection

Each user interface element of the Couchbase connection configuration screen is described below.


Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each Couchbase connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Couchbase endpoint, which refers to both a specific connection and its activities.

  • Server: Enter the server.

  • Auth Scheme: Select the authorization scheme, one of:

    • Basic

      • User: Enter the user.

      • Password: Enter the password.

    • CredentialsFile

      • Credentials File: Enter the credentials file.
    • SSLCertificate

      • SSL Client Cert: Enter the SSL client certificate.

      • SSL Client Cert Type: Select the SSL client certificate type, one of:

        • USER

        • MACHINE

        • PFXFILE

        • PFXBLOB

        • JKSFILE

        • JKSBLOB

        • PEMKEY_FILE

        • PEMKEY_BLOB





        • P7BFILE

        • PPKFILE

        • XMLFILE

        • XMLBLOB

      • SSL Client Cert Password: Enter the SSL client certificate password.

      • SSL Client Cert Subject: Enter the SSL client certificate subject.

  • Couchbase Service: Select the Couchbase service, one of:

    • N1QL

    • Analytics

  • Connection Mode: Select the connection mode, one of:

    • Direct

    • Cloud

      • DNS Server: Enter the DNS server.
  • Use SSL: When selected, specifies to use SSL.

  • Use Proxy Settings: Select to use private agent proxy settings.

  • Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

    Click the add icon add icon to add a row to the table below and enter a key-value pair for each property.

    To save the row, click the submit icon submit icon in the rightmost column.

    To edit or delete a single row, hover over the rightmost column and use the edit icon edit icon or delete icon delete icon.

    To delete all rows, click Clear All.


    Fields in the Advanced Configurations table display the variable icon Variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

  • Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Couchbase connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Query: Retrieves records from a table at Couchbase and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at Couchbase and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at Couchbase and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at Couchbase and is intended to be used as a target in an operation.

  • Execute: Executes a procedure at Couchbase and is intended to be used as a target in an operation.