Determines how to connect to the Couchbase server. Must be either Direct or Cloud.

Possible Values

Data Type

string

Default Value

"Direct"

Remarks

By default the driver connects to Couchbase directly using the address given in the Server option. The Server must be running the appropriate CouchbaseService to accept the connection. This will work in most on-premise or basic cloud deployments.

This should be set to Cloud when connecting to Couchbase Capella or a custom deployment that uses service records. These records will allow the driver to determine the exact Couchbase servers that provide the appropriate CouchbaseService. You must also set the DNSServer property so that the driver is able to fetch these service records.

Note that enabling Cloud mode will override these connection properties with the values discovered by contacting the cluster:

• Server
• N1QLPort
• AnalyticsPort