Package Exports

mongodb-data-sync

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mongodb-data-sync) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mongodb-data-sync

In MongoDB having duplicate data between multiple collections is not an uncommon thing, It is efficient for searching, sorting or event for just project fields.

handling this duplicated data can be a pain in the ass, you will have to create jobs to sync the data, or do updates in place what makes the ref collection need to know about all the collections needed data from him . and we all know the bugs that can lead to.

mongodb-data-sync comes to solve this problem by letting you declare the dependencies in a logical place in your applications (for instance where you declare your schemas ) and sync the data in almost real-time.

mongodb-data-sync was designed to do all the updates and synchronization with minimum overhead on the database and do most of the checks in memory.

Notice

mongodb-data-sync is still experimental and hasn't been tested on production yet

requirements

MongoDB v3.6 or higher replaica set
nodejs 7.6 or higher

Architecture

mongodb-data-sync built from 2 parts.

The server(there can only be one)- this what runs all the updates logic,don't use more than 1 process, it was designed to work as a single process and knows from where to continue after restart, crash
The SDK - responsible for manging the database dependencies of the application ,

Instructions

The Instructions will for the 2 parts separately the server that runs the logic and the SDK that run the communication between your app and the server

Server

Run

npm install mongodb-data-sync -g

Then in the cmd run

mongodb-data-sync --key "some key" --url "mongodb connection url"

Options:

  -p, --port <port>       server port. 
  
  -d, --dbname <dbname>  the database name for the package. 
  
  -k, --key              API key to used for authentication of the SDK requests, required
  
  -u, --url              MongoDB connection url, required
  
  -h, --help             output usage information

that's it for running the server, let's jump to the SDK

SDK

You can look at the example on github

Install

npm install mongodb-data-sync -save

init

first initialize the client , do it as soon as possible in your app

const SynchronizerClient = require('mongodb-data-sync');

SynchronizerClient.init({
    dbName: String, // the DB name you want the synchronization to work on (required)
    serviceUrl: String, // the URL for the server you run on the previous stage (required),  
    apiKey: String, // this need to be the same key you declared in your server (required)
});

returns a Promise

getInstance

const synchronizerClientInstance = SynchronizerClient.getInstance({dbName: String}); // return an instance related to your db(its not a mongodb db instance) for dependncies oprations

addDependency

synchronizerClientInstance.addDependency({
   dependentCollection: String,// the dependent collection (required)
   refCollection: String, //the referenced collection (required)
   localField: String, // the dependent collection field to connect with (required)
   foreignField:String , // the referenced collection field to connect with, default _id ,using other field then _id will cuz an extra join for each check (optional)
   fieldsToSync: {}// the fields you want to update, the key is the field on the  dependentCollection and the value is for the refCollection
});

return Promise with the id of the Dependency

removeDependency

synchronizerClientInstance.removeDependency(id);

return Promise