Capture
Wait for change data capture event on MongoDB server.
type: "io.kestra.plugin.debezium.mongodb.Capture"
Replica set connection
id: "capture"
type: "io.kestra.plugin.debezium.mongodb.Capture"
snapshotMode: INITIAL
connectionString: mongodb://mongo_user:mongo_passwd@mongodb0.example.com:27017/?replicaSet=rs0
maxRecords: 100
Sharded connection
id: "capture"
type: "io.kestra.plugin.debezium.mongodb.Capture"
snapshotMode: INITIAL
connectionString: mongodb://mongo_user:mongo_passwd@mongos0.example.com:27017,mongos1.example.com:27017/
maxRecords: 100
Replica set SRV connection
id: "capture"
type: "io.kestra.plugin.debezium.mongodb.Capture"
snapshotMode: INITIAL
connectionString: mongodb+srv://mongo_user:mongo_passwd@mongos0.example.com/?replicaSet=rs0
maxRecords: 100
Sharded SRV connection
id: "capture"
type: "io.kestra.plugin.debezium.mongodb.Capture"
snapshotMode: INITIAL
connectionString: mongodb+srv://mongo_user:mongo_passwd@mongos0.example.com/
maxRecords: 100
YES
Defines connection string to mongodb replica set or sharded
YES
deleted
The name of deleted field if deleted is ADD_FIELD
.
YES
Hostname of the remote server.
YES
ADD_FIELD
ADD_FIELD
DROP
Specify how to handle key.
Possible settings are:
ADD_FIELD
: Add key(s) merged with columns.DROP
: Drop keys.
YES
ADD_FIELD
ADD_FIELD
DROP
Specify how to handle metadata.
Possible settings are:
ADD_FIELD
: Add metadata in a column namedmetadata
.DROP
: Drop metadata.
YES
Port of the remote server.
YES
TABLE
OFF
DATABASE
TABLE
Split table on separate output uris
.
Possible settings are:
TABLE
: This will split all rows by tables on output with namedatabase.table
DATABASE
: This will split all rows by databases on output with namedatabase
.OFF
: This will NOT split all rows resulting in a singledata
output.
YES
ADD_FIELD
ADD_FIELD
NULL
DROP
Specify how to handle deleted rows.
Possible settings are:
ADD_FIELD
: Add a deleted field as boolean.NULL
: Send a row with all values as null.DROP
: Don't send deleted row.
YES
The name of the MongoDB database collection excluded from which to stream the changes.
A list of regular expressions that match the collection namespaces (for example,
YES
An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to include in change event record values.
Fully-qualified names for columns are of the form databaseName.tableName.columnName. Do not also specify the includedColumns
connector configuration property."
YES
An optional, comma-separated list of regular expressions that match the names of databases for which you do not want to capture changes.
The connector captures changes in any database whose name is not in the excludedDatabases
. Do not also set the includedDatabases
connector configuration property.
YES
An optional, comma-separated list of regular expressions that match fully-qualified table identifiers for tables whose changes you do not want to capture.
The connector captures changes in any table not included in excludedTables
. Each identifier is of the form databaseName.tableName. Do not also specify the includedTables
connector configuration property.
YES
INLINE
RAW
INLINE
WRAP
The format of the output.
Possible settings are:
RAW
: Send raw data from debezium.INLINE
: Send a row like in the source with only data (remove after & before), all the columns will be present for each row.WRAP
: Send a row like INLINE but wrapped in arecord
field.
YES
true
Ignore DDL statement.
Ignore CREATE, ALTER, DROP and TRUNCATE operations.
YES
The name of the MongoDB database collection included from which to stream the changes.
A list of regular expressions that match the collection namespaces (for example,
YES
An optional, comma-separated list of regular expressions that match the fully-qualified names of columns to exclude from change event record values.
Fully-qualified names for columns are of the form databaseName.tableName.columnName. Do not also specify the excludedColumns
connector configuration property.
YES
An optional, comma-separated list of regular expressions that match the names of the databases for which to capture changes.
The connector does not capture changes in any database whose name is not in includedDatabases
. By default, the connector captures changes in all databases. Do not also set the excludedDatabases
connector configuration property.
YES
An optional, comma-separated list of regular expressions that match fully-qualified table identifiers of tables whose changes you want to capture.
The connector does not capture changes in any table not included in includedTables
. Each identifier is of the form databaseName.tableName. By default, the connector captures changes in every non-system table in each database whose changes are being captured. Do not also specify the excludedTables
connector configuration property.
YES
duration
The maximum duration waiting for new rows.
It's not an hard limit and is evaluated every second. It is taken into account after the snapshot if any.
YES
The maximum number of rows to fetch before stopping.
It's not an hard limit and is evaluated every second.
YES
PT1H
duration
The maximum duration waiting for the snapshot to ends.
It's not an hard limit and is evaluated every second. The properties 'maxRecord', 'maxDuration' and 'maxWait' are evaluated only after the snapshot is done.
YES
PT10S
duration
The maximum total processing duration.
It's not an hard limit and is evaluated every second. It is taken into account after the snapshot if any.
YES
metadata
The name of metadata field if metadata is ADD_FIELD
.
YES
Password on the remote server.
YES
Additional configuration properties.
Any additional configuration properties that is valid for the current driver.
YES
INITIAL
INITIAL
INITIAL_ONLY
NO_DATA
WHEN_NEEDED
Specifies the criteria for running a snapshot when the connector starts.
Possible settings are:
INITIAL
: The connector runs a snapshot only when no offsets have been recorded for the logical server name.INITIAL_ONLY
: The connector runs a snapshot only when no offsets have been recorded for the logical server name and then stops; i.e. it will not read change events from the binlog.NO_DATA
: The connector captures the structure of all relevant tables, performing all the steps described in the default snapshot workflow, except that it does not create READ events to represent the data set at the point of the connector’s start-up.WHEN_NEEDED
: The connector runs a snapshot upon startup whenever it deems it necessary. That is, when no offsets are available, or when a previously recorded offset specifies a binlog location or GTID that is not available in the server.
YES
debezium-state
The name of the Debezium state file stored in the KV Store for that namespace.
YES
Username on the remote server.
The number of fetched rows
The KV Store key under which the state of the database history is stored
The KV Store key under which the state of the offset is stored
URI of the generated internal storage file