Filesystem Node RxStorage

The Filesystem Node RxStorage for RxDB is built on top of the Node.js Filesystem API. It stores data in plain JSON/txt files like any "normal" database does. It is a bit faster compared to the SQLite storage and its setup is less complex. Using the same database folder in parallel with multiple Node.js processes is supported when you set multiInstance: true while creating the RxDatabase.

Pros

• Easier setup compared to SQLite
• Fast

This plugin is part of RxDB Premium. It is not part of the default RxDB module.

Node/Native Storages (values in milliseconds, lower is better)

Storage	Time to first insert	Insert 500 docs (bulk)	Find 3000 docs by ID (bulk)	Insert 50 docs (serial)	Find 50 docs by ID (serial)	Find 3000 docs by query	Find 3000 docs by query (parallel)	Count 3000 docs (4x)
Filesystem Node.js	3.33	5.78	22.04	2.42	5	19.37	21.08	1.83
SQLite (node:sqlite)	5.2	8.62	26.41	10.84	2.67	19.68	20.38	2.01
Memory	1.25	0.31	5.37	1.56	0.55	2.82	4.02	0.28

Loading chart...

Usage

import {
    createRxDatabase
} from 'rxdb';
import {
    getRxStorageFilesystemNode
} from 'rxdb-premium/plugins/storage-filesystem-node';
import path from 'path';
 
const myRxDatabase = await createRxDatabase({
    name: 'exampledb',
    storage: getRxStorageFilesystemNode({
        basePath: path.join(__dirname, 'my-database-folder'),
        /**
         * Set inWorker=true if you use this RxStorage
         * together with the WebWorker plugin.
         */
        inWorker: false
    })
});
/* ... */

FAQ

Does RxDB support single-file storage architectures in Node environments?

The native getRxStorageFilesystemNode adapter does not compile documents into a single monolithic file (like SQLite), but instead serializes and persists document data as distinct JSON/text files directly representing the database tree on the disk. For strict single-file architectures in Node.js, you must mount the specialized SQLite RxStorage plugin, which wraps the entire database state into a single portable .sqlite file efficiently using Node's native sqlite bindings.