MongoDB Collection

This page details the connection configuration for using a MongoDB Collection as a data sync source.


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.

Using MongoDB as a data source was added as part of Cinchy v5.5.

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

2. Basic Parameters

Input the following basic parameters for your MongoDB Collection source (Image 1):

Example Query

// query: where "Price" is less than 10

blog> db.Articles.find({ "Price": { "$lt": 10 } })
    _id: ObjectId("63d8137bd755fcdeed234403"),
    Name: 'Shirt',
    Price: 9.95,
    Details: { Color: 'White', Size: 'Small' },
    Stock: 61

Example Projection

// Flatten the document

blog> db.Articles.find({}, { Name: 1, Price: 1, Color: "Details.Color", Size: "Details.Size", Stock: 1 })
    _id: ObjectId("63d812afd755fcdeed234402"),
    Name: 'Shirt',
    Price: 19.95,
    Stock: 12,
    Color: 'Details.Color',
    Size: 'Details.Size'
    _id: ObjectId("63d8137bd755fcdeed234403"),
    Name: 'Shirt',
    Price: 9.95,
    Stock: 61,
    Color: 'Details.Color',
    Size: 'Details.Size'

Example Connections UI

3. Schema

  1. Add in your applicable column(s) (Image 2). See the documentation here for further details on each column type.

Note that the Names field is Name is case sensitive and preserves spaces.

Geography and Geometry types are not supported by the MongoDB connector.

3.1 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 sup­ports the em­bed­ding of doc­u­ments and ar­rays

with­in other documents and arrays. BSON also con­tains extensions that allow representation of data types that are not part of the JSON spec. For ex­ample BSON makes a distinction between Int32 and Int64.

The following table shows how MongoDB data types are translated in Cinchy.

Last updated