Conduktor
conduktor.io ↗
Conduktor
conduktor.io ↗
All configuration properties for the Debezium MongoDB connector across versions 2.4–3.5. Cells highlighted in green are additions, red are removals, yellow are default changes.
| Property | Description | 2.4 | 2.5 | 2.6 | 2.7 | 3.0 | 3.1 | 3.2 | 3.3 | 3.4 | 3.5 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| binary.handling.mode | Specify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents bi.. | bytes | bytes | bytes | bytes | bytes | bytes | bytes | bytes | bytes | bytes |
| capture.mode | The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB.. | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full | change_streams_update_full |
| capture.scope | The scope of captured changes. Options include: 'deployment' (the default) to capture changes from the entire MongoDB de.. | deployment | deployment | deployment | deployment | deployment | deployment | deployment | deployment | deployment | deployment |
| capture.target | The target to capture changes from. For 'database' scope, this is the database name. For 'collection' scope, this is the.. | null | null | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| collection.exclude.list | A comma-separated list of regular expressions or literals that match the collection names for which changes are to be ex.. | null | null | null | null | null | null | null | null | null | null |
| collection.include.list | A comma-separated list of regular expressions or literals that match the collection names for which changes are to be ca.. | null | null | null | null | null | null | null | null | null | null |
| converters | Optional list of custom converters that would be used instead of default ones. The converters are defined using '<conver.. | null | null | null | null | null | null | null | null | null | null |
| cursor.max.await.time.ms | The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request | null | null | null | null | null | null | null | null | null | null |
| cursor.oversize.handling.mode | The strategy used to handle change events for documents exceeding specified BSON size. Options include: 'fail' (the defa.. | fail | fail | fail | fail | fail | fail | fail | fail | fail | fail |
| cursor.oversize.skip.threshold | The maximum allowed size of the stored document for which change events are processed. This includes both, the size befo.. | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| cursor.pipeline | Applies processing to change events as part of the the standard MongoDB aggregation stream pipeline. A pipeline is a Mon.. | null | null | null | null | null | null | null | null | null | null |
| cursor.pipeline.order | The order used to construct the effective MongoDB aggregation stream pipeline Options include: 'internal_first' (the def.. | internal_first | internal_first | internal_first | internal_first | internal_first | internal_first | internal_first | internal_first | internal_first | internal_first |
| custom.metric.tags | The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end o.. | null | null | null | null | null | null | null | null | null | null |
| database.exclude.list | A comma-separated list of regular expressions or literals that match the database names for which changes are to be excl.. | null | null | null | null | null | null | null | null | null | null |
| database.include.list | A comma-separated list of regular expressions or literals that match the database names for which changes are to be capt.. | null | null | null | null | null | null | null | null | null | null |
| errors.max.retries | The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, > 0 = num of retries). | null | null | null | null | null | null | null | null | null | null |
| event.processing.failure.handling.mode | Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including.. | fail | fail | fail | fail | fail | fail | fail | fail | fail | fail |
| field.exclude.list | A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values | null | null | null | null | null | null | null | null | null | null |
| field.name.adjustment.mode | Specify how field names should be adjusted for compatibility with the message converter used by the connector, including.. | none | none | none | none | none | none | none | none | none | none |
| field.renames | A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change even.. | null | null | null | null | null | null | null | null | null | null |
| filters.match.mode | The mode used by the aggregation pipeline to match events based on included/excluded database and collection namesOption.. | regex | regex | regex | regex | regex | regex | regex | regex | regex | regex |
| incremental.snapshot.allow.schema.changes | Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that chang.. | false | false | false | false | false | false | false | false | false | false |
| incremental.snapshot.chunk.size | The maximum size of chunk (number of documents/rows) for incremental snapshotting | 1024 | 1024 | 1024 | 1024 | 1024 | 1024 | 1024 | 1024 | 1024 | 1024 |
| max.batch.size | Maximum size of each batch of source records. Defaults to . | null | null | null | null | null | null | null | null | null | null |
| max.queue.size | Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to , .. | null | null | null | null | null | null | null | null | null | null |
| max.queue.size.in.bytes | Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defau.. | null | null | null | null | null | null | null | null | null | null |
| mongodb.authentication.class | This class must implement the 'MongoDbAuthProvider' interface and is called on each app boot to provide the MongoDB cred.. | null | null | null | null | null | null | null | null | null | null |
| mongodb.authsource | Database containing user credentials. | admin_database_name | admin_database_name | null | null | null | null | null | null | null | null |
| mongodb.connect.timeout.ms | The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | null | null | null | null | null | null | null | null | null | null |
| mongodb.connection.mode | The method used to connect to MongoDB cluster. Options include: 'replica_set' to individually connect to each replica se.. | replica_set | sharded | — | — | — | — | — | — | — | — |
| mongodb.connection.string | Database connection string. | null | null | null | null | — | — | — | — | — | — |
| mongodb.connection.string.shard.params | The connection string parameters used when connecting to individual shards of sharded cluster.Only applicable with repli.. | null | null | — | — | — | — | — | — | — | — |
| mongodb.heartbeat.frequency.ms | The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms). | null | null | null | null | null | null | null | null | null | null |
| mongodb.password | Password to be used when connecting to MongoDB, if necessary. | null | null | null | null | null | null | null | null | null | null |
| mongodb.poll.interval.ms | Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms.. | null | null | null | null | null | null | null | null | null | null |
| mongodb.server.selection.timeout.ms | The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | null | null | null | null | null | null | null | null | null | null |
| mongodb.socket.timeout.ms | The socket timeout, given in milliseconds. Defaults to 0 ms. | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| mongodb.ssl.enabled | Should connector use SSL to connect to MongoDB instances | false | false | false | false | false | false | false | false | false | false |
| mongodb.ssl.invalid.hostname.allowed | Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks | false | false | false | false | false | false | false | false | false | false |
| mongodb.user | Database user for connecting to MongoDB, if necessary. | null | null | null | null | null | null | null | null | null | null |
| notification.enabled.channels | List of notification channels names that are enabled. | null | null | null | null | null | null | null | null | null | null |
| poll.interval.ms | Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. | null | null | null | null | null | null | null | null | null | null |
| provide.transaction.metadata | Enables transaction metadata extraction together with event counting | false | false | false | false | false | false | false | false | false | false |
| query.fetch.size | The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fe.. | null | null | null | null | null | null | null | null | null | null |
| retriable.restart.connector.wait.ms | Time to wait before restarting connector after retriable exception occurs. Defaults to ms. | null | null | null | null | null | null | null | null | null | null |
| schema.name.adjustment.mode | Specify how schema names should be adjusted for compatibility with the message converter used by the connector, includin.. | none | none | none | none | none | none | none | none | none | none |
| signal.data.collection | The name of the data collection that is used to send signals/commands to Debezium. For multi-partition mode connectors, .. | null | null | null | null | null | null | null | null | null | null |
| signal.enabled.channels | List of channels names that are enabled. Source channel is enabled by default | source | source | source | source | source | source | source | source | source | source |
| signal.poll.interval.ms | Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. | 5000 | 5000 | 5000 | 5000 | 5000 | 5000 | 5000 | 5000 | 5000 | 5000 |
| skip.messages.without.change | Enable to skip publishing messages when there is no change in included columns.This would essentially filter messages to.. | false | false | false | false | false | false | false | false | false | false |
| skipped.operations | The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd.. | t | t | t | t | t | t | t | t | t | t |
| snapshot.collection.filter.overrides | This property contains a comma-separated list of <dbName>.<collectionName>, for which the initial snapshot may be a subs.. | null | null | null | null | null | null | null | null | null | null |
| snapshot.delay.ms | A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| snapshot.fetch.size | The maximum number of records that should be loaded into memory while performing a snapshot. | null | null | null | null | null | null | null | null | null | null |
| snapshot.include.collection.list | This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting .. | null | null | null | null | null | null | null | null | null | null |
| snapshot.max.threads | The maximum number of threads used to perform the snapshot. Defaults to 1. | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
| snapshot.mode | The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initia.. | initial | initial | initial | initial | initial | initial | initial | initial | initial | initial |
| sourceinfo.struct.maker | The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. | null | null | null | null | null | null | null | null | null | null |
| tombstones.on.delete | Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a d.. | true | true | true | true | true | true | true | true | true | true |
| topic.naming.strategy | The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change.. | null | null | null | null | null | null | null | null | null | null |
| topic.prefix | Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. T.. | null | null | null | null | null | null | null | null | null | null |
| capture.mode.full.update.type | The method used to perform full update lookups. Options include: 'lookup' (the default) use separate lookup to get the u.. | — | lookup | lookup | lookup | lookup | lookup | lookup | lookup | lookup | lookup |
| incremental.snapshot.watermarking.strategy | Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is.. | — | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT | INSERT_INSERT |
| mongodb.ssl.keystore | The location of the key store file. This is optional and can be used for two-way authentication between the client and t.. | — | null | null | null | null | null | null | null | null | null |
| mongodb.ssl.keystore.password | The password for the key store file. This is optional and only needed if 'mongodb.ssl.keystore' is configured. | — | null | null | null | null | null | null | null | null | null |
| mongodb.ssl.keystore.type | The type of key store file. This is optional and only needed if 'mongodb.ssl.keystore' is configured. | — | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 |
| mongodb.ssl.truststore | The location of the trust store file for the server certificate verification. | — | null | null | null | null | null | null | null | null | null |
| mongodb.ssl.truststore.password | The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore. | — | null | null | null | null | null | null | null | null | null |
| mongodb.ssl.truststore.type | The type of trust store file. This is optional and only needed if 'mongodb.ssl.truststore' is configured. | — | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 | PKCS12 |
| post.processors | Optional list of post processors. The processors are defined using '<post.processor.prefix>.type' config option and conf.. | — | null | null | null | null | null | null | null | null | null |
| event.converting.failure.handling.mode | Specify how failures during converting of event should be handled, including: 'fail' throw an exception that the column .. | — | — | warn | warn | warn | warn | warn | warn | warn | warn |
| snapshot.locking.mode.custom.name | When 'snapshot.locking.mode' is set as custom, this setting must be set to specify a the name of the custom implementati.. | — | — | null | null | null | null | null | null | null | null |
| snapshot.mode.configuration.based.snapshot.data | When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshot.. | — | — | false | false | false | false | false | false | false | false |
| snapshot.mode.configuration.based.snapshot.on.data.error | When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshot.. | — | — | false | false | false | false | false | false | false | false |
| snapshot.mode.configuration.based.snapshot.on.schema.error | When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapsh.. | — | — | false | false | false | false | false | false | false | false |
| snapshot.mode.configuration.based.snapshot.schema | When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapsh.. | — | — | false | false | false | false | false | false | false | false |
| snapshot.mode.configuration.based.start.stream | When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or .. | — | — | false | false | false | false | false | false | false | false |
| snapshot.mode.custom.name | When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provi.. | — | — | null | null | null | null | null | null | null | null |
| snapshot.query.mode | Controls query used during the snapshot | — | — | select_all | select_all | select_all | select_all | select_all | select_all | select_all | select_all |
| snapshot.query.mode.custom.name | When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation.. | — | — | null | null | null | null | null | null | null | null |
| streaming.delay.ms | A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. | — | — | — | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| transaction.metadata.factory | Class to make transaction context & transaction struct/schemas | — | — | — | null | null | null | null | null | null | null |
| connection.validation.timeout.ms | The maximum time in milliseconds to wait for connection validation to complete. Defaults to 60 seconds. | — | — | — | — | — | — | null | null | null | null |
| executor.shutdown.timeout.ms | The maximum time in milliseconds to wait for task executor to shut down. | — | — | — | — | — | — | null | null | null | null |
| capture.start.op.time | If no existing offset is detected, Debezium will start streaming from given timestamp | — | — | — | — | — | — | — | -1 | -1 | -1 |
| guardrail.collections.limit.action | Specify the action to take when a guardrail collections limit is exceeded: 'warn' (the default) logs a warning message a.. | — | — | — | — | — | — | — | warn | warn | warn |
| guardrail.collections.max | The maximum number of collections or tables that can be captured by the connector. When this limit is exceeded, the acti.. | — | — | — | — | — | — | — | 0 | 0 | 0 |
| snapshot.max.threads.multiplier | The factor used to scale the number of snapshot chunks per table. The default behavior is to take 'row_count/snapshot.ma.. | — | — | — | — | — | — | — | — | — | 1 |