Debezium MongoDB Connector

Capture changes from a MongoDB database.

Metadata

Property	Value
Scheme	`debezium-mongodb`
Support Level	Stable
Labels	database
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-debezium-mongodb</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`name`	string	✓		Unique name for the connector. Attempting to register again with the same name will fail.
`additionalProperties`	object			Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro
`internalKeyConverter`	string		`org.apache.kafka.connect.json.JsonConverter`	The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.
`internalValueConverter`	string		`org.apache.kafka.connect.json.JsonConverter`	The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.
`offsetCommitPolicy`	string			The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals.
`offsetCommitTimeoutMs`	duration		`5000`	Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds.
`offsetFlushIntervalMs`	duration		`60000`	Interval at which to try committing offsets. The default is 1 minute.
`offsetStorage`	string		`org.apache.kafka.connect.storage.FileOffsetBackingStore`	The name of the Java class that is responsible for persistence of connector offsets.
`offsetStorageFileName`	string			Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.
`offsetStoragePartitions`	integer			The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.
`offsetStorageReplicationFactor`	integer			Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore
`offsetStorageTopic`	string			The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`captureMode`	string		`change_streams_update_full`	The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents
`collectionExcludeList`	string			A comma-separated list of regular expressions or literals that match the collection names for which changes are to be excluded
`collectionIncludeList`	string			A comma-separated list of regular expressions or literals that match the collection names for which changes are to be captured
`converters`	string			Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'
`cursorMaxAwaitTimeMs`	duration			The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request
`customMetricTags`	string			The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2
`databaseExcludeList`	string			A comma-separated list of regular expressions or literals that match the database names for which changes are to be excluded
`databaseIncludeList`	string			A comma-separated list of regular expressions or literals that match the database names for which changes are to be captured
`errorsMaxRetries`	integer		`-1`	The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries).
`eventProcessingFailureHandlingMode`	string		`fail`	Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped.
`fieldExcludeList`	string			A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values
`fieldRenames`	string			A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field.
`heartbeatIntervalMs`	duration		`0ms`	Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default.
`heartbeatTopicsPrefix`	string		`__debezium-heartbeat`	The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.
`incrementalSnapshotWatermarkingStrategy`	string		`INSERT_INSERT`	Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;
`maxBatchSize`	integer		`2048`	Maximum size of each batch of source records. Defaults to 2048.
`maxQueueSize`	integer		`8192`	Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size.
`maxQueueSizeInBytes`	integer		`0`	Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled
`mongodbAuthsource`	string		`admin`	Database containing user credentials.
`mongodbConnectionString`	string			Database connection string.
`mongodbConnectTimeoutMs`	duration		`10s`	The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms).
`mongodbHeartbeatFrequencyMs`	duration		`10s`	The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms).
`mongodbPassword`	string	✓		Password to be used when connecting to MongoDB, if necessary.
`mongodbPollIntervalMs`	duration		`30s`	Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms).
`mongodbServerSelectionTimeoutMs`	duration		`30s`	The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms).
`mongodbSocketTimeoutMs`	duration		`0ms`	The socket timeout, given in milliseconds. Defaults to 0 ms.
`mongodbSslEnabled`	boolean		`false`	Should connector use SSL to connect to MongoDB instances
`mongodbSslInvalidHostnameAllowed`	boolean		`false`	Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks
`mongodbUser`	string			Database user for connecting to MongoDB, if necessary.
`notificationEnabledChannels`	string			List of notification channels names that are enabled.
`notificationSinkTopicName`	string			The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels
`pollIntervalMs`	duration		`500ms`	Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms.
`postProcessors`	string			Optional list of post processors. The processors are defined using '.type' config option and configured using options ''
`provideTransactionMetadata`	boolean		`false`	Enables transaction metadata extraction together with event counting
`queryFetchSize`	integer		`0`	The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size.
`retriableRestartConnectorWaitMs`	duration		`10s`	Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms.
`schemaHistoryInternalFileFilename`	string			The path to the file that will be used to record the database schema history
`schemaNameAdjustmentMode`	string		`none`	Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)
`signalDataCollection`	string			The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set.
`signalEnabledChannels`	string		`source`	List of channels names that are enabled. Source channel is enabled by default
`signalPollIntervalMs`	duration		`5s`	Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds.
`skippedOperations`	string		`t`	The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped.
`snapshotCollectionFilterOverrides`	string			This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override..
`snapshotDelayMs`	duration		`0ms`	A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms.
`snapshotFetchSize`	integer			The maximum number of records that should be loaded into memory while performing a snapshot.
`snapshotIncludeCollectionList`	string			This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector.
`snapshotMaxThreads`	integer		`1`	The maximum number of threads used to perform the snapshot. Defaults to 1.
`snapshotMode`	string		`initial`	The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog.
`snapshotModeConfigurationBasedSnapshotData`	boolean		`false`	When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not.
`snapshotModeConfigurationBasedSnapshotOnDataError`	boolean		`false`	When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error.
`snapshotModeConfigurationBasedSnapshotOnSchemaError`	boolean		`false`	When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error.
`snapshotModeConfigurationBasedSnapshotSchema`	boolean		`false`	When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not.
`snapshotModeConfigurationBasedStartStream`	boolean		`false`	When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot.
`snapshotModeCustomName`	string			When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot.
`sourceinfoStructMaker`	string		`io.debezium.connector.mongodb.MongoDbSourceInfoStructMaker`	The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct.
`streamingDelayMs`	duration		`0ms`	A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms.
`tombstonesOnDelete`	boolean		`false`	Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.
`topicNamingStrategy`	string		`io.debezium.schema.SchemaTopicNamingStrategy`	The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc.
`topicPrefix`	string	✓		Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted.
`transactionMetadataFactory`	string		`io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory`	Class to make transaction context & transaction struct/schemas