MongoDB

Supports:

  • ✅ Models
  • ✅ Model sync destination
  • ✅ Bulk sync source

Connection

Configuration

NameTypeDescriptionRequired
change_detectionbooleanUse change stream for bulk syncsfalse
databasestringAuth databasefalse
hostsstringHostname(s)true
paramsstringAdditional parameters

Additional connection parameters, formatted as a query string
false
passwordstringPasswordfalse
srvbooleanConnect using SRV record?false
sslbooleanUse TLS/SSLfalse
usernamestringUsernamefalse

Example

{
"name": "MongoDB connection",
"type": "mongodb",
"configuration": {
"change_detection": false,
"database": "",
"hosts": "mongodb.example.net",
"params": "",
"password": "password",
"srv": false,
"ssl": false,
"username": "admin"
}
}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
aggregationstringfalse
collectionstringCollectiontrue
databasestringDatabasetrue
querystringfalse

Example

{
...
"configuration": {
"aggregation": "",
"collection": "users",
"database": "public",
"query": "db.users.find({\"name.family\": \"Smith\"})"
}
}

Target

MongoDB connections may be used as the destination in a model sync.

Target creation

MongoDB connections may be used to create a new target for a model sync. The following parameters are required to create a new target:

NAMEDESCRIPTIONENUM
nameCollection namefalse

Bulk Sync

Source

MongoDB connections may be used as a bulk sync source. No additional configuration options are required.