Guide¶
The Guide gathers the reference and background material — the how it works and the what exists — for when you've been through the Tutorial and want to understand the design decisions or look something up in the API.
In this section¶
| Page | What it covers |
|---|---|
| Architecture | Why a column is a value, the active-record trade-off, how builders become AST + phantom types, and the module map. |
| Repository | BaseRepository<Model> — typed CRUD + pagination, the 404 convention, relations (eager-loading, no N+1), and how to extend it for your domain. |
| Migrations | Alembic-style system: Schema IR, diff, codegen, DAG graph, runner, SQLite batch-mode, drift, and CLI. |
| API reference | The whole public surface in one place: column, select/insert/update/del, engine/session, joins, relations, serialization, migrations. |
Where to start¶
- Want to understand the choices behind tempest-db-js? → Architecture.
- Building a service data layer? → Repository.
- Need to evolve the schema safely? → Migrations.
- Just looking up a function? → API reference.