Skip to content

Latest commit

 

History

History
65 lines (32 loc) · 4.76 KB

rx-storage.md

File metadata and controls

65 lines (32 loc) · 4.76 KB

RxStorage

RxDB is not a self contained database. Instead the data is stored in an implementation of the RxStorage interface. This allows you to switch out the underlying data layer, depending on the JavaScript environment and performance requirements. For example you can use the SQLite storage for a capacitor app or you can use the Dexie.js RxStorage to store data in IndexedDB in a browser based application. There are also storages for other JavaScript runtimes like Node.js, React-Native, NativeScript and more.

Implementations

Dexie.js

The Dexie.js based storage is based on the Dexie.js IndexedDB wrapper. It stores the data inside of a browsers IndexedDB database and has a very small bundle size. If you are new to RxDB, you should start with the Dexie.js RxStorage. Read more

LokiJS

The LokiJS based storage is based on the LokiJS database. It has the special behavior of loading all data into memory at app start and therefore has the best performance when running operations over a small to mid sized dataset. Read more

Memory

A storage that stores the data in as plain data in the memory of the JavaScript process. Really fast and can be used in all environments. Read more

IndexedDB [premium]

The IndexedDB RxStorage is based on plain IndexedDB. This has the best performance of all other non-in-memory storage, when RxDB is used inside of a browser. Read more

SQLite [premium]

The SQLite storage has the best performance when RxDB is used on Node.js, Electron, React Native, Cordova or Capacitor. Read more

FoundationDB

To use RxDB on the server side, the FoundationDB RxStorage provides a way of having a secure, fault-tolerant and performant storage. Read more

Worker [premium]

The worker RxStorage is a wrapper around any other RxStorage which allows to run the storage in a WebWorker (in browsers) or a Worker Thread (in Node.js). By doing so, you can take CPU load from the main process and move it into the worker's process which can improve the perceived performance of your application. Read more

SharedWorker [premium]

The worker RxStorage is a wrapper around any other RxStorage which allows to run the storage in a SharedWorker (only in browsers). By doing so, you can take CPU load from the main process and move it into the worker's process which can improve the perceived performance of your application. Read more

Remote

The Remote RxStorage is made to use a remote storage and communicate with it over an asynchronous message channel. The remote part could be on another JavaScript process or even on a different host machine. Read more

Sharding [premium]

On some RxStorage implementations (like IndexedDB), a huge performance improvement can be done by sharding the documents into multiple database instances. With the sharding plugin you can wrap any other RxStorage into a sharded storage. Read more

Memory Synced [premium]

The memory synced RxStorage is a wrapper around any other RxStorage. The wrapper creates an in-memory storage that is used for query and write operations. This memory instance is replicated with the underlying storage for persistence. The main reason to use this is to improve initial page load and query/write times. This is mostly useful in browser based applications. Read more

Localstorage Meta Optimizer [premium]

The RxStorage Localstorage Meta Optimizer is a wrapper around any other RxStorage. The wrapper uses the original RxStorage for normal collection documents. But to optimize the initial page load time, it uses localstorage to store the plain key-value metadata that RxDB needs to create databases and collections. This plugin can only be used in browsers. Read more

Electron IpcRenderer & IpcMain

To use RxDB in electron, it is recommended to run the RxStorage in the main process and the RxDatabase in the renderer processes. With the rxdb electron plugin you can create a remote RxStorage and consume it from the renderer process. Read more