conduktor.io ↗

Debezium CDC Connector Configuration Properties — All Versions

Property Description 2.42.52.62.73.03.13.23.33.43.53.63.7
bigint.unsigned.handling.modeSpecify how BIGINT UNSIGNED columns should be represented in change events, including: 'precise' uses java.math.BigDecim..———longlonglonglonglonglonglonglonglong
binary.handling.modeSpecify how binary (blob, binary, etc.) columns should be represented in change events, including: 'bytes' represents bi..———bytesbytesbytesbytesbytesbytesbytesbytesbytes
binlog.buffer.sizeThe size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be c..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
column.exclude.listRegular expressions matching columns to exclude from change events———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
column.include.listRegular expressions matching columns to include in change events———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
column.propagate.source.typeA comma-separated list of regular expressions matching fully-qualified names of columns that adds the column’s original ..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
connect.keep.aliveWhether a separate thread should be used to ensure the connection is kept alive.———truetruetruetruetruetruetruetruetrue
connect.keep.alive.interval.msInterval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms).———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
connect.timeout.msMaximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 se..———300003000030000300003000030000300003000030000
convertersOptional list of custom converters that would be used instead of default ones. The converters are defined using '<conver..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
custom.metric.tagsA comma-separated list of key-value pairs that are appended to the MBean object name. Keys must be valid JMX ObjectName ..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.dbnameThe name of the database from which the connector should capture changes———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.hostnameResolvable hostname or IP address of the database server.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.initial.statementsA semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to th..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.passwordPassword of the database user to be used when connecting to the database.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.portPort of the database server.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.query.timeout.msTime to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no..———600000600000600000600000600000600000600000600000600000
database.server.idA numeric ID of this database client, which must be unique across all currently-running database processes in the cluste..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.server.id.offsetOnly relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the..———100001000010000100001000010000100001000010000
database.ssl.keystoreThe location of the key store file. This is optional and can be used for two-way authentication between the client and t..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.ssl.keystore.passwordThe password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.ssl.modeWhether to use an encrypted connection to the database. Options include: 'disable' to use an unencrypted connection; 'tr..———preferreddisabledisabledisabledisabledisabledisabledisabledisable
database.ssl.truststoreThe location of the trust store file for the server certificate verification.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.ssl.truststore.passwordThe password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
database.userName of the database user to be used when connecting to the database.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
datatype.propagate.source.typeA comma-separated list of regular expressions matching the database-specific data type names that adds the data type's o..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
decimal.handling.modeSpecify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses ..———precisepreciseprecisepreciseprecisepreciseprecisepreciseprecise
enable.time.adjusterThe database allows the user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automa..———truetruetruetruetruetruetruetruetrue
errors.max.retriesThe maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, > 0 = num of retries).———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
event.converting.failure.handling.modeSpecify how failures during converting of event should be handled, including: 'fail' throw an exception that the column ..———warnwarnwarnwarnwarnwarnwarnwarnwarn
event.deserialization.failure.handling.modeSpecify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handle..———failfailfailfailfailfailunresolvedunresolvedunresolved
event.processing.failure.handling.modeSpecify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including..———failfailfailfailfailfailfailfailfail
field.name.adjustment.modeSpecify how field names should be adjusted for compatibility with the message converter used by the connector, including..———nonenonenonenonenonenonenonenonenone
gtid.source.excludes———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
gtid.source.filter.dml.eventsWhen set to true, only produce DML events for transactions that were written on the server with matching GTIDs defined b..———truetruetruetruetruetruetruetruetrue
gtid.source.includes———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
include.queryWhether the connector should include the original SQL query that generated the change event. Note: This option requires ..———falsefalsefalsefalsefalsefalsefalsefalsefalse
include.schema.changesWhether the connector should publish changes in the database schema to a Kafka topic with the same name as the database ..———truetruetruetruetruetruetruetruetrue
include.schema.commentsWhether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the impli..———falsefalsefalsefalsefalsefalsefalsefalsefalse
inconsistent.schema.handling.modeSpecify how binlog events that belong to a table missing from internal schema representation (i.e. internal representati..———failfailfailfailfailfailunresolvedunresolvedunresolved
incremental.snapshot.allow.schema.changesDetect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that chang..———falsefalsefalsefalsefalsefalseunresolvedunresolvedunresolved
incremental.snapshot.chunk.sizeThe maximum size of chunk (number of documents/rows) for incremental snapshotting———102410241024102410241024102410241024
incremental.snapshot.watermarking.strategySpecify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is..———INSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERTINSERT_INSERT
max.batch.sizeMaximum size of each batch of source records. Defaults to .———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
max.queue.sizeMaximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to , ..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
max.queue.size.in.bytesMaximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defau..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
message.key.columnsA semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Eac..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
min.row.count.to.stream.resultsThe number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
notification.enabled.channelsList of notification channels names that are enabled.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
poll.interval.msTime to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to %d ms. Values..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
post.processorsOptional list of post processors. The processors are defined using '<post.processor.prefix>.type' config option and conf..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
provide.transaction.metadataEnables transaction metadata extraction together with event counting———falsefalsefalsefalsefalsefalseunresolvedunresolvedunresolved
query.fetch.sizeThe maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fe..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
read.onlySwitched connector to use alternative methods to deliver signals to Debezium instead of writing to signaling table———falsefalsefalsefalsefalsefalsefalsefalsefalse
retriable.restart.connector.wait.msTime to wait before restarting connector after retriable exception occurs. Defaults to ms.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
schema.name.adjustment.modeSpecify how schema names should be adjusted for compatibility with the message converter used by the connector, includin..———nonenonenonenonenonenonenonenonenone
signal.data.collectionThe name of the data collection that is used to send signals/commands to Debezium. For multi-partition mode connectors, ..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
signal.enabled.channelsList of channels names that are enabled. Source channel is enabled by default———sourcesourcesourcesourcesourcesourcesourcesourcesource
signal.poll.interval.msInterval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds.———500050005000500050005000500050005000
skip.messages.without.changeEnable to skip publishing messages when there is no change in included columns.This would essentially filter messages to..———falsefalsefalsefalsefalsefalsefalsefalsefalse
skipped.operationsThe comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd..———ttttttttt
snapshot.delay.msA delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms.———000000000
snapshot.fetch.sizeThe maximum number of records that should be loaded into memory while performing a snapshot.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.include.collection.listThis setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting ..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.lock.timeout.msThe maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
snapshot.locking.modeControls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minim..———minimalminimalminimalminimalminimalminimalminimalminimalminimal
snapshot.locking.mode.custom.nameWhen 'snapshot.locking.mode' is set as custom, this setting must be set to specify a the name of the custom implementati..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.max.threadsThe maximum number of threads used to perform the snapshot. Defaults to 1.———111111111
snapshot.modeControls startup snapshots. Supported modes at v3.7.0.Final: always, when_needed, initial, no_data, recovery, initial_on..———initialinitialinitialinitialinitialinitialinitialinitialinitial
snapshot.mode.configuration.based.snapshot.dataWhen 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshot..———falsefalsefalsefalsefalsefalsefalsefalsefalse
snapshot.mode.configuration.based.snapshot.on.data.errorWhen 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshot..———falsefalsefalsefalsefalsefalsefalsefalsefalse
snapshot.mode.configuration.based.snapshot.on.schema.errorWhen 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapsh..———falsefalsefalsefalsefalsefalsefalsefalsefalse
snapshot.mode.configuration.based.snapshot.schemaWhen 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapsh..———falsefalsefalsefalsefalsefalsefalsefalsefalse
snapshot.mode.configuration.based.start.streamWhen 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or ..———falsefalsefalsefalsefalsefalsefalsefalsefalse
snapshot.mode.custom.nameWhen 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provi..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.query.modeControls query used during the snapshot———select_allselect_allselect_allselect_allselect_allselect_allselect_allselect_allselect_all
snapshot.query.mode.custom.nameWhen 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.select.statement.overridesThis property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME)..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
snapshot.tables.order.by.row.countControls the order in which tables are processed in the initial snapshot. A `descending` value will order the tables by ..———disableddisableddisableddisableddisableddisableddisableddisableddisabled
sourceinfo.struct.makerThe name of the SourceInfoStructMaker class that returns SourceInfo schema and struct.———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
streaming.delay.msA delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms.———000000000
table.ignore.builtinFlag specifying whether built-in tables should be ignored.———truetruetruetruetruetruetruetruetrue
time.precision.modeTime, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) ba..———adaptiveadaptiveadaptiveadaptiveadaptiveadaptiveunresolvedunresolvedunresolved
tombstones.on.deleteWhether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a d..———truetruetruetruetruetruetruetruetrue
topic.naming.strategyThe name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
topic.prefixTopic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. T..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)not declarednot declarednot declared
transaction.metadata.factoryClass to make transaction context & transaction struct/schemas———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
unavailable.value.placeholderSpecify the constant that will be provided by Debezium to indicate that the original value is unavailable and not provid..———unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
use.nongraceful.disconnectWhether to use `socket.setSoLinger(true, 0)` when BinaryLogClient keepalive thread triggers a disconnect for a stale con..———falsefalsefalsefalsefalsefalsefalsefalsefalse
connection.validation.timeout.msThe maximum time in milliseconds to wait for connection validation to complete. Defaults to 60 seconds.——————unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
executor.shutdown.timeout.msThe maximum time in milliseconds to wait for task executor to shut down.——————unknown (legacy extraction)unknown (legacy extraction)unknown (legacy extraction)unresolvedunresolvedunresolved
guardrail.collections.limit.actionSpecify the action to take when a guardrail collections limit is exceeded: 'warn' (the default) logs a warning message a..———————warnwarnwarnwarnwarn
guardrail.collections.maxThe maximum number of collections or tables that can be captured by the connector. When this limit is exceeded, the acti..———————00000
binlog.net.read.timeoutThe number of seconds to wait for a read from the binlog connection to complete before the server times out. A value of ..—————————000
binlog.net.write.timeoutThe number of seconds to wait for a write to the binlog connection to complete before the server times out. A value of 0..—————————000
snapshot.max.threads.multiplierThe factor used to scale the number of snapshot chunks per table. The default behavior is to take 'row_count/snapshot.ma..—————————111
gtid.ignore.on.recoveryWhether the connector should ignore GTID during recovery and restart from the binlog file and position instead. GTID mod..——————————falsefalse
legacy.snapshot.max.threadsWhen enabled, uses the legacy table-per-thread parallel snapshot algorithm. When set to false (the default), tables are ..——————————falsefalse
queue.provider.typeThe name of the queue provider implementation to use for buffering change events. Defaults to '' which uses an in-memory..——————————unresolvedunresolved
statistics.metrics.enabledEnable to collect various kind of statistics, like latencies in record processing, and derived data like quantiles. By d..——————————truetrue
connect.keep.alive.max.reconnect.attemptsNumber of consecutive attempts the keep alive thread makes to restore a lost binlog connection before the connector fail..———————————0
poll.dispatch.interval.msTime to accumulate change events in the queue between subsequent polls. Defaults to 0 ms.———————————unresolved
resolve.create.table.like.schemaWhen a CREATE TABLE ... LIKE statement reference a table whose schema is not in the internal cache(e.g., excluded by tab..———————————false
signal.emit.failure.backoff.msDuration to sleep for after encountering an error emitting a window event, given in milliseconds. Defaults to 10 seconds..———————————10000
signal.emit.failure.max.retriesThe maximum number of retries after encountering an error emitting a window event (-1 = no limit, 0 = disabled, > 0 = nu..———————————0
tasks.maxMaximum number of tasks this connector can run.———————————not declared
Copied!

Explore More — Debezium Reference

🐘
PostgreSQL Connector
All config properties for Debezium PostgreSQL across versions 2.4–3.7
🐬
MySQL Connector
All config properties for Debezium MySQL across versions 2.4–3.7
🍃
MongoDB Connector
All config properties for Debezium MongoDB across versions 2.4–3.7
🪟
SQL Server Connector
All config properties for Debezium SQL Server across versions 2.4–3.7
🦭
MariaDB Connector
All config properties for Debezium MariaDB across versions 2.4–3.7
📸
Snapshot Modes
initial, always, no_data, never, when_needed, recovery — explained with use cases and risks
📦
Event Envelope
Visual reference for the Debezium change event structure: before, after, op, source
🚨
Error Reference
Top Debezium errors with root causes and step-by-step fixes for all connectors