| import ChangeLog from '../changelog/connector-cdc-mongodb.md'; |
| |
| # MongoDB CDC |
| |
| > MongoDB CDC source connector |
| |
| ## Support Those Engines |
| |
| > SeaTunnel Zeta<br/> |
| > Flink<br/> |
| |
| ## Key Features |
| |
| - [ ] [batch](../../concept/connector-v2-features.md) |
| - [x] [stream](../../concept/connector-v2-features.md) |
| - [x] [exactly-once](../../concept/connector-v2-features.md) |
| - [ ] [column projection](../../concept/connector-v2-features.md) |
| - [x] [parallelism](../../concept/connector-v2-features.md) |
| - [x] [support user-defined split](../../concept/connector-v2-features.md) |
| |
| ## Description |
| |
| The MongoDB CDC connector allows for reading snapshot data and incremental data from MongoDB database. |
| |
| ## Supported DataSource Info |
| |
| In order to use the Mongodb CDC connector, the following dependencies are required. |
| They can be downloaded via install-plugin.sh or from the Maven central repository. |
| |
| | Datasource | Supported Versions | Dependency | |
| |------------|--------------------|-------------------------------------------------------------------------------------------| |
| | MongoDB | universal | [Download](https://mvnrepository.com/artifact/org.apache.seatunnel/connector-cdc-mongodb) | |
| |
| ## Availability Settings |
| |
| 1.MongoDB version: MongoDB version >= 4.0. |
| |
| 2.Cluster deployment: replica sets or sharded clusters. |
| |
| 3.Storage Engine: WiredTiger Storage Engine. |
| |
| 4.Permissions:changeStream and read |
| |
| ```shell |
| use admin; |
| db.createRole( |
| { |
| role: "strole", |
| privileges: [{ |
| resource: { db: "", collection: "" }, |
| actions: [ |
| "splitVector", |
| "listDatabases", |
| "listCollections", |
| "collStats", |
| "find", |
| "changeStream" ] |
| }], |
| roles: [ |
| { role: 'read', db: 'config' } |
| ] |
| } |
| ); |
| |
| db.createUser( |
| { |
| user: 'stuser', |
| pwd: 'stpw', |
| roles: [ |
| { role: 'strole', db: 'admin' } |
| ] |
| } |
| ); |
| ``` |
| |
| ## Data Type Mapping |
| |
| The following table lists the field data type mapping from MongoDB BSON type to Seatunnel data type. |
| |
| | MongoDB BSON Type | SeaTunnel Data Type | |
| |-------------------|---------------------| |
| | ObjectId | STRING | |
| | String | STRING | |
| | Boolean | BOOLEAN | |
| | Binary | BINARY | |
| | Int32 | INTEGER | |
| | Int64 | BIGINT | |
| | Double | DOUBLE | |
| | Decimal128 | DECIMAL | |
| | Date | DATE | |
| | Timestamp | TIMESTAMP | |
| | Object | ROW | |
| | Array | ARRAY | |
| |
| For specific types in MongoDB, we use Extended JSON format to map them to Seatunnel STRING type. |
| |
| | MongoDB BSON type | SeaTunnel STRING | |
| |-------------------|----------------------------------------------------------------------------------------------| |
| | Symbol | {"_value": {"$symbol": "12"}} | |
| | RegularExpression | {"_value": {"$regularExpression": {"pattern": "^9$", "options": "i"}}} | |
| | JavaScript | {"_value": {"$code": "function() { return 10; }"}} | |
| | DbPointer | {"_value": {"$dbPointer": {"$ref": "db.coll", "$id": {"$oid": "63932a00da01604af329e33c"}}}} | |
| |
| **Tips** |
| |
| > 1.When using the DECIMAL type in SeaTunnel, be aware that the maximum range cannot exceed 34 digits, which means you should use decimal(34, 18).<br/> |
| |
| ## Source Options |
| |
| | Name | Type | Required | Default | Description | |
| |------------------------------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| | hosts | String | Yes | - | The comma-separated list of hostname and port pairs of the MongoDB servers. eg. `localhost:27017,localhost:27018` | |
| | username | String | No | - | Name of the database user to be used when connecting to MongoDB. | |
| | password | String | No | - | Password to be used when connecting to MongoDB. | |
| | database | List | Yes | - | Name of the database to watch for changes. If not set then all databases will be captured. The database also supports regular expressions to monitor multiple databases matching the regular expression. eg. `db1,db2`. | |
| | collection | List | Yes | - | Name of the collection in the database to watch for changes. If not set then all collections will be captured. The collection also supports regular expressions to monitor multiple collections matching fully-qualified collection identifiers. eg. `db1.coll1,db2.coll2`. | |
| | schema | | no | - | The structure of the data, including field names and field types, use single table cdc. | |
| | tables_configs | | no | - | The structure of the data, including field names and field types, use muliti table cdc. | |
| | connection.options | String | No | - | The ampersand-separated connection options of MongoDB. eg. `replicaSet=test&connectTimeoutMS=300000`. | |
| | batch.size | Long | No | 1024 | The cursor batch size. | |
| | poll.max.batch.size | Enum | No | 1024 | Maximum number of change stream documents to include in a single batch when polling for new data. | |
| | poll.await.time.ms | Long | No | 1000 | The amount of time to wait before checking for new results on the change stream. | |
| | heartbeat.interval.ms | String | No | 0 | The length of time in milliseconds between sending heartbeat messages. Use 0 to disable. | |
| | incremental.snapshot.chunk.size.mb | Long | No | 64 | The chunk size mb of incremental snapshot. | |
| | exactly_once | Boolean| No | false | Enable exactly once semantic. Enabling this may cause an out-of-memory risk during the large table snapshot stage in recovery. | |
| | common-options | | No | - | Source plugin common parameters, please refer to [Source Common Options](../source-common-options.md) for details. | |
| |
| ### Tips |
| |
| > 1.If the collection changes at a slow pace, it is strongly recommended to set an appropriate value greater than 0 for the heartbeat.interval.ms parameter. When we recover a Seatunnel job from a checkpoint or savepoint, the heartbeat events can push the resumeToken forward to avoid its expiration.<br/> |
| > 2.MongoDB has a limit of 16MB for a single document. Change documents include additional information, so even if the original document is not larger than 15MB, the change document may exceed the 16MB limit, resulting in the termination of the Change Stream operation.<br/> |
| > 3.It is recommended to use immutable shard keys. In MongoDB, shard keys allow modifications after transactions are enabled, but changing the shard key can cause frequent shard migrations, resulting in additional performance overhead. Additionally, modifying the shard key can also cause the Update Lookup feature to become ineffective, leading to inconsistent results in CDC (Change Data Capture) scenarios.<br/> |
| > 4.`schema` `tables_configs` are mutually exclusive, and one must be configured at a time. |
| |
| ## Change Streams |
| |
| [**Change Stream**](https://www.mongodb.com/docs/v5.0/changeStreams/) is a new feature provided by MongoDB 3.6 for replica sets and sharded clusters that allows applications to access real-time data changes without the complexity and risk of tailing the oplog. |
| Applications can use change streams to subscribe to all data changes on a single collection, a database, or an entire deployment, and immediately react to them. |
| |
| **Lookup Full Document for Update Operations** is a feature provided by **Change Stream** which can configure the change stream to return the most current majority-committed version of the updated document. Because of this feature, we can easily collect the latest full document and convert the change log to Changelog Stream. |
| |
| The format of the data captured by delete events in change streams: [delete envet](https://www.mongodb.com/docs/v5.0/reference/change-events/delete/) |
| ``` |
| { |
| "_id": { <Resume Token> }, |
| "operationType": "delete", |
| "clusterTime": <Timestamp>, |
| "ns": { |
| "db": "engineering", |
| "coll": "users" |
| }, |
| "documentKey": { |
| "_id": ObjectId("599af247bb69cd89961c986d") |
| } |
| } |
| ``` |
| The fullDocument document is omitted as the document no longer exists at the time the change stream cursor sends the delete event to the client. |
| |
| ## How to Create a MongoDB CDC Data Synchronization Jobs |
| |
| ### CDC Data Print to Client |
| |
| The following example demonstrates how to create a data synchronization job that reads cdc data from MongoDB and prints it on the local client: |
| |
| ```hocon |
| env { |
| # You can set engine configuration here |
| parallelism = 1 |
| job.mode = "STREAMING" |
| checkpoint.interval = 5000 |
| } |
| |
| source { |
| MongoDB-CDC { |
| hosts = "mongo0:27017" |
| database = ["inventory"] |
| collection = ["inventory.products"] |
| username = stuser |
| password = stpw |
| schema = { |
| table = "inventory.products" |
| fields { |
| "_id" : string, |
| "name" : string, |
| "description" : string, |
| "weight" : string |
| } |
| } |
| } |
| } |
| |
| # Console printing of the read Mongodb data |
| sink { |
| Console { |
| parallelism = 1 |
| } |
| } |
| ``` |
| |
| ## CDC Data Write to MysqlDB |
| |
| The following example demonstrates how to create a data synchronization job that reads cdc data from MongoDB and write to mysql database: |
| |
| ```hocon |
| env { |
| # You can set engine configuration here |
| parallelism = 1 |
| job.mode = "STREAMING" |
| checkpoint.interval = 5000 |
| } |
| |
| source { |
| MongoDB-CDC { |
| hosts = "mongo0:27017" |
| database = ["inventory"] |
| collection = ["inventory.products"] |
| username = stuser |
| password = stpw |
| schema = { |
| table = "inventory.products" |
| fields { |
| "_id" : string, |
| "name" : string, |
| "description" : string, |
| "weight" : string |
| } |
| } |
| } |
| } |
| |
| sink { |
| jdbc { |
| url = "jdbc:mysql://mysql_cdc_e2e:3306" |
| driver = "com.mysql.cj.jdbc.Driver" |
| user = "st_user" |
| password = "seatunnel" |
| |
| generate_sink_sql = true |
| # You need to configure both database and table |
| database = mongodb_cdc |
| table = products |
| primary_keys = ["_id"] |
| } |
| } |
| ``` |
| |
| ## Multi-table Synchronization |
| |
| The following example demonstrates how to create a data synchronization job that read the cdc data of multiple library tables mongodb and prints it on the local client: |
| |
| ```hocon |
| env { |
| # You can set engine configuration here |
| parallelism = 1 |
| job.mode = "STREAMING" |
| checkpoint.interval = 5000 |
| } |
| |
| source { |
| MongoDB-CDC { |
| hosts = "mongo0:27017" |
| database = ["inventory"] |
| collection = ["inventory.products", "inventory.orders"] |
| username = superuser |
| password = superpw |
| tables_configs = [ |
| { |
| schema { |
| table = "inventory.products" |
| fields { |
| "_id" : string, |
| "name" : string, |
| "description" : string, |
| "weight" : string |
| } |
| } |
| }, |
| { |
| schema { |
| table = "inventory.orders" |
| fields { |
| "_id" : string, |
| "order_number" : int, |
| "order_date" : string, |
| "quantity" : int, |
| "product_id" : string |
| } |
| } |
| } |
| ] |
| } |
| } |
| |
| # Console printing of the read Mongodb data |
| sink { |
| Console { |
| } |
| } |
| ``` |
| |
| ## Format of real-time streaming data |
| |
| ```shell |
| { |
| _id : { <BSON Object> }, // Identifier of the open change stream, can be assigned to the 'resumeAfter' parameter for subsequent resumption of this change stream |
| "operationType" : "<operation>", // The type of change operation that occurred, such as: insert, delete, update, etc. |
| "fullDocument" : { <document> }, // The full document data involved in the change operation. This field does not exist in delete operations |
| "ns" : { |
| "db" : "<database>", // The database where the change operation occurred |
| "coll" : "<collection>" // The collection where the change operation occurred |
| }, |
| "to" : { // These fields are displayed only when the operation type is 'rename' |
| "db" : "<database>", // The new database name after the change |
| "coll" : "<collection>" // The new collection name after the change |
| }, |
| "source":{ |
| "ts_ms":"<timestamp>", // The timestamp when the change operation occurred |
| "table":"<collection>" // The collection where the change operation occurred |
| "db":"<database>", // The database where the change operation occurred |
| "snapshot":"false" // Identify the current stage of data synchronization |
| }, |
| "documentKey" : { "_id" : <value> }, // The _id field value of the document involved in the change operation |
| "updateDescription" : { // Description of the update operation |
| "updatedFields" : { <document> }, // The fields and values that the update operation modified |
| "removedFields" : [ "<field>", ... ] // The fields and values that the update operation removed |
| } |
| "clusterTime" : <Timestamp>, // The timestamp of the Oplog log entry corresponding to the change operation |
| "txnNumber" : <NumberLong>, // If the change operation is executed in a multi-document transaction, this field and value are displayed, representing the transaction number |
| "lsid" : { // Represents information related to the Session in which the transaction is located |
| "id" : <UUID>, |
| "uid" : <BinData> |
| } |
| } |
| ``` |
| |
| ## Changelog |
| |
| <ChangeLog /> |
