# BoxDB

> Experimental embedded SQLite client with validated logical types, native exact decimals and temporal values, and optional readable YAML storage.

Version 0 APIs and BoxDB storage contracts may change. Binary pages and records retain SQLite's standard encoding; native values and indexes require BoxDB's patched engine. JSON is an opaque validated document; SQL JSON/JSONB inspection is disabled.

## Usage skill

- [BoxDB skill](https://github.com/lebedev-nikita/boxdb/blob/main/.agents/skills/boxdb/SKILL.md): Client routing, SQL differences, transactions and file maintenance. Read it before integration work.

## Documentation

- [Documentation](https://lebedev-nikita.github.io/boxdb/docs/): Start using BoxDB: choose a client, learn SQL types and deploy your database.
- [Quickstart](https://lebedev-nikita.github.io/boxdb/docs/quickstart/): Create a typed BoxDB database, write two invoices and query an exact decimal total.
- [Why BoxDB?](https://lebedev-nikita.github.io/boxdb/docs/why-boxdb/): Use cases, tradeoffs and current boundaries of BoxDB for single-server applications.
- [SQL and types](https://lebedev-nikita.github.io/boxdb/docs/sql/): Declare typed columns, bind application values and understand BoxDB's SQL differences.
- [TypeScript](https://lebedev-nikita.github.io/boxdb/docs/clients/typescript/): Install BoxDB for Node.js and Bun; use asynchronous queries, transactions and cancellation.
- [Rust](https://lebedev-nikita.github.io/boxdb/docs/clients/rust/): Install the BoxDB Rust crate and work with typed queries, values and errors.
- [Go](https://lebedev-nikita.github.io/boxdb/docs/clients/go/): Install BoxDB's database/sql driver with its matching native library and cgo.
- [Command line](https://lebedev-nikita.github.io/boxdb/docs/clients/cli/): Install the BoxDB CLI, run SQL and inspect or recover database files.
- [Drizzle](https://lebedev-nikita.github.io/boxdb/docs/integrations/drizzle/): Use BoxDB with Drizzle queries, transactions, migrations and extended column builders.
- [Better Auth](https://lebedev-nikita.github.io/boxdb/docs/integrations/better-auth/): Configure BoxDB as a direct Better Auth database adapter and generate an initial schema.
- [db0](https://lebedev-nikita.github.io/boxdb/docs/integrations/db0/): Connect db0 to a BoxDB client or transaction handle.
- [Exact decimals](https://lebedev-nikita.github.io/boxdb/docs/decimals/): Exact DECIMAL arithmetic, precision, scale, explicit rounding and storage semantics.
- [Temporal values](https://lebedev-nikita.github.io/boxdb/docs/temporal/): Work with UTC instants, dates, times, calendar datetimes and intervals in BoxDB.
- [Storage and validation](https://lebedev-nikita.github.io/boxdb/docs/storage/): Understand binary SQLite, readable YAML, extended types and validation boundaries.
- [Change history](https://lebedev-nikita.github.io/boxdb/docs/history/): Record row changes as changesets, run commit triggers and undo or apply recorded changes.
- [SQL extensions](https://lebedev-nikita.github.io/boxdb/docs/extensions/): Built-in full-text and vector search, Unicode functions, regular expressions and exact arithmetic.
- [Migrations](https://lebedev-nikita.github.io/boxdb/docs/migrations/): Create and run SQL migrations and export schema through the CLI or application clients.
- [Errors and cancellation](https://lebedev-nikita.github.io/boxdb/docs/errors/): Handle BoxDB error codes, cancellation, transaction cleanup and client value mappings.
- [Deployment and backups](https://lebedev-nikita.github.io/boxdb/docs/deployment/): Deploy BoxDB on persistent local storage, back up committed data and plan upgrades.
- [Litestream replication](https://lebedev-nikita.github.io/boxdb/docs/replication/): Replicate and restore binary BoxDB databases with original Litestream.
- [Diagnostics and recovery](https://lebedev-nikita.github.io/boxdb/docs/recovery/): Check, repair and recover BoxDB files while understanding incomplete checks and possible data loss.
- [Benchmarks](https://lebedev-nikita.github.io/boxdb/docs/benchmarks/): Reproduce BoxDB benchmarks and interpret SQLite comparisons and historical measurements.
- [FAQ](https://lebedev-nikita.github.io/boxdb/docs/faq/): Answers about BoxDB compatibility, platforms, production status, JSON and storage.
- [Contributing](https://lebedev-nikita.github.io/boxdb/docs/contributing/): Report bugs, set up BoxDB development and submit focused contributions.
- [Security](https://lebedev-nikita.github.io/boxdb/docs/security/): Report a BoxDB security vulnerability privately and understand experimental release support.
- [Website development](https://lebedev-nikita.github.io/boxdb/docs/website/): Build the BoxDB documentation site and publish it with GitHub Pages.
- [npm releases](https://lebedev-nikita.github.io/boxdb/docs/releases/npm/): Build, verify and publish BoxDB's native npm packages.
- [Rust releases](https://lebedev-nikita.github.io/boxdb/docs/releases/rust/): Package, verify and publish the BoxDB Rust crate and bundled SQLite crates.

## Source

- [Repository](https://github.com/lebedev-nikita/boxdb)
- [Releases](https://github.com/lebedev-nikita/boxdb/releases)