# Couchbase

<!-- BEGIN GENERATED:intro -->

The Couchbase connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for Couchbase.

To create a new Couchbase source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for Couchbase-specific configuration and networking. For the complete property reference, see the [official Couchbase driver documentation ↗](https://cdn.cdata.com/help/CKK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The Couchbase connector is in the [beta](../../platform-overview/development-life-cycle/index.md) phase of development and may not be available on your enrollment. Functionality may change during active development.
:::

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| [Table exports](#table-exports) | 🟡 Beta |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`AuthScheme` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_AuthScheme.htm) | Mandatory | The type of authentication to use when connecting to Couchbase. | `Basic` |
| [`ConnectionMode` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_ConnectionMode.htm) | Mandatory | Determines how to connect to the Couchbase server. Must be either Direct or Cloud. | `Cloud` |
| [`CouchbaseService` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_CouchbaseService.htm) | Mandatory | Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics. | `Analytics` |
| [`DNSServer` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_DNSServer.htm) | Mandatory | Determines what DNS server to use when retrieving Couchbase Capella information. | `8.8.8.8` |
| [`Server` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_Server.htm) | Mandatory | The address of the Couchbase server or servers to which you are connecting. | `https://couchbase.server` |
| [`UseSSL` ↗](https://cdn.cdata.com/help/CKK/jdbc/RSBCouchbase_p_UseSSL.htm) | Mandatory | Whether to negotiate TLS/SSL when connecting to the Couchbase server. | `TRUE` |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| \<Server> | If `ConnectionMode=Direct` (Default); Server connection property. Can be an IP address or HTTP/S URL. Can accept multiple URLs |
| \<DNSServer> | If `ConnectionMode=Cloud,` DNS Server is used to look up server addresses (default port 53, port can be passed with \<Server>:\<Port>, but is not required) |
| \<N1QLPort> | If `ConnectionMode=Direct` and `CouchbaseServer=N1QL,` Port defaults to 18093 for SSL and 8093 when not SSL |
| \<AnalyticsPort> | If `ConnectionMode=Direct` and `CouchbaseServer=Analytics,` Port defaults to 18095 w/ SSL and 8095 w/o SSL |
| \<WebConsolePort> | If `ConnectionMode=Direct,` Port defaults to 18091 w/ SSL and 8091 w/o SSL |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->