<a id="cc-couchbase-sink"></a>

# Couchbase Sink Connector for Confluent Cloud

The fully managed Couchbase Sink connector for Confluent Cloud maps and persists
events from Apache Kafka® topics directly to a Couchbase database collection. The
connector supports AVRO, BYTES, JSON Schema, PROTOBUF, or JSON (schemaless) data from
Apache Kafka® topics. The connector ingests events from Kafka topics directly into a
Couchbase database, exposing the data to services for querying, enrichment,
and analytics.

#### NOTE
If you require private networking for fully managed connectors, make sure to set up the proper
networking beforehand. For more information, see [Manage Networking for Confluent Cloud Connectors](../networking/internet-resource.md#clusters-connect-cloud).

## Features

The connector provides the following features:

* **At least once delivery**: The connector guarantees that records are written at least once to Couchbase
  unless the record is intentionally discarded by a custom sink handler.
* **Database authentication:** Uses password authentication.
* **Client-side encryption (CSFLE and CSPE) support**: The connector supports CSFLE and CSPE for sensitive data.
  For more information about CSFLE or CSPE setup, see the [connector configuration](#cc-couchbase-sink-setup-connection).
* **Input data formats:** The connector supports AVRO, BYTES, JSON_SR, PROTOBUF, or JSON (schemaless)
  input data formats. [Schema Registry](../../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format
  (for example, AVRO, JSON_SR (JSON Schema), or PROTOBUF).
* **Select sink behavior:**
  - `"couchbase.default.collection"`: Specifies the default Couchbase collection for records from Kafka topics not explicitly mapped.
  - `"couchbase.topic.to.collection"`: Provides granular data routing by mapping specific Kafka topics to Couchbase collections.
  - `"couchbase.topic.to.document.id"`: Enables per-topic overrides for Couchbase document ID formatting.
  - `"couchbase.sink.handler"`: Defines how Kafka records are transformed into actions on Couchbase documents, supporting
    built-in and custom handlers.

  For details about all property values and definitions, see [Configuration Properties](#cc-couchbase-sink-config-properties).

For more information and examples to use with the Confluent Cloud API for Connect,
see the [Confluent Cloud API for Connect Usage Examples](../connect-api-section.md#ccloud-connect-api) section.

## Limitations

Be sure to review the following information.

* For connector limitations, see [Couchbase Sink](../limits.md#cc-couchbase-db-sink-limits) limitations.
* If you plan to use one or more Single Message Transformations (SMTs), see [SMT Limitations](../single-message-transforms.md#cc-single-message-transforms-limitations).

## Quick Start

Use this quick start to get up and running with the Confluent Cloud Couchbase Sink
connector. The quick start provides the basics of selecting the connector and
configuring it to consume data from Kafka and persist the data to a Couchbase
database.

<a id="cc-couchbase-sink-prereqs"></a>

Prerequisites
: - Authorized access to a [Confluent Cloud](https://www.confluent.io/confluent-cloud/) cluster
    on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud.
  - The Confluent CLI installed and configured for the cluster. For more information, see [Install the Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html).
  - [Schema Registry](../../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, AVRO, JSON_SR (JSON Schema), or PROTOBUF).
  - Access to a Couchbase database.
  - The Couchbase database service endpoint and the Kafka cluster must be in the
    same region.
  - For networking considerations, see [Networking and DNS](../overview.md#connect-internet-access-resources). To use a set of public egress IP
    addresses, see [Public Egress IP Addresses for Confluent Cloud Connectors](../static-egress-ip.md#cc-static-egress-ips).
  - If you have a VPC-peered cluster in Confluent Cloud, consider configuring a
    [PrivateLink Connection](https://docs.atlas.mongodb.com/security-private-endpoint/#configure-an-service-private-endpoint)
    between Couchbase and the VPC.
  <br/>
  - Kafka cluster credentials. The following lists the different ways you can provide credentials.
    - Enter an existing [service account](../service-account.md#s3-cloud-service-account) resource ID.
    - Create a Confluent Cloud [service account](../service-account.md#s3-cloud-service-account) for the connector. Make sure to review the ACL entries required in the [service account documentation](../service-account.md#s3-cloud-service-account). Some connectors have specific ACL requirements.
    - Create a Confluent Cloud API key and secret. To create a key and secret, you can use [confluent api-key create](https://docs.confluent.io/confluent-cli/current/command-reference/api-key/confluent_api-key_create.html) *or* you can autogenerate the API key and secret directly in the Cloud Console when setting up the connector.

### Using the Confluent Cloud Console

#### Step 1: Launch your Confluent Cloud cluster

To create and launch a Kafka cluster in Confluent Cloud, see [Create a kafka cluster in Confluent Cloud](../../get-started/index.md#cloud-create-kafka-cluster).

#### Step 2: Add a connector

In the left navigation menu, click **Connectors**. If you already have connectors in your cluster, click **+ Add
connector**.

#### Step 3: Select your connector

Click the **Couchbase Sink** connector card.

![Couchbase Sink Connector Card](images/ccloud-couchbase-sink-icon.png)

<a id="cc-couchbase-sink-setup-connection"></a>

#### Step 4: Enter the connector details

#### NOTE
* Ensure you have all your [prerequisites](#cc-couchbase-sink-prereqs) completed.
* An asterisk ( \* ) designates a required entry.

At the **Add Couchbase DB Sink Connector** screen, complete the following:

### Topic selection

If you’ve already populated your Kafka topics, select the topics you want
to connect from the **Topics** list.

To create a new topic, click **+Add new topic**.

### Kafka access

1. Select the way you want to provide **Kafka Cluster credentials**. You can
   choose one of the following options:
   - **My account**: This setting allows your connector to globally access everything
     that you have access to. With a user account, the connector uses an API key and
     secret to access the Kafka cluster. This option is not recommended for production.
   - **Service account**: This setting limits the access for your connector by using a
     [service account](../service-account.md#s3-cloud-service-account). This option is recommended for
     production.
   - **Use an existing API key**: This setting allows you to specify an API key and a
     secret pair. You can use an existing pair or create a new one. This method is not
     recommended for production environments.

   #### NOTE
   Freight clusters support only service accounts for Kafka authentication.
2. Click **Continue**.

### Authentication

1. Configure the authentication properties:

   **Connection**
   - **Couchbase Seed Nodes**: A comma-separated addresses of Couchbase Server nodes.
     If a custom port is specified, it must be the KV port (which is normally `11210` for
     insecure connections, or `11207` for secure connections).
   - **Couchbase Username**: The name of the Couchbase user connecting to the Couchbase database.
   - **Couchbase Password**: The password of the Couchbase user connecting to the Couchbase database.
   - **Couchbase Bucket**: Name of the Couchbase bucket to use. This property is required
     unless using the experimental `AnalyticsSinkHandler`.
2. Click **Continue**.

### Configuration

#### NOTE
See [Configuration Properties](#cc-couchbase-sink-config-properties) for all property values
and definitions.

- **Input Kafka record value format**: Select the input Kafka record value format (data coming from the
  Kafka topic). Valid entires are AVRO, BYTES, JSON_SR (JSON Schema), PROTOBUF, or JSON (schemaless).
  A valid schema must be available in [Schema Registry](../../get-started/schema-registry.md#cloud-sr-config) to use a schema-based message
  format (for example, AVRO, JSON_SR, or PROTOBUF).

**Sink Behavior**

- **Default Collection**: Qualified name (`scope.collection` or `bucket.scope.collection`) of the destination
  collection for messages from topics that do not 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.
  * Default value: `_default._default`.
- **Topic to Collection Map**: A comma-delimited map from Kafka topic to Couchbase collection. Topic and
  collection are joined by an equals sign (=). 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. Defaults to an empty map, with all documents going to the collection specified by
  the `couchbase.default.collection` property.

  For example, if you want to write messages from topic `topic1` to collection `scope-a.invoices`
  in the default bucket, and `topic2` to collection `scope-a.widgets` in bucket `other-bucket`, you would write
  `topic1=scope-a.invoices,topic2=other-bucket.scope-a.widgets`.
- **Topic to Document ID Map**: A comma-delimited map of per-topic overrides for the `couchbase.document.id` configuration
  property. Topic and document ID format are joined by an equals sign (=). Defaults to an empty map,
  which means the `couchbase.document.id` property applies to documents from all topics.

  For example, if documents from topic **topic1** should match their **id** field, and documents
  from topic **topic2** should match their **identifier** field, you would write `topic1=${/id},topic2=${/identifier}`.
- **Sink Handler Class**: The fully-qualified class name of the sink handler to use. The 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`
  * `com.couchbase.connect.kafka.handler.sink.SubDocumentSinkHandler`

  You can customize the sink connector’s behavior by implementing your own `SinkHandler`.
  Default_value is `com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler`.
- **Document ID**: Format string for the Couchbase document ID. This overrides the message key. This may refer to document fields via placeholders, for example, `${/path/to/field}`.
- **Remove Document ID**: Whether to remove the ID identified by `couchbase.documentId` from the document before storing in Couchbase. Default value is `false`.
- **Document Expiration**: Document expiration time, specified as an integer followed by
  a time unit (s = seconds, m = minutes, h = hours, d = days). For example, set this value
  to `30m` to have documents expire after 30 minutes. Default value is `0` that means documents never expire
- **Retry Timeout**: Time limit for retrying failed writes to Couchbase. If this deadline is
  reached, the connector terminates. This retry timeout is distinct from the KV timeout
  (set via `couchbase.env.*`), which affects individual write attempts. The retry timeout
  spans multiple attempts, making the connector resilient to transient failures. Do not confuse
  this with the Kafka Connect framework’s built-in `errors.retry.timeout` property, which
  applies only to failures occurring before the framework delivers the record to the Couchbase
  connector. Default value is `0` that means the connector terminates immediately on a write failure.
- **N1QL Operation**: 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.
- **N1QL Where Fields**: 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.
- **N1QL Create Document**: Controls whether to create the document if it does not exist. This property is specific to N1qlSinkHandler.
- **SubDocument Path**: 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.
- **SubDocument Operation**: Setting to indicate the type of update to a sub-document. This property is specific to SubDocumentSinkHandler.
- **SubDocument Create Path**: Whether to add the parent paths if they are missing in the document. This property is specific to SubDocumentSinkHandler.
- **SubDocument Create Document**: This property controls whether to create the document if it does not exist. This property is specific to SubDocumentSinkHandler.

**Durability**

- **Durability**: The preferred way to specify an enhanced durability requirement when using
  Couchbase Server `6.5` or later.
  * If you set this to anything other than `NONE`, then you must not set `couchbase.persist.to`
    or `couchbase.replicate.to` property.
  * Default value is `NONE` that means a write is successful as soon as it reaches the memory of the active node.
- **Persist To**: Default value is `NONE`.
  * For Couchbase Server versions prior to `6.5`, this property specifies that the connector must
    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, Confluent recommends
    using the `couchbase.durability` property instead.
- **Replicate To**: Default value is `NONE`.
  * For Couchbase Server versions prior to `6.5`, this property specifies that the
    connector must 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, Confluent recommends
    using the `couchbase.durability` property instead.

**Analytics Sink Handler**

- **Max Records in Batch**: 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. Since: 4.1.14
- **Max Size in Batch**: 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. Since: 4.2.0
- **Query Timeout**: 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. Since: 4.2.0

**Data decryption**

- Enable **Client-Side Field Level Encryption** for
  data decryption. Specify a **Service Account** to
  access the Schema Registry and associated encryption rules or keys with that schema. Select the connector behavior
  (`ERROR` or `NONE`) on data decryption failure. If set to `ERROR`, the connector fails and writes the encrypted data
  in the DLQ. If set to `NONE`, the connector writes the encrypted data in the target system without decryption.
  For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](../csfle.md#connect-csfle).

### **Show advanced configurations**

- **Schema context**: Select a schema context to use for this connector, if using
  a schema-based data format. This property defaults to the **Default** context,
  which configures the connector to use the default schema set up for Schema Registry in your
  Confluent Cloud environment. A schema context allows you to use separate schemas (like
  schema sub-registries) tied to topics in different Kafka clusters that share the
  same Schema Registry environment. For example, if you select a non-default context, a
  **Source** connector uses only that schema context to register a schema and a
  **Sink** connector uses only that schema context to read from. For more
  information about setting up a schema context, see [What are schema contexts and when should you use them?](../../sr/faqs-cc.md#faq-schema-contexts).
- **Input Kafka record key format**: Sets the input Kafka record key format. Valid entries are AVRO, BYTES, JSON, JSON_SR, PROTOBUF, or STRING. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF

**Additional Configs**

- **Value Converter Replace Null With Default**: Specifies whether to replace fields that have a default value and that are null to the default value. When set to `true`, the connector uses the default value; otherwise, it uses `null`. Applies to the `JSON` converter.
- **Value Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for values. The deserializer reads schema IDs from message headers.
- **Value Converter Reference Subject Name Strategy**: Sets the subject reference name strategy for values. Valid entries are `DefaultReferenceSubjectNameStrategy` or `QualifiedReferenceSubjectNameStrategy`. You can use this strategy only with `PROTOBUF` format; the default strategy is `DefaultReferenceSubjectNameStrategy`.
- **Schema ID For Value Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Value Converter Schemas Enable**: Includes schema within each of the serialized values. Input messages must contain `schema` and `payload` fields and must not contain additional fields. For plain `JSON` data, set this to `false`. Applies to the `JSON` converter.
- **Errors Tolerance**: Use this property to configure the connector’s error handling behavior.

  #### WARNING
  Use this property with caution for sink connectors, as it can lead to data loss. If you set this property to `all`, the connector does not fail on errant records, but logs them (and sends to DLQ for sink connectors) and continues processing. If you set this property to `none`, the connector task fails on errant records.
- **Value Converter Ignore Default For Nullables**: When set to `true`, this property ensures that the corresponding record in Kafka is `null`, instead of showing the default column value. Applies to the `AVRO`, `PROTOBUF`, and `JSON_SR` converters.
- **Key Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for keys. The deserializer reads schema IDs from message headers.
- **Value Converter Decimal Format**: Specifies the `JSON` or `JSON_SR` serialization format for Connect `DECIMAL` logical type values with two allowed literals:
  `BASE64` to serialize `DECIMAL` logical types as base64 encoded binary data, and
  `NUMERIC` to serialize `DECIMAL` logical type values in `JSON` or `JSON_SR` as a number representing the decimal value.
- **Schema GUID For Key Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Schema GUID For Value Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Value Converter Connect Meta Data**: Enables the Connect converter to add its metadata to the output schema. Applies to Avro converters.
- **Value Converter Value Subject Name Strategy**: Determines how to construct the subject name under which the value schema is registered with Schema Registry.
- **Key Converter Key Subject Name Strategy**: Determines how to construct the subject name for key schema registration.
- **Schema ID For Key Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.

**Auto-restart policy**

- **Enable Connector Auto-restart**: Enables the auto-restart behavior of the connector and its
  task in the event of user-actionable errors. Defaults to `true`, enabling the connector to
  automatically restart in case of user-actionable errors. Set this property to `false` to
  disable auto-restart for failed connectors. If disabled, you must manually restart the connector.

**Consumer configuration**

- **Max poll interval(ms)**: Sets the maximum delay between subsequent consume requests to Kafka. Use this property to
  improve connector performance in cases when the connector cannot send records to the sink system.
  The default is 300,000 milliseconds (5 minutes).
- **Max poll records**: Sets the maximum number of records to consume from Kafka in a single request. Use this property to
  improve connector performance in cases when the connector cannot send records to the sink system.
  The default is 500 records.

**Transforms**

- **Single Message Transformations**: To add a new SMT, see [Add transforms](../single-message-transforms.md#cc-single-message-transforms-ui).
  For more information about unsupported SMTs, see
  [Unsupported transformations](../single-message-transforms.md#cc-single-message-transforms-unsupported-transforms).

**Processing position**

- **Set offsets**: Click **Set offsets** to define a specific offset for
  this connector to begin procession data from. For more information
  on managing offsets, see [Manage offsets](../offsets.md#connect-custom-offsets).

See [Configuration Properties](#cc-couchbase-sink-config-properties) for all property
values and definitions.

- Click **Continue**.

### Sizing

Based on the number of topic partitions you select, you will be provided
with a recommended number of tasks. One task can handle up to 100
partitions.

1. To change the number of recommended tasks, enter the number of
   [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use in
   the **Tasks** field.
2. Click **Continue**.

### Review and launch

1. Verify the connection details by previewing the running configuration.
2. After you’ve validated that the properties are configured to your
   satisfaction, click **Launch**.
3. Verify the connection details and click **Launch**.

   The status for the connector should go from **Provisioning** to
   **Running**. It may take a few minutes.

#### Step 5: Check Couchbase database

After the connector is running, verify that messages are being added to your Couchbase database.

### Using the Confluent CLI

Complete the following steps to set up and run the connector using the Confluent CLI.

#### NOTE
Make sure you have all your [prerequisites](#cc-couchbase-sink-prereqs) completed.

#### Step 1: List the available connectors

Enter the following command to list available connectors:

```none
confluent connect plugin list
```

#### Step 2: List the connector configuration properties

Enter the following command to show the connector configuration properties:

```none
confluent connect plugin describe <connector-plugin-name>
```

The command output shows the required and optional configuration properties.

#### Step 3: Create the connector configuration file

Create a JSON file that contains the connector configuration properties. The following example shows the
required connector properties.

```json
{
    "connector.class": "CouchbaseSink",
    "name": "CouchbaseSinkConnector_0",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "<my-kafka-api-key",
    "kafka.api.secret": "<my-kafka-api-secret>",
    "input.data.format" : "JSON",
    "couchbase.seed.nodes": "<couchbase-node-address>",
    "couchbase.bucket": "<bucket-name>",
    "topics": "dlq-bcc-devcjd1abc",
    "couchbase.username": "<database-username>",
    "couchbase.password": "<database-password>",
    "couchbase.default.collection": "_default._default",
    "couchbase.sink.handler": "com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler",
    "couchbase.remove.document.id": "false",
    "couchbase.document.expiration": "0",
    "couchbase.retry.timeout": "0",
    "couchbase.durability": "NONE",
    "couchbase.persist.to": "NONE",
    "couchbase.replicate.to": "NONE",
    "tasks.max": "1"
}
```

Note the following property definitions:

* `"connector.class"`: Identifies the connector plugin name.
* `"name"`: Sets a name for your new connector.

* `"kafka.auth.mode"`: Identifies the connector authentication mode you want to use. There are two options: `SERVICE_ACCOUNT` or `KAFKA_API_KEY` (the default). To use an API key and secret, specify the configuration properties `kafka.api.key` and `kafka.api.secret`, as shown in the example configuration (above).  To use a [service account](../service-account.md#s3-cloud-service-account), specify the **Resource ID** in the property `kafka.service.account.id=<service-account-resource-ID>`. To list the available service account resource IDs, use the following command:
  ```bash
  confluent iam service-account list
  ```

  For example:
  ```bash
  confluent iam service-account list

     Id     | Resource ID |       Name        |    Description
  +---------+-------------+-------------------+-------------------
     123456 | sa-l1r23m   | sa-1              | Service account 1
     789101 | sa-l4d56p   | sa-2              | Service account 2
  ```

* `"input.data.format"`:  Sets the input Kafka record value format (data coming from the Kafka topic).
  Valid entires are AVRO, BYTES, JSON_SR (JSON Schema), PROTOBUF, or JSON (schemaless). You must
  have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, AVRO, JSON_SR (JSON Schema), or PROTOBUF).
* `"couchbase.seed.nodes"`: A comma-separated addresses of Couchbase Server nodes.
  If a custom port is specified, it must be the KV port (which is normally `11210` for
  insecure connections, or `11207` for secure connections).
* `"couchbase.bucket"`: Name of the Couchbase bucket to use. This property is required
  unless using the experimental `AnalyticsSinkHandler`.
* `"couchbase.username"`: The name of the Couchbase user connecting to the Couchbase database.
* `"couchbase.password"`: The password of the Couchbase user connecting to the Couchbase database.
* `"couchbase.sink.handler"`: The sink handler determines how the Couchbase document is converted
  into a Kafka record. When using a custom sink handler that filters out certain messages, consider
  also configuring `couchbase.black.hole.topic` property.
* Enter the number of [tasks](/platform/current/connect/concepts.html#tasks) for the connector. For more information,
  see Confluent Cloud [connector limitations](../limits.md#cc-couchbase-db-sink-limits).

#### NOTE
To enable CSFLE or CSPE for data encryption, specify the following properties:

* `csfle.enabled`: Flag to indicate whether the connector honors CSFLE or CSPE rules.
* `sr.service.account.id`: A Service Account to access the Schema Registry and associated encryption rules or keys with that schema.
* `csfle.onFailure`: Configures the connector behavior (`ERROR` or `NONE`) on data decryption failure.
  If set to `ERROR`, the connector fails and writes the encrypted data
  in the DLQ. If set to `NONE`, the connector writes the encrypted data in the target system without decryption.

When using CSFLE or CSPE with connectors that route failed messages to a Dead Letter Queue (DLQ),
be aware that data sent to the DLQ is written in unencrypted plaintext. This poses
a significant security risk as sensitive data that should be encrypted may be exposed in the DLQ.

Do not use DLQ with CSFLE or CSPE in the current version. If you need error handling for
CSFLE- or CSPE-enabled data, use alternative approaches such as:

* Setting the connector behavior to `ERROR` to throw exceptions instead of routing to DLQ
* Implementing custom error handling in your applications
* Using `NONE` to pass encrypted data through without decryption

For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](../csfle.md#connect-csfle).

**SMTs**: For more information about adding SMTs using the Confluent CLI,
see [Single Message Transformations](../single-message-transforms.md#cc-single-message-transforms) documentation.

See [Configuration Properties](#cc-couchbase-sink-config-properties) for all property values and
definitions.

#### Step 4: Load the properties file and create the connector

Enter the following command to load the configuration and start the connector:

```none
confluent connect cluster create --config-file <file-name>.json
```

For example:

```none
confluent connect cluster create --config-file CouchbaseSink.json
```

Example output:

```none
Created connector confluent-CouchbaseSink lcc-ix4dl
```

#### Step 5: Check the connector status

Enter the following command to check the connector status:

```none
confluent connect cluster list
```

Example output:

```none
ID          |            Name         | Status  | Type
+-----------+-------------------------+---------+------+
lcc-ix4dl   | confluent-CouchbaseSink | RUNNING | sink
```

#### Step 6: Check Couchbase

After the connector is running, verify that records are populating your Couchbase database.

<a id="cc-couchbase-sink-config-properties"></a>

## Configuration Properties

Use the following configuration properties with the fully managed connector. For
self-managed connector property definitions and other details, see the connector
docs in [Self-managed connectors for Confluent Platform](/platform/current/connect/kafka_connectors.html).

### How should we connect to your data?

`name`
: Sets a name for your connector.
  <br/>
  * Type: string
  * Valid Values: A string at most 64 characters long
  * Importance: high

### Schema Config

`schema.context.name`
: Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.
  <br/>
  * Type: string
  * Default: default
  * Importance: medium

### Kafka Cluster credentials

`kafka.auth.mode`
: Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode, whenever possible.
  <br/>
  * Type: string
  * Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY
  * Importance: high

`kafka.api.key`
: Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.
  <br/>
  * Type: password
  * Importance: high

`kafka.service.account.id`
: The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.
  <br/>
  * Type: string
  * Importance: high

`kafka.api.secret`
: Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.
  <br/>
  * Type: password
  * Importance: high

### Connection

`couchbase.seed.nodes`
: 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).
  <br/>
  * Type: string
  * Importance: high

`couchbase.username`
: Name of the Couchbase user to authenticate as.
  <br/>
  * Type: string
  * Importance: high

`couchbase.password`
: Password of the Couchbase user.
  <br/>
  * Type: password
  * Importance: high

`couchbase.bucket`
: Name of the Couchbase bucket to use. This property is required unless using the experimental AnalyticsSinkHandler.
  <br/>
  * Type: string
  * Default: “”
  * Importance: high

### Sink Behavior

`couchbase.default.collection`
: 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.
  <br/>
  * Type: string
  * Default: \_default._default
  * Importance: medium

`couchbase.topic.to.collection`
: 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.
  <br/>
  * Type: string
  * Default: “”
  * Importance: medium

`couchbase.topic.to.document.id`
: 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.
  <br/>
  * Type: string
  * Default: “”
  * Importance: medium

`couchbase.sink.handler`
: 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.
  <br/>
  * Type: string
  * Default: com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler
  * Valid Values: com.couchbase.connect.kafka.handler.sink.AnalyticsSinkHandler, com.couchbase.connect.kafka.handler.sink.N1qlSinkHandler, com.couchbase.connect.kafka.handler.sink.SubDocumentSinkHandler, com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler
  * Importance: medium

`couchbase.document.id`
: Format string to use for the Couchbase document ID (overriding the message key). May refer to document fields via placeholders like ${/path/to/field}
  <br/>
  * Type: string
  * Default: “”
  * Importance: medium

`couchbase.remove.document.id`
: Whether to remove the ID identified by ‘couchbase.documentId’ from the document before storing in Couchbase.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: medium

`couchbase.document.expiration`
: 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.
  <br/>
  * Type: string
  * Default: 0
  * Valid Values: Must match the regex `^0$|^[1-9]\d*(ms|s|m|h|d)$`
  * Importance: medium

`couchbase.retry.timeout`
: 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. This retry timeout is distinct from the KV timeout (which you can set via couchbase.env.\*). The KV timeout affects an individual write attempt, while the retry timeout spans multiple attempts and makes the connector resilient to more kinds of transient failures. Try not to confuse this with the Kafka Connect framework’s built-in errors.retry.timeout config property, which applies only to failures occurring before the framework delivers the record to the Couchbase connector.
  <br/>
  * Type: string
  * Default: 0
  * Valid Values: Must match the regex `^0$|^[1-9]\d*(ms|s|m|h|d)$`
  * Importance: medium

### Durability

`couchbase.durability`
: 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. If you set this to anything other than NONE, then you must not set couchbase.persist.to or couchbase.replicate.to.
  <br/>
  * Type: string
  * Default: NONE
  * Valid Values: MAJORITY, MAJORITY_AND_PERSIST_TO_ACTIVE, NONE, PERSIST_TO_MAJORITY
  * Importance: medium

`couchbase.persist.to`
: 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.
  <br/>
  * Type: string
  * Default: NONE
  * Valid Values: ACTIVE, FOUR, NONE, ONE, THREE, TWO
  * Importance: medium

`couchbase.replicate.to`
: 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.
  <br/>
  * Type: string
  * Default: NONE
  * Valid Values: NONE, ONE, THREE, TWO
  * Importance: medium

### N1ql Sink Handler

`couchbase.n1ql.operation`
: 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.
  <br/>
  * Type: string
  * Default: UPDATE
  * Valid Values: UPDATE, UPDATE_WHERE
  * Importance: medium

`couchbase.n1ql.where.fields`
: 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.
  <br/>
  * Type: string
  * Default: “”
  * Importance: medium

`couchbase.n1ql.create.document`
: Controls whether to create the document if it does not exist. This property is specific to N1qlSinkHandler.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

### Sub Document Sink Handler

`couchbase.subdocument.path`
: 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.
  <br/>
  * Type: string
  * Default: “”
  * Importance: medium

`couchbase.subdocument.operation`
: Setting to indicate the type of update to a sub-document. This property is specific to SubDocumentSinkHandler.
  <br/>
  * Type: string
  * Default: UPSERT
  * Valid Values: ARRAY_APPEND, ARRAY_PREPEND, UPSERT
  * Importance: medium

`couchbase.subdocument.create.path`
: Whether to add the parent paths if they are missing in the document. This property is specific to SubDocumentSinkHandler.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

`couchbase.subdocument.create.document`
: This property controls whether to create the document if it does not exist. This property is specific to SubDocumentSinkHandler.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

### Analytics Sink Handler

`couchbase.analytics.max.records.in.batch`
: 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. Since: 4.1.14
  <br/>
  * Type: int
  * Default: 100
  * Importance: medium

`couchbase.analytics.max.size.in.batch`
: 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. Since: 4.2.0
  <br/>
  * Type: string
  * Default: 5m
  * Valid Values: Must match the regex `^[1-9]\d*(b|k|m|g)$`
  * Importance: medium

`couchbase.analytics.query.timeout`
: 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. Since: 4.2.0
  <br/>
  * Type: string
  * Default: 5m
  * Valid Values: Must match the regex `^[1-9]\d*(ms|s|m|h|d)$`
  * Importance: medium

### Additional Configs

`consumer.override.auto.offset.reset`
: Defines the behavior of the consumer when there is no committed position (which occurs when the group is first initialized) or when an offset is out of range. You can choose either to reset the position to the “earliest” offset (the default) or the “latest” offset. You can also select “none” if you would rather set the initial offset yourself and you are willing to handle out of range errors manually. More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset)
  <br/>
  * Type: string
  * Importance: low

`consumer.override.isolation.level`
: Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode.  More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level)
  <br/>
  * Type: string
  * Importance: low

`header.converter`
: The converter class for the headers. This is used to serialize and deserialize the headers of the messages.
  <br/>
  * Type: string
  * Importance: low

`key.converter.use.schema.guid`
: The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: string
  * Importance: low

`key.converter.use.schema.id`
: The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: int
  * Importance: low

`value.converter.allow.optional.map.keys`
: Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.auto.register.schemas`
: Specify if the Serializer should attempt to register the Schema.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.connect.meta.data`
: Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.enhanced.avro.schema.support`
: Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.enhanced.protobuf.schema.support`
: Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.flatten.unions`
: Whether to flatten unions (oneofs). Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.generate.index.for.unions`
: Whether to generate an index suffix for unions. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.generate.struct.for.nulls`
: Whether to generate a struct variable for null values. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.int.for.enums`
: Whether to represent enums as integers. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.latest.compatibility.strict`
: Verify latest subject version is backward compatible when use.latest.version is true.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.object.additional.properties`
: Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.optional.for.nullables`
: Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.optional.for.proto2`
: Whether proto2 optionals are supported. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.scrub.invalid.names`
: Whether to scrub invalid names by replacing invalid characters with valid characters. Applicable for Avro and Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.latest.version`
: Use latest version of schema in subject for serialization when auto.register.schemas is false.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.optional.for.nonrequired`
: Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.schema.guid`
: The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: string
  * Importance: low

`value.converter.use.schema.id`
: The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: int
  * Importance: low

`value.converter.wrapper.for.nullables`
: Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.wrapper.for.raw.primitives`
: Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`errors.tolerance`
: Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.
  <br/>
  * Type: string
  * Default: all
  * Importance: low

`key.converter.key.schema.id.deserializer`
: The class name of the schema ID deserializer for keys. This is used to deserialize schema IDs from the message headers.
  <br/>
  * Type: string
  * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer
  * Importance: low

`key.converter.key.subject.name.strategy`
: How to construct the subject name for key schema registration.
  <br/>
  * Type: string
  * Default: TopicNameStrategy
  * Importance: low

`key.converter.replace.null.with.default`
: Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Key Converter.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: low

`key.converter.schemas.enable`
: Include schemas within each of the serialized keys. Input message keys must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Key Converter.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`value.converter.decimal.format`
: Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:
  <br/>
  BASE64 to serialize DECIMAL logical types as base64 encoded binary data and
  <br/>
  NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.
  <br/>
  * Type: string
  * Default: BASE64
  * Importance: low

`value.converter.flatten.singleton.unions`
: Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`value.converter.ignore.default.for.nullables`
: When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF and JSON_SR Converters.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`value.converter.reference.subject.name.strategy`
: Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.
  <br/>
  * Type: string
  * Default: DefaultReferenceSubjectNameStrategy
  * Importance: low

`value.converter.replace.null.with.default`
: Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: low

`value.converter.schemas.enable`
: Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`value.converter.value.schema.id.deserializer`
: The class name of the schema ID deserializer for values. This is used to deserialize schema IDs from the message headers.
  <br/>
  * Type: string
  * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer
  * Importance: low

`value.converter.value.subject.name.strategy`
: Determines how to construct the subject name under which the value schema is registered with Schema Registry.
  <br/>
  * Type: string
  * Default: TopicNameStrategy
  * Importance: low

### Consumer configuration

`max.poll.interval.ms`
: The maximum delay between subsequent consume requests to Kafka. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 300000 milliseconds (5 minutes).
  <br/>
  * Type: long
  * Default: 300000 (5 minutes)
  * Valid Values: [60000,…,1800000] for non-dedicated clusters and [60000,…] for dedicated clusters
  * Importance: low

`max.poll.records`
: The maximum number of records to consume from Kafka in a single request. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 500 records.
  <br/>
  * Type: long
  * Default: 500
  * Valid Values: [1,…,500] for non-dedicated clusters and [1,…] for dedicated clusters
  * Importance: low

### Input messages

`input.data.format`
: Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, JSON or BYTES. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF.
  <br/>
  * Type: string
  * Default: JSON
  * Importance: high

`input.key.format`
: Sets the input Kafka record key format. Valid entries are AVRO, BYTES, JSON, JSON_SR, PROTOBUF, or STRING. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF
  <br/>
  * Type: string
  * Default: JSON
  * Valid Values: AVRO, BYTES, JSON, JSON_SR, PROTOBUF, STRING
  * Importance: high

### Number of tasks for this connector

`tasks.max`
: Maximum number of tasks for the connector.
  <br/>
  * Type: int
  * Valid Values: [1,…]
  * Importance: high

### Which topics do you want to get data from?

`topics.regex`
: A regular expression that matches the names of the topics to consume from. This is useful when you want to consume from multiple topics that match a certain pattern without having to list them all individually.
  <br/>
  * Type: string
  * Importance: low

`topics`
: Identifies the topic name or a comma-separated list of topic names.
  <br/>
  * Type: list
  * Importance: high

`errors.deadletterqueue.topic.name`
: The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. Defaults to ‘dlq-${connector}’ if not set. The DLQ topic will be created automatically if it does not exist. You can provide `${connector}` in the value to use it as a placeholder for the logical cluster ID.
  <br/>
  * Type: string
  * Default: dlq-${connector}
  * Importance: low

### Auto-restart policy

`auto.restart.on.user.error`
: Enable connector to automatically restart on user-actionable errors.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

## Frequently asked questions

Find answers to frequently asked questions about the Couchbase Sink connector.

### Why does my connector fail with connection timeout errors?

Connection timeouts occur when the connector cannot reach the Couchbase database.

Common causes and solutions:

1. **Network connectivity issues**: Verify the Couchbase database is reachable from Confluent Cloud. Check firewall rules, security groups, and network policies. For private Couchbase instances, ensure VPC peering or PrivateLink is configured.
2. **Incorrect seed nodes configuration**: Verify the `couchbase.seed.nodes` property uses the correct format. For secure connections, use `couchbases://` protocol. If specifying a custom port, use the KV port such as `11207` for secure connections or `11210` for insecure connections.
3. **DNS resolution problems**: For PrivateLink deployments, ensure DNS records are configured correctly.
4. **Firewall blocking**: Verify the Couchbase firewall or security groups allow inbound connections from Confluent Cloud egress IP addresses. For more information, see [Public Egress IP Addresses for Confluent Cloud Connectors](../static-egress-ip.md#cc-static-egress-ips).

Check the connector logs in the Confluent Cloud Console for detailed error messages.

### Why is my connector stuck in `PROVISIONING` state?

If the connector remains in `PROVISIONING` state indefinitely without logs or errors, this indicates connectivity problems during the initial connection validation.

Common causes and solutions:

1. **Network timeouts**: The connector cannot reach the Couchbase database. During provisioning, the connector validates the connection. Network timeouts may cause the connector to hang.
2. **Invalid bucket configuration**: Ensure the bucket specified in `couchbase.bucket` exists in the Couchbase database.
3. **Incorrect authentication**: Verify the `couchbase.username` and `couchbase.password` credentials are correct and the user has write permissions to the specified bucket and collections.
4. **Collection mapping errors**: Verify the collections specified in `couchbase.default.collection` or `couchbase.topic.to.collection` exist in the Couchbase database.

If the connector remains stuck after resolving connectivity issues, delete and recreate the connector with the corrected configuration.

### How do I map Kafka topics to Couchbase collections?

The connector provides flexible mapping options to route data from Kafka topics to Couchbase collections:

1. **Default collection**: Use `couchbase.default.collection` to specify the default Couchbase collection for all topics not explicitly mapped. Format: `scope.collection`, for example `_default._default`.
2. **Topic-to-collection mapping**: Use `couchbase.topic.to.collection` to map specific topics to collections. Format: `topic1=scope1.collection1,topic2=scope2.collection2`.
3. **Explicit mapping takes precedence**: If a topic is specified in `couchbase.topic.to.collection`, that mapping is used instead of the default collection.

Ensure all specified scopes and collections exist in the Couchbase bucket before starting the connector.

### Why am I seeing `Document does not exist` errors?

This error occurs when the connector attempts to update or delete a document that does not exist in the Couchbase collection.

Common causes and solutions:

1. **Using the wrong sink handler**: If you are using `SubdocumentSinkHandler` or a custom handler that updates existing documents, ensure documents already exist. Use `UpsertSinkHandler` to create or update documents.
2. **Document expiration**: Documents may have expired based on the `couchbase.document.expiration` setting. Verify the expiration policy matches your use case.
3. **Concurrent deletions**: Another process may have deleted the document before the connector attempted to update it. Review application logic to prevent race conditions.

Change the `couchbase.sink.handler` to `com.couchbase.connect.kafka.handler.sink.UpsertSinkHandler` to automatically create documents if they do not exist.

### How do I control the document ID in Couchbase?

The connector uses the Kafka record key as the Couchbase document ID by default. To customize document IDs:

1. **Use couchbase.document.id**: Set a SpEL expression to extract the document ID from the record value. For example, `${/id}` extracts the `id` field from the document.
2. **Per-topic overrides**: Use `couchbase.topic.to.document.id` to specify different ID extraction expressions for specific topics. Format: `topic1=${/customId},topic2=${/recordKey}`.
3. **Remove document ID**: Set `couchbase.remove.document.id=true` to remove the document ID field from the document body after using it as the Couchbase key.

Ensure the ID field exists in all records, or use `UpsertSinkHandler` to generate UUIDs for missing IDs.

### Why am I seeing `Input data format mismatch` errors?

Data format errors occur when the `input.data.format` setting does not match the actual format of messages in the Kafka topic.

Common causes and solutions:

1. **Format mismatch**: Check the format of messages in the Kafka topic. Use the Confluent Cloud Console or Confluent CLI to inspect topic messages.
2. **Incorrect input format setting**: Set `input.data.format` to match the topic format: `AVRO`, `JSON_SR`, `PROTOBUF`, `JSON`, or `BYTES`.
3. **Missing Schema Registry**: For schema-based formats such as `AVRO`, `JSON_SR`, or `PROTOBUF`, ensure Confluent Cloud Schema Registry is enabled and the topic uses schemas.

Check the connector logs and DLQ messages to identify the specific format mismatch.

### How can I improve connector performance?

Performance optimization:

1. **Increase the number of tasks**: Set a higher `tasks.max` value to process more partitions in parallel. One task handles up to 100 partitions. More tasks improve throughput.
2. **Tune batch settings**: Increase `consumer.override.max.poll.records` to consume more records from Kafka in a single request. Adjust `consumer.override.max.poll.interval.ms` if the connector needs more time to write large batches.
3. **Optimize durability settings**: Reduce `couchbase.durability` from `MAJORITY` to `NONE` for better write performance in non-critical use cases. Note that this reduces data safety guarantees.
4. **Configure retry timeout**: Adjust `couchbase.retry.timeout` to control how long the connector retries failed operations. Lower values fail faster but may lose data during transient failures.

Monitor connector metrics in the Confluent Cloud Console to identify bottlenecks.

## Next Steps

For an example that shows fully managed Confluent Cloud connectors in action with
Confluent Cloud for Apache Flink, see the [Cloud ETL Demo](/platform/current/tutorials/examples/cloud-etl/docs/index.html).
This example also shows how to use Confluent CLI to manage your resources in
Confluent Cloud.

[![image](images/topology.png)](https://docs.confluent.io/platform/current/tutorials/examples/cloud-etl/docs/index.html)