# nookdb

> Schema-first, reactive, local-first database for Electron desktop apps. A Rust core (redb 2.x) under a fully-typed TypeScript surface: define your schema once with `s.*`, get inferred types everywhere, subscribe to live queries that re-render themselves, and bridge data across Electron processes with one line. MIT licensed.

## Docs

- [Quick start](https://nookdb.pages.dev/quick-start/): Install nookdb and open your first database in under a minute.
- [Schema DSL](https://nookdb.pages.dev/guides/schema-dsl/): The s.* schema builder — every field, constraint, and index shipped in v0.x.
- [Queries](https://nookdb.pages.dev/guides/queries/): find, findOne, count, update, delete — the shipped query surface for v0.x.
- [Reactive: live()](https://nookdb.pages.dev/guides/reactive-live/): Snapshot semantics, subscribe vs AsyncIterator, useLive() for React.
- [Migrations](https://nookdb.pages.dev/guides/migrations/): The version ledger, migrate status / up, and what's deferred.
- [CLI](https://nookdb.pages.dev/guides/cli/): nookdb command reference — backup, restore, migrate, inspect.
- [Electron bridge](https://nookdb.pages.dev/guides/electron-bridge/): Main + preload + renderer setup, schema-hash handshake, Authorizer.
- [Backup / restore](https://nookdb.pages.dev/guides/backup-restore/): Programmatic API, .nbkp format, atomic write, orchestrator pattern.
- [Migrating from sehawq.db v5](https://nookdb.pages.dev/guides/migrating-from-sehawq-v5/): A 50-line manual migration script — no CLI, no auto-import.
- [Errors](https://nookdb.pages.dev/reference/errors/): NookError hierarchy and the [kind] message convention.
- [API reference](https://nookdb.pages.dev/reference/api/): Top-level exports from the nookdb package.
- [.nbkp format](https://nookdb.pages.dev/reference/nbkp-format/): Wire layout of the portable backup file (format version 1).
- [Architecture overview](https://nookdb.pages.dev/architecture/overview/): How the Rust core, NAPI binding, TS surface, and Electron bridge fit together.
- [NookDB vs RxDB](https://nookdb.pages.dev/compare/rxdb/): A short, honest comparison of NookDB and RxDB.
- [NookDB vs Jazz](https://nookdb.pages.dev/compare/jazz/): A short, honest comparison of NookDB and Jazz.
- [NookDB vs Dexie](https://nookdb.pages.dev/compare/dexie/): A short, honest comparison of NookDB and Dexie.
- [NookDB vs better-sqlite3](https://nookdb.pages.dev/compare/better-sqlite3/): A short, honest comparison of NookDB and better-sqlite3.

## Full text

- [Full documentation, concatenated for ingestion](https://nookdb.pages.dev/llms-full.txt)