Sink Configuration Options

Addresses of Couchbase Server nodes, delimited by commas.

If a custom port is specified, it must be the KV port (which is normally 11210 for insecure connections, or 11207 for secure connections).

Name of the Couchbase user to authenticate as.

Password of the Couchbase user.

May be overridden with the KAFKA_COUCHBASE_PASSWORD environment variable.

Name of the Couchbase bucket to use.

This property is required unless using the experimental AnalyticsSinkHandler.

The network selection strategy for connecting to a Couchbase Server cluster that advertises alternate addresses.

A Couchbase node running inside a container environment (like Docker or Kubernetes) might be configured to advertise both its address within the container environment (known as its "default" address) as well as an "external" address for use by clients connecting from outside the environment.

Setting the 'couchbase.network' config property to 'default' or 'external' forces the selection of the respective addresses. Setting the value to 'auto' tells the connector to select whichever network contains the addresses specified in the 'couchbase.seed.nodes' config property.

On startup, the connector will wait this long for a Couchbase connection to be established. If a connection is not established before the timeout expires, the connector will terminate.

Use secure connection to Couchbase Server.

If true, you must also tell the connector which certificate to trust. Specify a certificate file with 'couchbase.trust.certificate.path', or a Java keystore file with 'couchbase.trust.store.path' and 'couchbase.trust.store.password'.

Set this to false to disable TLS hostname verification for Couchbase connections. Less secure, but might be required if for some reason you can’t issue a certificate whose Subject Alternative Names match the hostname used to connect to the server. Only disable if you understand the impact and can accept the risks.

Absolute filesystem path to the Java keystore holding the CA certificate used by Couchbase Server.

If you want to use a PEM file instead of a Java keystore, specify couchbase.trust.certificate.path instead.

Password for accessing the trust store.

May be overridden with the KAFKA_COUCHBASE_TRUST_STORE_PASSWORD environment variable.

Absolute filesystem path to the PEM file containing the CA certificate used by Couchbase Server.

If you want to use a Java keystore instead of a PEM file, specify couchbase.trust.store.path instead.

Absolute filesystem path to a Java keystore or PKCS12 bundle holding the private key and certificate chain to use for client certificate authentication (mutual TLS).

If you supply a value for this config property, the couchbase.username and couchbase.password properties will be ignored.

Password for accessing the client certificate.

May be overridden with the KAFKA_COUCHBASE_CLIENT_CERTIFICATE_PASSWORD environment variable.

Determines which kinds of sensitive log messages from the Couchbase connector will be tagged for later redaction by the Couchbase log redaction tool. NONE = no tagging; PARTIAL = user data is tagged; FULL = user, meta, and system data is tagged.

If true, document lifecycle milestones will be logged at INFO level instead of DEBUG. Enabling this feature lets you watch documents flow through the connector. Disabled by default because it generates many log messages.

The connector writes metrics to the log at this interval.

Disable metric logging by setting this to 0.

UNCOMMITTED; this feature may change in a patch release without notice.

Qualified name (scope.collection or bucket.scope.collection) of the destination collection for messages from topics that don’t have an entry in the couchbase.topic.to.collection map.

If the bucket component contains a dot, escape it by enclosing it in backticks.

If the bucket component is omitted, it defaults to the value of the couchbase.bucket property.

A map from Kafka topic to Couchbase collection.

Topic and collection are joined by an equals sign. Map entries are delimited by commas.

A collection name is of the form bucket.scope.collection or scope.collection. If the bucket component is omitted, it defaults to the value of the couchbase.bucket property. If the bucket component contains a dot, escape it by enclosing it in backticks.

For example, if you want to write messages from topic "topic1" to collection "scope-a.invoices" in the default bucket, and messages from topic "topic2" to collection "scope-a.widgets" in bucket "other-bucket" you would write: "topic1=scope-a.invoices,topic2=other-bucket.scope-a.widgets".

Defaults to an empty map, with all documents going to the collection specified by couchbase.default.collection.

A map of per-topic overrides for the couchbase.document.id configuration property.

Topic and document ID format are joined by an equals sign. Map entries are delimited by commas.

For example, if documents from topic "topic1" should be assigned document IDs that match their "id" field, and documents from topic "topic2" should be assigned documents IDs that match their "identifier" field, you would write: "topic1=${/id},topic2=${/identifier}".

Defaults to an empty map, which means the value of the couchbase.document.id configuration property is applied to documents from all topics.

