> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Couchbase

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:

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Sources** tab and locate
  the **Couchbase** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the Couchbase connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## Authenticate to Couchbase

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

**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.

* [**Basic**](#basic) (default)
* [**Credentials File**](#credentials-file)

### Basic

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

<ul><li>**Auth Scheme:** Select **Basic**.</li>
<li>**User:** Enter the username that you use to authenticate to your Couchbase account.</li>
<li>**Password:** Enter the password that you use to authenticate to your Couchbase account.</li></ul>

### 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](https://docs.couchbase.com/server/current/n1ql/n1ql-rest-api/index.html).

## 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 1.1.1.1 or 8.8.8.8.
   * **Use SSL:** Select whether you want to enable Secure Sockets Layer (SSL). By default, the **Enable** checkbox is not selected.
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](https://cdn.cdata.com/help/CKN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.