Guides

Feature-focused walkthroughs. Each guide is self-contained — pick what you need.

• Models & fields — declaring models, every Field(...) keyword, table naming, schema evolution.
• CRUD — insert, get, save, update, delete, and bulk operations.
• Querying — the typed query DSL, operators, terminal methods, indexes.
• Relationships — Relationship(...) and db.related().
• Joins — INNER/LEFT joins across two or more models.
• Transactions — atomic multi-table writes, the write-ahead journal, optimistic concurrency.
• Storage format — exactly what lives on disk and how writes are durable.
• Locking model — in-process and cross-process locking.

Just want the full API? Jump to the API reference.