The Couchbase connector is a Palantir-provided driver for Couchbase.
To create a new Couchbase source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Couchbase-specific configuration and networking. For the complete property reference, see the official Couchbase driver documentation ↗.
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ | Mandatory | The type of authentication to use when connecting to Couchbase. | Basic |
ConnectionMode ↗ | Mandatory | Determines how to connect to the Couchbase server. Must be either Direct or Cloud. | Cloud |
CouchbaseService ↗ | Mandatory | Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics. | Analytics |
DNSServer ↗ | Mandatory | Determines what DNS server to use when retrieving Couchbase Capella information. | 8.8.8.8 |
Server ↗ | Mandatory | The address of the Couchbase server or servers to which you are connecting. | https://couchbase.server |
UseSSL ↗ | Mandatory | Whether to negotiate TLS/SSL when connecting to the Couchbase server. | TRUE |
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy 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 |