UNCOMMITTED; this feature may change in a patch release without notice.

The fully-qualified class name of the sink handler to use. The sink handler determines how the Kafka record is translated into actions on Couchbase documents.

The built-in handlers are: com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler, com.couchbase.connect.kafka.handler.sink.N1qlSinkHandler, and com.couchbase.connect.kafka.handler.sink.SubDocumentSinkHandler.

You can customize the sink connector’s behavior by implementing your own SinkHandler.

Overrides the couchbase.sink.handler property.

A value of N1QL forces the handler to com.couchbase.connect.kafka.handler.sink.N1qlSinkHandler. A value of SUBDOCUMENT forces the handler to com.couchbase.connect.kafka.handler.sink.SubDocumentSinkHandler.

Format string to use for the Couchbase document ID (overriding the message key). May refer to document fields via placeholders like ${/path/to/field}

Whether to remove the ID identified by 'couchbase.documentId' from the document before storing in Couchbase.

Document expiration time specified as an integer followed by a time unit (s = seconds, m = minutes, h = hours, d = days). For example, to have documents expire after 30 minutes, set this value to "30m".

A value of "0" (the default) means documents never expire.

Retry failed writes to Couchbase until this deadline is reached. If time runs out, the connector terminates.

A value of 0 (the default) means the connector will terminate immediately when a write fails.

The preferred way to specify an enhanced durability requirement when using Couchbase Server 6.5 or later.

The default value of NONE means a write is considered successful as soon as it reaches the memory of the active node.

For Couchbase Server versions prior to 6.5, this is how you require the connector to verify a write is persisted to disk on a certain number of replicas before considering the write successful.

If you’re using Couchbase Server 6.5 or later, we recommend using the couchbase.durability property instead.

For Couchbase Server versions prior to 6.5, this is how you require the connector to verify a write has reached the memory of a certain number of replicas before considering the write successful.

If you’re using Couchbase Server 6.5 or later, we recommend using the couchbase.durability property instead.

The type of update to use when couchbase.sink.handler is set to com.couchbase.connect.kafka.handler.sink.N1qlSinkHandler.

This property is specific to N1qlSinkHandler.

When using the UPDATE_WHERE operation, this is the list of document fields that must match the Kafka message in order for the document to be updated with the remaining message fields. To match against a literal value instead of a message field, use a colon to delimit the document field name and the target value. For example, "type:widget,color" matches documents whose 'type' field is 'widget' and whose 'color' field matches the 'color' field of the Kafka message.

This property is specific to N1qlSinkHandler.

Controls whether to create the document if it does not exist.

This property is specific to N1qlSinkHandler.

Every Batch consists of an UPSERT or a DELETE statement, based on mutations. This property determines the maximum number of records in the UPSERT or DELETE statement in the batch. Users can configure this parameter based on the capacity of their analytics cluster.

This property is specific to AnalyticsSinkHandler.

UNCOMMITTED; this feature may change in a patch release without notice.

Every Batch consists of an UPSERT or a DELETE statement, based on mutations. This property defines the max size of all docs in bytes in an UPSERT statement in a batch. Users can configure this parameter based on the capacity of their analytics cluster.

This property is specific to AnalyticsSinkHandler.

UNCOMMITTED; this feature may change in a patch release without notice.

This property determines the time period after which client cancels the Query request for Analytics.

This property is specific to AnalyticsSinkHandler.

UNCOMMITTED; this feature may change in a patch release without notice.

JSON Pointer to the property of the Kafka message whose value is the subdocument path to use when modifying the Couchbase document.

This property is specific to SubDocumentSinkHandler.

Setting to indicate the type of update to a sub-document.

This property is specific to SubDocumentSinkHandler.

Whether to add the parent paths if they are missing in the document.

This property is specific to SubDocumentSinkHandler.

This property controls whether to create the document if it does not exist.

This property is specific to SubDocumentSinkHandler.

Any system property recognized by the Couchbase Java SDK may be specified in the Sink connector config if you omit the com. prefix from the system property name.

For example, the Couchbase Java SDK recognizes the system property com.couchbase.env.timeout.kvTimeout. To specify this setting in the connector config, use the property name couchbase.env.timeout.kvTimeout.

For a list of recognized properties, see Java SDK Client Settings.

UNCOMMITTED; this feature may change in a patch release without notice.

Parent topic: Kafka Connector

Previous topic: Source Configuration Options

Next topic: Couchbase Sample with Kafka Streams