Mongo event
Overview
The MongoDB Event stream source works similar to Cinchy's Change Data Capture functionality. The listener subscribes to monitor the change stream of a specific collection in the database of the MongoDB server. Any actions performed on document(s) inside of that collection are picked up by the listener and sent to the queue.
Limitations
To use change streams in MongoDB, there are a few requirements your environment must meet.
The database must be in a replica set or sharded cluster.
The database must use the WiredTiger storage engine.
The replica set or sharded cluster must use replica set protocol version 1.
The MongoDB Event source supports real-time syncs.
Info tab
You can find the parameters in the Info tab below (Image 1).
Values
Parameter | Description | Example |
---|---|---|
Title | Mandatory. Input a name for your data sync | Mongo Event to Cinchy |
Variables | Optional. Review our documentation on Variables here for more information about this field. | |
Permissions | Data syncs are role based access systems where you can give specific groups read, write, execute, and/or all of the above with admin access. Inputting at least an Admin Group is mandatory. |
![](https://platform.docs.cinchy.com/~gitbook/image?url=https%3A%2F%2F3728216363-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FuXTzhcF5GwEVWPr9Y2dX%252Fuploads%252FvqR5ztYgwvtL2ykyYMll%252Fimage.png%3Falt%3Dmedia%26token%3D16010f7f-a8e3-43d9-9489-62e55a612606&width=768&dpr=4&quality=100&sign=24646fe1&sv=1)
Source tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
The following parameters will help to define your data sync source and how it functions.
Parameter | Description | Example |
---|---|---|
Source | Mandatory. Select your source from the drop down menu. | MongoDB Event |
![](https://platform.docs.cinchy.com/~gitbook/image?url=https%3A%2F%2F3728216363-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FuXTzhcF5GwEVWPr9Y2dX%252Fuploads%252FV40etjRfNoTuJ2GHEc0Y%252Fimage.png%3Falt%3Dmedia%26token%3D0d406cf5-9b8f-405e-986d-53c3bcb32395&width=768&dpr=4&quality=100&sign=d5e58a0&sv=1)
Next steps
Configure your Destination
Define your Sync Actions.
Add in your Post Sync Scripts, if required.
If more than one listener is needed for a real-time sync, configure it/them via the Listener Config table.
To run a real-time sync, enable your Listener from the Execution tab.
Last updated