How pubkey/rxdb works
RxDB is a local-first reactive NoSQL database for JavaScript. An application defines a schema, creates a database and collections, writes documents, and runs queries; the storage abstraction executes persistence while change streams support reactive updates and optional multi-instance coordination. Replication synchronizes local data with external systems through a shared protocol and adapter plugins. The README also documents backup, attachments, state, migrations, and other extensions. Core links use sampled source references; unsampled plugin relationships are shown only where documented.
Main entry points: rx-collection.ts Collections · rx-storage-helper.ts Storage Interface · rx-query.ts Reactive Queries · rx-query-helper.ts Query Preparation
Components 22
Database Core
- Database API
src/rx-database.ts - Collections
src/rx-collection.ts - Documents
src/rx-document.ts - Schema Handling
src/rx-schema-helper.ts - Change Events
src/rx-change-event.ts
Query and Storage
- Reactive Queries
src/rx-query.ts - Query Preparation
src/rx-query-helper.ts - Query Planner
src/query-planner.ts - Custom Indexes
src/custom-index.ts - Storage Interface
src/rx-storage-helper.ts - Memory Storage
src/plugins/storage-memory/rx-storage-instance-memory.ts - LocalStorage
src/plugins/storage-localstorage/rx-storage-instance-localstorage.ts - Multi-instance Events
src/rx-storage-multiinstance.ts
Replication and Sync
- Replication Protocol
src/replication-protocol/index.ts - Sync Adapters
src/plugins/replication
Feature Plugins
- Attachments
src/plugins/attachments - Backup
src/plugins/backup/index.ts - Reactive State
src/plugins/state - Schema Migration
src/plugins/migration-schema - Pipeline Middleware
src/plugins/pipeline/rx-pipeline.ts - React Integration
src/plugins/react
Other components
- JavaScript App
Connections 23
- JavaScript App → Database API: uses
README.md - Database API → Collections: opens
- Collections → Schema Handling: validates with
src/rx-schema-helper.ts - Collections → Documents: creates
- Collections → Reactive Queries: queries
- Reactive Queries → Query Preparation: prepares
src/rx-query.ts - Query Preparation → Query Planner: plans with
src/rx-query-helper.ts - Query Planner → Schema Handling: reads schema
src/query-planner.ts - Query Preparation → Custom Indexes: uses indexes
- Collections → Storage Interface: persists through
- Storage Interface → Memory Storage: dispatches to
src/plugins/storage-memory/rx-storage-instance-memory.ts - Storage Interface → LocalStorage: dispatches to
src/plugins/storage-localstorage/rx-storage-instance-localstorage.ts - Storage Interface → Multi-instance Events: coordinates
src/rx-storage-multiinstance.ts - Reactive Queries → Change Events: subscribes to
- Replication Protocol → Storage Interface: uses
src/replication-protocol/index.ts - Sync Adapters → Replication Protocol: implements
README.md - JavaScript App → Sync Adapters: configures sync
README.md - Replication Protocol → Attachments: handles attachments
src/replication-protocol/index.ts - JavaScript App → Backup: backs up data
README.md - JavaScript App → Reactive State: uses state
README.md - JavaScript App → Schema Migration: migrates schemas
README.md - JavaScript App → Pipeline Middleware: registers hooks
README.md - JavaScript App → React Integration: integrates with