MongoDB Collection
1. Overview
MongoDB is a scalable, flexible NoSQL document database platform known for its horizontal scaling and load balancing capabilities, which has given application developers an unprecedented level of flexibility and scalability.
1.1 Considerations
Please review the following considerations prior to setting up your MongoDB Collection data sync source:
We currently only support SCRAM authentication (Mongo 4.0+).
Syncs are column based. This means that you must flatten the MongoDB source document prior to sync by using a projection (See section 2: Projection (JSON Object)).
The column names used in the source must match elements on the root object, with the exception of "$" which can be used to retrieve the full document.
By default, MongoDB batch size is 101.
By default, bulk operations size is 5000.
Due to a conversion of doubles to decimals that occurs during the sync process, minor data losses may occur.
The following data types are not supported:
Binary Data
Regular Expression
DBPointer
JavaScript
JavaScript code with scope
Symbol
Min Key
Max Key
The following data types are supported with conversions:
ObjectID is supported, but converted to string
Object is supported, but converted to JSON
Array is supported, but converted to JSON
Timestamp is supported, but converted to 64-bit integers
The MongoDB Collection source supports batch syncs. (To enable real-time syncs with MongoDB, use the MongoDB Collection (Cinchy Event Triggered) source instead.)
2. Info Tab
You can review the parameters that can be found in the info tab below (Image 1).
Values
Title
Mandatory. Input a name for your data sync
MongoDB to Cinchy
Version
Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.
1.0.0
Parameters
3. 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.
Source
Mandatory. Select your source from the drop down menu.
MongoDB Collection
Connection String
Example (Default):
mongodb+srv://<username>:<password>@<mongo host URI>
Example (Against different database):
mongodb+srv://<username>:<password>@<mongo host URI>?authSource=<authentication_db>
Database
Blog
Collection
Article
Type
Query (JSON Object)
A query for retrieving your data. This option appears if you have selected db.collection.find().
Projection (JSON Object)
This option appears if you have selected db.collection.find(). Syncs are column based. This means that you must flatten the MongoDB source document prior to sync using a projection.
Pipeline (JSON Array of Objects)
Use SSL
Example Query
Example Projection
4. Next Steps
Configure your Destination
Define your Sync Behaviour.
Add in your Post Sync Scripts, if required.
Define your Permissions.
To run a real-time sync (using the Cinchy Event Triggered MongoDB Source), set up your Listener Config and enable it to begin your sync.
To run a batch sync, select Jobs > Start Job.
Appendix A
Data Types
The MongoDB Collection Data Source obtains BSON documents from MongoDB. BSON, short for Binary JSON, is a binary-encoded serialization of JSON-like documents. Like JSON, BSON supports the embedding of documents and arrays
within other documents and arrays. BSON also contains extensions that allow representation of data types that are not part of the JSON spec. For example BSON makes a distinction between Int32 and Int64.
The following table shows how MongoDB data types are translated in Cinchy.
Double
Number
Supported
String
Text
Supported
Object
Text (JSON)
Supported
Array
Text (JSON)
Supported
Binary Data
Binary
Unsupported
ObjectId
Text
Supported
Boolean
Bool
Supported
Date
Date
Supported
Null
-
Supported
RegEx
-
Unsupported
JavaScript
-
Unsupported
Timestamp
Number
Supported
32-bit Integer
Number
Supported
64-bit Integer
Number
Supported
Decimal28
Number
Supported
Min Key
-
Unsupported
Max Key
-
Unsupported
-
Geography
Unsupported
-
Geometry
Unsupported
Last updated