Client Settings

Default: nil

Set this to the authenticator you wish to use to authenticate with the server. Possible options which are included in the SDK include the PasswordAuthenticator and CertificateAuthenticator.

Default: nil / nil

Username and Password provide a shortcut to creating a PasswordAuthenticator which is then used as an Authenticator for connecting to the Cluster.

Default: JSONTranscoder{}

Transcoder specifies the transcoding behaviour that is required of the application. By default this is configured as a JSONTranscoder, which will encode all values through the standard Go JSON marshalling facilities.

Default: BestEffortRetryStrategy{}

The retry strategy decides if an operation should be retried or canceled. While implementing a custom strategy is fairly advanced, the SDK ships with a best effort retry strategy out of the box (BestEffortRetryStrategy). This default will retry the operation until it either succeeds or the maximum request lifetime is reached.

Default: true

From Couchbase 7.0, Out-of-Order execution allows the server to concurrently handle multiple requests on the same connection, potentially improving performance for durable writes and multi-document ACID transactions. This means that tuning the number of connections (KV endpoints) is no longer necessary as a workaround where data not available in the cache is causing timeouts.

Note, this can only be specified through the query string.

This is set to true by default. Note, changing the setting will only affect Server versions 7.0 onwards.

Default: nil

TLSRootCAs enables the specification of the Root Certificate’s to use when validating a server certificate on the client-side.

Default: false

This is an advanced option which can be used to disable TLS certificate validation. This will disable any form of server validation, but will still encrypt the data being settings between the SDK and the server. This option is intended strictly for use on older versions of Couchbase Server where strict validation was not possible.

Default: false

Specifies whether orphan reporting should be disabled.

Default: 10s

Specifies the duration between reporting of orphaned responses.

Default: 10

Specifies the number of samples of orphan responses that should be stored between reports.

Default: false

…​

Default: 20

The volume threshold defines how many operations must be in the window before the threshold percentage can be meaningfully calculated.

Default: 50

The percentage of operations in a window that may fail before the circuit is opened. The value is an integer in the range [0,100].

Default: 5s

The delay between when the circuit opens and when the canary is tried.

Default: 1m

How long the window is in which the number of failed ops are tracked in a rolling fashion.

Default: 5s

The period of time which canary operations are permitted to take before they are marked as a failure.

Default: 10s

The connect timeout is used when a Bucket is opened and if not overridden by a custom timeout. If you feel the urge to change this value to something higher, there is a good chance that your network is not properly set up. Connecting to the server should in practice not take longer than a second on a reasonably fast network.

Default: 2.5s

The Key/Value default timeout is used on operations which are performed on a specific key if not overridden by a custom timeout. This includes all commands like get(), getFromReplica() and all mutation commands, but does not include operations that are performed with enhanced durability requirements.

Default: 10s

Key/Value operations with enhanced durability requirements may take longer to complete, so they have a separate default timeout.

Do not set this above 65s, which is the maximum possible SyncWrite timeout on the Server side.

Default: 75s

The View timeout is used on view operations if not overridden by a custom timeout. Note that it is set to such a high timeout compared to key/value since it can affect hundreds or thousands of rows. Also, if there is a node failure during the request the internal cluster timeout is set to 60 seconds.

Default: 75s

The Query timeout is used on all SQL++ (formerly N1QL) query operations if not overridden by a custom timeout. Note that it is set to such a high timeout compared to key/value since it can affect hundreds or thousands of rows.

Default: 75s

The Analytics timeout is used on all Analytics query operations if not overridden by a custom timeout. Note that it is set to such a high timeout compared to key/value since it can affect hundreds or thousands of rows.

Default: 75s

The Search timeout is used on all FTS operations if not overridden by a custom timeout. Note that it is set to such a high timeout compared to key/value since it can affect hundreds or thousands of rows.

Default: 75s

The management timeout is used on all cluster management APIs (BucketManager, UserManager, CollectionManager, QueryIndexManager, etc.) if not overridden by a custom timeout. The default is quite high because some operations (such as flushing a bucket, for example) might take a long time.

Default: 5s

The server_wait_backoff is used across a cluster as the period of time waited between key/value reconnect attempts to a node after a connection failure occurs.

Note, this can only be specified through the connection string.

== IO Options

Default: false

This is an advanced option which will disable the inclusion of mutation tokens in operation responses from the server. This should generally not be set.

Default: false

This is an advanced option which will disable the inclusion of server processing times in operation responses from the server. This should generally not be set.