hk-vk RxDB Documentation
Authoritative reference documentation for RxDB, a reactive, local-first NoSQL database for JavaScript with offline support and explicit replication.
This file contains links to documentation sections following the llmstxt.org standard.
Available Resources
Table of Contents
Alternatives for realtime local-first JavaScript applications and local databases: Explore real-time, local-first JS alternatives to RxDB. Compare Firebase, Meteor, AWS, CouchDB, and more for robust, seamless web/mobile app develo...
RxDB as a Database in an Angular Application: Level up your Angular projects with RxDB. Build real-time, resilient, and responsive apps powered by a reactive NoSQL database right in the browser.
Build Smarter Offline-First Angular Apps - How RxDB Beats IndexedDB Alone: Discover how to harness IndexedDB in Angular with RxDB for robust offline apps. Learn reactive queries, advanced features, and more.
Benefits of RxDB & Browser Databases: Find out why RxDB is the go-to solution for browser databases. See how it boosts performance, simplifies replication, and powers real-time UIs.
Browser Storage - RxDB as a Database for Browsers: Explore RxDB for browser storage its advantages, limitations, and why it outperforms SQL databases in web applications for enhanced efficiency
Empower Web Apps with Reactive RxDB Data-base: Explore RxDB's reactive data-base solution for web and mobile. Enable offline-first experiences, real-time syncing, and secure data handling with e...
Embedded Database, Real-time Speed - RxDB: Unleash the power of embedded databases with RxDB. Explore real-time replication, offline access, and reactive queries for modern JavaScript apps.
RxDB - Firebase Realtime Database Alternative to Sync With Your Own Backend: Looking for a Firebase Realtime Database alternative? RxDB offers a fully offline, vendor-agnostic NoSQL solution with advanced conflict resolution...
RxDB - Firestore Alternative to Sync with Your Own Backend: Looking for a Firestore alternative? RxDB is a local-first, NoSQL database that syncs seamlessly with any backend, offers rich offline capabilities...
Supercharge Flutter Apps with the RxDB Database: Harness RxDB's reactive database to bring real-time, offline-first data storage and syncing to your next Flutter application.
RxDB - The Ultimate JS Frontend Database: Discover how RxDB, a powerful JavaScript frontend database, boosts offline access, caching, and real-time updates to supercharge your web apps.
ideas for articles: - storing and searching through 1mio emails in a browser database
RxDB In-Memory NoSQL - Supercharge Real-Time Apps: Discover how RxDB's in-memory NoSQL engine delivers blazing speed for real-time apps, ensuring responsive experiences and seamless data sync.
IndexedDB Alternative - Why RxDB is the Better Choice: Looking for an IndexedDB alternative? Discover why RxDB offers superior performance, ease of use, and built-in reactivity compared to raw IndexedDB.
IndexedDB Max Storage Size Limit - Detailed Best Practices: Learn how browsers enforce IndexedDB storage size limits, how to test and handle quota exceeded errors, and best practices for storing large amount...
RxDB - The Perfect Ionic Database: Supercharge your Ionic hybrid apps with RxDB's offline-first database. Experience real-time sync, top performance, and easy replication.
RxDB - Local Ionic Storage with Encryption, Compression & Sync: The best Ionic storage solution? RxDB empowers your hybrid apps with offline-first capabilities, secure encryption, data compression, and seamless ...
Local JavaScript Vector Database that works offline: Create a blazing-fast vector database in JavaScript. Leverage RxDB and transformers.js for instant, offline semantic search - no servers required!
RxDB as a Database in a jQuery Application: Level up your jQuery-based projects with RxDB. Build real-time, resilient, and responsive apps powered by a reactive NoSQL database right in the br...
JSON-Based Databases - Why NoSQL and RxDB Simplify App Development: Dive into how JSON-based databases power modern UI-centric apps, why NoSQL often outperforms SQL for dynamic data, how SQLite accommodates JSON, an...
RxDB - The JSON Database Built for JavaScript: Experience a powerful JSON database with RxDB, built for JavaScript. Store, sync, and compress your data seamlessly across web and mobile apps.
What is a Local Database and Why RxDB is the Best Local Database for JavaScript Applications: An in-depth exploration of local databases and why RxDB excels as a local-first solution for JavaScript applications.
Why Local-First Software Is the Future and its Limitations: Discover how local-first transforms web apps, boosts offline resilience, and why instant user feedback is becoming the new normal.
LocalStorage vs. IndexedDB vs. Cookies vs. OPFS vs. WASM-SQLite: Compare LocalStorage, IndexedDB, Cookies, OPFS, and WASM-SQLite for web storage, performance, limits, and best practices for modern web apps.
Using localStorage in Modern Applications - A Comprehensive Guide: This guide explores localStorage in JavaScript web apps, detailing its usage, limitations, and alternatives like IndexedDB and AsyncStorage.
Real-Time & Offline - RxDB for Mobile Apps: Explore RxDB as your reliable mobile database. Enjoy offline-first capabilities, real-time sync, and seamless integration for hybrid app development.
RxDB – The Ultimate Offline Database with Sync and Encryption: Discover how RxDB serves as a powerful offline database, offering real-time synchronization, secure encryption, and an offline-first approach for m...
Building an Optimistic UI with RxDB: Learn how to build an Optimistic UI with RxDB for instant and reliable UI updates on user interactions
RxDB as a Database for Progressive Web Apps (PWA): Discover how RxDB supercharges Progressive Web Apps with real-time sync, offline-first capabilities, and lightning-fast data handling.
RxDB as a Database for React Applications: Learn how the RxDB database supercharges React apps with offline access, real-time updates, and smooth data flow. Boost performance and engagement.
IndexedDB Database in React Apps - The Power of RxDB: Discover how RxDB simplifies IndexedDB in React, offering reactive queries, offline-first capability, encryption, compression, and effortless integ...
React Native Encryption and Encrypted Database/Storage: Secure your React Native app with RxDB encryption. Learn why it matters, how to implement encrypted databases, and best practices to protect user d...
ReactJS Storage - From Basic LocalStorage to Advanced Offline Apps with RxDB: Discover how to implement reactjs storage using localStorage for quick key-value data, then move on to more robust offline-first approaches with Rx...
What Really Is a Realtime Database?: Discover how RxDB merges realtime replication and dynamic updates to deliver seamless data sync across browsers, devices, and servers - instantly.
RxDB as a Database in a Vue.js Application: Level up your Vue projects with RxDB. Build real-time, resilient, and responsive apps powered by a reactive NoSQL database right in the browser.
IndexedDB Database in Vue Apps - The Power of RxDB: Learn how RxDB simplifies IndexedDB in Vue, offering reactive queries, offline-first capabilities, encryption, compression, and effortless integrat...
WebSockets vs Server-Sent-Events vs Long-Polling vs WebRTC vs WebTransport: Learn the unique benefits and pitfalls of each real-time tech. Make informed decisions on WebSockets, SSE, Polling, WebRTC, and WebTransport.
Zero Latency Local First Apps with RxDB – Sync, Encryption and Compression: Build blazing-fast, zero-latency local first apps with RxDB. Gain instant UI responses, robust offline capabilities, end-to-end encryption, and dat...
Backup: Easily back up your RxDB database to JSON files and attachments on the filesystem with the Backup Plugin - ensuring reliable Node.js data protection.
Capacitor Database Guide - SQLite, RxDB & More: Explore Capacitor's top data storage solutions - from key-value to real-time databases. Compare SQLite, RxDB, and more in this in-depth guide.
Cleanup: Optimize storage and speed up queries with RxDB's Cleanup Plugin, automatically removing old deleted docs while preserving replication states.
Contribute: Got a fix or fresh idea? Learn how to contribute to RxDB, run tests, and shape the future of this cutting-edge NoSQL database for JavaScript.
CRDT - Conflict-free replicated data type Database: Learn how RxDB's CRDT Plugin resolves document conflicts automatically in distributed systems, ensuring seamless merges and consistent data.
Data Migration: This documentation page has been moved to here
Development Mode: Enable checks & validations with RxDB Dev Mode. Ensure proper API use, readable errors, and schema validation during development. Avoid in production.
Downsides of Local First / Offline First: Discover the hidden pitfalls of local-first apps. Learn about storage limits, conflicts, and real-time illusions before building your offline solut...
Electron Database - Storage adapters for SQLite, Filesystem and In-Memory: Harness the database power of SQLite, Filesystem, and in-memory storage in Electron with RxDB. Build fast, offline-first apps that sync in real time.
Seamless Electron Storage with RxDB: Use the RxDB Electron Plugin to share data between main and renderer processes. Enjoy quick queries, real-time sync, and robust offline support.
Encryption: Explore RxDB's 🔒 encryption plugin for enhanced data security in web and native apps, featuring password-based encryption and secure storage.
Error Messages: Learn how RxDB throws RxErrors with codes and parameters. Keep builds lean, yet unveil full messages in development via the DevMode plugin.
Fulltext Search 👑: Master local fulltext search with RxDB's FlexSearch plugin. Enjoy real-time indexing, efficient queries, and offline-first support made easy.
Installation: Learn how to install RxDB via npm, configure polyfills, and fix global variable errors in Angular or Webpack for a seamless setup.
Key Compression: import {Steps} from '@site/src/components/steps';
Leader Election: RxDB comes with a leader-election which elects a leading instance between different instances in the same javascript runtime.
RxDB Logger Plugin - Track & Optimize: Take control of your RxDatabase logs. Monitor every write, query, or attachment retrieval to swiftly diagnose and fix performance bottlenecks.
Streamlined RxDB Middleware: Enhance your RxDB workflow with pre and post hooks. Quickly add custom validations, triggers, and events to streamline your asynchronous operations.
Seamless Schema Data Migration with RxDB: Upgrade your RxDB collections without losing data. Learn how to seamlessly migrate schema changes and keep your apps running smoothly.
Migration Storage: Effortlessly migrate your data between storages in RxDB using the Storage Migration plugin. Retain your documents when switching storages or major ...
RxDB - The Real-Time Database for Node.js: Discover how RxDB brings flexible, reactive NoSQL to Node.js. Scale effortlessly, persist data, and power your server-side apps with ease.
RxDB NoSQL Performance Tips: Skyrocket your NoSQL speed with RxDB tips. Learn about bulk writes, optimized queries, and lean plugin usage for peak performance.
Local First / Offline First: Local-First software stores data on client devices for seamless offline and online functionality, enhancing user experience and efficiency.
ORM: Like mongoose, RxDB has ORM capabilities which can be used to add specific behavior to documents a...
RxDB Docs: RxDB Documentation Overview
Creating Plugins: Creating your own plugin is very simple. A plugin is basically a javascript-object which overwrites or extends RxDB's internal classes, prototypes,...
Populate and Link Docs in RxDB: Learn how to reference and link documents across collections in RxDB. Discover easy population without joins and handle complex relationships.
Efficient RxDB Queries via Query Cache: Learn how RxDB's Query Cache boosts performance by reusing queries. Discover its default replacement policy and how to define your own.
Optimize Client-Side Queries with RxDB: Harness real-world data to fine-tune queries. The build-time RxDB Optimizer finds the perfect index, boosting query speed in any environment.
🚀 Quickstart: Learn how to build a realtime app with RxDB. Follow this quickstart for setup, schema creation, data operations, and real-time syncing.
React Native Database - Sync & Store Like a Pro: The ultimate React Native Database guide. Build offline-first, real-time apps with RxDB. SQLite storage, easy sync, and React hooks included.
React: import {Tabs} from '@site/src/components/tabs';
Signals & Custom Reactivity with RxDB: Level up reactivity with Angular signals, Vue refs, or Preact signals in RxDB. Learn how to integrate custom reactivity to power your dynamic UI.
RxDB 10.0.0 - Built for the Future: Experience faster, future-proof data handling in RxDB 10.0. Explore new storage interfaces, composite keys, and major performance upgrades.
RxDB 11 - WebWorker Support & More: RxDB 11.0 brings Worker-based storage for multi-core performance gains. Explore the major changes and migrate seamlessly to harness new speeds.
RxDB 12.0.0 - Clean, Lean & Mean: Upgrade to RxDB 12.0.0 for blazing-fast queries, streamlined replication, and better index usage. Explore new features and power up your app.
RxDB 13.0.0 - A New Era of Replication: Discover RxDB 13.0's brand-new replication protocol, faster performance, and real-time collaboration for a seamless offline-first experience.
RxDB 14.0 - Major Changes & New Features: Discover RxDB 14.0, a major release packed with API changes, improved performance, and streamlined storage, ensuring faster data operations than ever.
RxDB 15.0.0 - Major Migration Overhaul: Discover RxDB 15.0.0, featuring new migration strategies, replication improvements, and lightning-fast performance to supercharge your app.
RxDB 16.0.0 - Efficiency Redefined: Meet RxDB 16.0.0 - major refactorings, improved performance, and easy migrations. Experience a better, faster, and more stable database solution to...
RxDB 17.0.0: RxDB 17 introduces improved reactivity APIs, better debugging, breaking storage fixes, and multiple plugins graduating from beta.
Meet RxDB 8.0.0 - New Defaults & Performance: Discover how RxDB 8.0.0 boosts performance, simplifies schema handling, and streamlines reactive data updates for modern apps.
RxDB 9.0.0 - Faster & Simpler: Discover RxDB 9.0.0's streamlined plugins, top-level schema definitions, and improved dev-mode. Experience a simpler, faster real-time database.
Appwrite Realtime Sync for Local-First Apps: Sync RxDB with Appwrite for local-first apps. Supports real-time updates, offline mode, conflict resolution, and secure push/pull replication.
RxDB's CouchDB Replication Plugin: Replicate your RxDB collections with CouchDB the fast way. Enjoy faster sync, easier conflict handling, and flexible storage using this modern plugin.
Smooth Firestore Sync for Offline Apps: Leverage RxDB to enable real-time, offline-first replication with Firestore. Cut cloud costs, resolve conflicts, and speed up your app.
Google Drive Sync: Sync your RxDB application state with Google Drive.
GraphQL Replication: The GraphQL replication provides handlers for GraphQL to run replication with GraphQL as the transport layer.
HTTP Replication: Learn how to establish HTTP replication between RxDB clients and a Node.js Express server for data synchronization.
MongoDB Realtime Sync Engine for Local-First Apps: Build real-time, offline-capable apps with RxDB + MongoDB replication. Push/pull changes, use change streams, and keep data in sync across devices.
RxDB & NATS - Realtime Sync: Seamlessly sync your RxDB data with NATS for real-time, two-way replication. Handle conflicts, errors, and retries with ease.
Seamless P2P Data Sync: Discover how replication-webrtc ensures secure P2P data sync and real-time collaboration with RxDB. Explore the future of offline-first apps!
RxDB Server Replication: The Server Replication Plugin connects to the replication endpoint of an RxDB Server Replication Endpoint ...
Supabase Replication Plugin for RxDB - Real-Time, Offline-First Sync: Build real-time, offline-capable apps with RxDB + Supabase. Push/pull changes via PostgREST, stream updates with Realtime, and keep data in sync ac...
WebRTC P2P Replication with RxDB - Sync Browsers and Devices: Learn to set up peer-to-peer WebRTC replication with RxDB. Bypass central servers and enjoy secure, low-latency data sync across all clients.
Websocket Replication: With the websocket replication plugin, you can spawn a websocket server from a RxDB database in Node.js and replicate with it.
⚙️ RxDB realtime Sync Engine for Local-First Apps: Replicate data in real-time with RxDB's offline-first Sync Engine. Learn about efficient syncing, conflict resolution, and advanced multi-tab support.
Attachments: Learn how to store and manage binary data like images or files in RxDB using attachments. Discover features, performance benefits, encryption, comp...
Master Data - Create and Manage RxCollections: Discover how to create, manage, and migrate documents in RxCollections. Harness real-time data flows, secure encryption, and powerful performance i...
RxDatabase - The Core of Your Realtime Data: Get started with RxDatabase and integrate multiple storages. Learn to create, encrypt, and optimize your realtime database today.
RxDocument: Master RxDB's RxDocument - Insert, find, update, remove, and more for streamlined data handling in modern apps.
Master Local Documents in RxDB: Effortlessly store custom metadata and app settings in RxDB. Learn how Local Documents keep data flexible, secure, and easy to manage.
RxPipeline - Automate Data Flows in RxDB: Discover how RxPipeline automates your data workflows. Seamlessly process writes, manage leader election, and ensure crash-safe operations in RxDB.
RxQuery: Master RxQuery in RxDB - find, update, remove documents using Mango syntax, chained queries, real-time observations, indexing, and more.
Design Perfect Schemas in RxDB: Learn how to define, secure, and validate your data in RxDB. Master primary keys, indexes, encryption, and more with the RxSchema approach.
RxServer Scaling - Vertical or Horizontal: Discover vertical and horizontal techniques to boost RxServer. Learn multiple processes, worker threads, and replication for limitless performance.
RxDB Server - Deploy Your Data: Launch a secure, high-performance server on top of your RxDB database. Enable REST, replication endpoints, and seamless data syncing with RxServer.
RxState - Reactive Persistent State with RxDB: Get real-time, persistent state without the hassle. RxState integrates easily with signals and hooks, ensuring smooth updates across tabs and devices.
DenoKV RxStorage: With the DenoKV RxStorage layer for RxDB, you can run a fully featured NoSQL database on top of the [De...
RxDB Dexie.js Database - Fast, Reactive, Sync with Any Backend: Use Dexie.js to power RxDB in the browser. Enjoy quick setup, Dexie addons, and reliable storage for small apps or prototypes.
Blazing-Fast Node Filesystem Storage: Get up and running quickly with RxDB's Filesystem Node RxStorage. Store data in JSON, embrace multi-instance support, and enjoy a simpler database.
RxDB on FoundationDB - Performance at Scale: Combine FoundationDB's reliability with RxDB's indexing and schema validation. Build scalable apps with faster queries and real-time data.
Instant Performance with IndexedDB RxStorage: Choose IndexedDB RxStorage for unmatched speed and minimal build size. Perfect for fast-performing apps that demand reliable, lightweight data solu...
Fastest RxDB Starts - Localstorage Meta Optimizer: Wrap any RxStorage with localStorage metadata to slash initial load by up to 200ms. Unlock speed with this must-have RxDB Premium plugin.
RxDB LocalStorage - The Easiest Way to Persist Data in Your Web App: Discover how to quickly set up RxDB's LocalStorage-based storage as the recommended default. Learn its benefits, limitations, and why it’s perfect ...
Blazing-Fast Memory Mapped RxStorage: Boost your app's performance with Memory Mapped RxStorage. Query and write in-memory while seamlessly persisting data to your chosen storage.
Instant Performance with Memory Synced RxStorage: Accelerate RxDB with in-memory storage replicated to disk. Enjoy instant queries, faster loads, and unstoppable performance for your web apps.
Lightning-Fast Memory Storage for RxDB: Use Memory RxStorage for a high-performance, JavaScript in-memory database. Built for speed, making it perfect for unit tests and rapid prototyping.
Unlock MongoDB Power with RxDB: Combine RxDB's real-time sync with MongoDB's scalability. Harness the MongoDB RxStorage to seamlessly expand your database capabilities.
Supercharged OPFS Database with RxDB: Discover how to harness the Origin Private File System with RxDB's OPFS RxStorage for unrivaled performance and security in client-side data storage.
📈 Discover RxDB Storage Benchmarks: Explore real-world benchmarks comparing RxDB's persistent and semi-persistent storages. Discover which storage option delivers the fastest performa...
PouchDB RxStorage - Migrate for Better Performance: Discover why PouchDB RxStorage is deprecated in RxDB. Learn its legacy, performance drawbacks, and how to upgrade to a faster solution.
Remote RxStorage: The Remote RxStorage is made to use a remote storage and communicate with it over an asynchronous message channel.
Sharding RxStorage 👑: With the sharding plugin, you can improve the write and query times of some
RxStorageimplementations.Boost Performance with SharedWorker RxStorage: Tap into single-instance storage with RxDB's SharedWorker. Improve efficiency, cut duplication, and keep your app lightning-fast across tabs.
RxDB SQLite RxStorage for Hybrid Apps: Unlock seamless persistence with SQLite RxStorage. Explore usage in hybrid apps, compare performance, and leverage advanced features like attachments.
Turbocharge RxDB with Worker RxStorage: Offload RxDB queries to WebWorkers or Worker Threads, freeing the main thread and boosting performance. Experience smoother apps with Worker RxStor...
⚙️ RxStorage Layer - Choose the Perfect RxDB Storage for Every Use Case: Discover how RxDB's modular RxStorage lets you swap engines and unlock top performance, no matter the environment or use case.
RxDB Tradeoffs - Why NoSQL Triumphs on the Client: Uncover RxDB's approach to modern database needs. From JSON-based queries to conflict handling without transactions, learn RxDB's unique tradeoffs.
Schema Validation: RxDB has multiple validation implementations that can be used to ensure that your document data is always matching the provided JSON
Solving IndexedDB Slowness for Seamless Apps: Struggling with IndexedDB performance? Discover hidden bottlenecks, advanced tuning techniques, and next-gen storage like the File System Access API.
Testing: Writing tests for your RxDB application is crucial to ensure reliability. Because RxDB runs in many different environments (Browser, [Node.js](node...
Boost Your RxDB with Powerful Third-Party Plugins: Unleash RxDB's full power! Explore third-party plugins for advanced hooks, text search, Laravel Orion, Supabase replication, and more.
Transactions, Conflicts and Revisions: Learn RxDB's approach to local and replication conflicts. Discover how incremental writes and custom handlers keep your app stable and efficient.
TypeScript Setup: Use RxDB with TypeScript to define typed schemas, create typed collections, and build fully typed ORM methods. A quick step-by-step guide.
How Local-First and WebMCP make your app accessible to agents: Learn how pairing local-first databases with WebMCP gives AI Agents direct, schema-validated NoSQL access to your application data without brittle ...
Why NoSQL Powers Modern UI Apps: Discover how NoSQL enables offline-first UI apps. Learn about easy replication, conflict resolution, and why relational data isn't always necessary.
How to Use This Skill
Reference these resources when working with RxDB Documentation.