Version 24.2.8969


You can use the Couchbase connector from the CData Sync application to capture data from Couchbase and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Couchbase Connector

To enable Sync to use data from Couchbase, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Couchbase row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Couchbase connector. For more information about installing new connectors, see Connections.

Authenticate to Couchbase

After you add the connector, you need to set the required properties.

  • Connection Name - Enter a connection name of your choice.

  • Server - Enter the host names or the IP addresses of the Couchbase servers to which you want to connect.

CData Sync supports authenticating to Couchbase in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.


To connect with your user credentials, set the following properties:

  • Auth Scheme: Select Basic.

  • User - Enter the username that you use to authenticate to your Couchbase account.

  • Password - Enter the password that you use to authenticate to your Couchbase account.

Credentials File

To connect with a credentials file, specify the following properties:

  • Auth Scheme – Select CredentialsFile.

  • Credentials File - Enter the path to your credentials file. For information about the format of this file, see the Couchbase documentation.

Complete Your Connection

To complete your connection:

  1. Specify the following properties:

    • Couchbase Service - Select the Couchbase service to which you want to connect. The default service is N1QL.

    • Connection Mode - Select the mode with which you want to connect. The default mode is Direct. If you select Cloud, you must specify a server in the DNS Server field. In most cases, the DNS server should be a public DNS service like or

    • Use SSL - Select whether you want to enable Secure Sockets Layer (SSL). The default value is False.

  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Couchbase, see Couchbase Connector for CData Sync.