Skip to main content

MongoDB RxStorage (beta)

RxDB MongoDB RxStorage is an RxDB RxStorage that allows you to use MongoDB as the underlying storage engine for your RxDB database. With this you can take advantage of MongoDB's features and scalability while benefiting from RxDB's real-time data synchronization capabilities.

MongoDB storage

The storage is made to work with any plain MongoDB Server, MongoDB Replica Set, Sharded MongoDB Cluster or Atlas Cloud Database.

Limitations of the MongoDB RxStorage​

  • Multiple Node.js servers using the same MongoDB database is currently not supported
  • RxAttachments are currently not supported
  • Doing non-RxDB writes on the MongoDB database is not supported. RxDB expects all writes to come from RxDB which update the required metadata. Doing non-RxDB writes can confuse the RxDatabase and lead to undefined behavior. But you can perform read-queries on the MongoDB storage from the outside at any time.

Using the MongoDB RxStorage​

To use the storage, you simply import the getRxStorageMongoDB method and use that when creating the RxDatabase. The connection parameter contains the MongoDB connection string.

import {
    createRxDatabase
} from 'rxdb';
import {
    getRxStorageMongoDB
} from 'rxdb/plugins/storage-mongodb';

const myRxDatabase = await createRxDatabase({
    name: 'exampledb',
    storage: getRxStorageMongoDB({
        /**
         * MongoDB connection string
         * @link https://www.mongodb.com/docs/manual/reference/connection-string/
         */
        connection: 'mongodb://localhost:27017,localhost:27018,localhost:27019'
    })
});