Couchbase Configuration

Full details can be found in the CouchbaseConfig API Reference.

Currently, a minimal set of configuration options for the Cluster bean is provided.

Required:

These config items do not default to placeholder values, and are required to be set in application.properties.

  • quarkus.couchbase.connection-string

    • String: Examples localhost, couchbase://127.0.0.1.

  • quarkus.couchbase.username

    • String: The username to authenticate with.

  • quarkus.couchbase.password

    • String: The password to authenticate with.

Optional

These config items have default values, but can be overridden in application.properties.

  • quarkus.couchbase.metrics.enabled

    • Boolean: Enable or disable Micrometer metrics.

    • Default: false

  • quarkus.couchbase.metrics.emit-interval

    • Seconds: The interval at which metrics are emitted.

    • Default: 600 (10min)

  • quarkus.couchbase.preferredServerGroup

    • String: The preferred server group for operations which support it.

    • Default: None

  • quarkus.couchbase.health.enabled

    • Boolean: Enable or disable SmallRye health checks (Readiness check).

    • Default: true

  • quarkus.couchbase.health.readiness.timeout

    • Seconds: The timeout for the extension’s Readiness health check.

    • Default: 3

Security

Refer to the Couchbase Java SDK Documentation for further details on security options. All the following options use the underlying Couchbase Java SDK’s default values if unset.

  • quarkus.couchbase.security.enableTls

    • Boolean: Enable or disable TLS.

  • quarkus.couchbase.security.enableHostnameVerification

    • Boolean: Enable or disable hostname verification when validating the remote certificate.

  • quarkus.couchbase.security.enableNativeTls

    • Boolean: Enable or disable netty native TLS (OpenSSL) used for better performance.

  • quarkus.couchbase.security.ciphers

    • String: A comma-separated list of cipher suites to enable.

  • quarkus.couchbase.security.trustCertificate

    • String: A path to a single PEM-encoded certificate file.