Sink Connector Id Strategy Properties

Overview

Use the following configuration settings to specify how the MongoDB Kafka sink connector should determine the _id value for each document it writes to MongoDB.

For a list of sink connector configuration settings organized by category, see the guide on Sink Connector Configuration Properties.

Settings

Name

Description

document.id.strategy

Type: string

Description:
The class the connector should use to generate a unique _id field.

Default:

com.mongodb.kafka.connect.sink.processor.id.strategy.BsonOidStrategy

Accepted Values: An empty string or a fully qualified Java class name

document.id.strategy.overwrite.existing

Type: boolean

Description:
Whether the connector should overwrite existing values in the _id field when it applies the strategy defined by the document.id.strategy property.

Default: false
Accepted Values: true or false

document.id.strategy.uuid.format

Type: string

Description:
Whether the connector should output the UUID in the _id field in string format or in BsonBinary format.

Default: string
Accepted Values: string or binary

delete.on.null.values

Type: boolean

Description:
Whether the connector should delete documents when the key value matches a document in MongoDB and the value field is null.

This setting applies when you specify an id generation strategy that operates on the key document such as FullKeyStrategy, PartialKeyStrategy, and ProvidedInKeyStrategy.

Default: false
Accepted Values: true or false

Back

Post-processors

Write Model Strategy