Choose a task for your project. Each guide explains the relevant concepts and shows how to use them. For a first example, start with Onboarding and Getting started. For an API, supported query shape, or configuration option, use Reference.
Understand the engine and sync
- How it works: follow a query from its definition to a maintained result.
- Architecture: understand the browser, API authority, and data tier in a synced app.
- Embedded replica runtime: keep SQLite and live queries inside your Rust process.
- Browser client choices: choose local rows, remote results, normalized sync, or optimistic writes.
Define data and live queries
- Schema and migrations: define database tables and generate a typed schema.
- Queries and fragments: name shared queries and connect results to components.
- Live aggregates: maintain counts, sums, and grouped results.
- Pagination: load more rows with stable ordering.
- Pinned queries: keep server results available between requests.
- Refine schema types: give database values application-specific types.
- Rust delta consumer: apply individual changes to your own result structure.
Add writes and authorization
- Mutators: share write logic between the browser and server.
- Authorization: scope queries and writes to the authenticated user.
- Rejected writes: show failures after the server rejects a prediction.
- Folded mutations: combine frequent optimistic writes.
- Undo and redo: reverse application actions.
- Background writes: change authoritative data from a server or job.
Connect the user interface
- TanStack Start: connect the router, providers, and live queries.
- Preloads and SSR: prepare data before navigation and render it on the server.
- Local-only tables: keep drafts and selections on the device.
- Local persistence: restore device data after a reload.
- Fine-grained reactivity: subscribe to the values a component needs.
- Typeahead: update query arguments as the user types.
- LLM streams and agents: stream generated content into live views.
Connect data sources and deploy
- PostgreSQL source: keep Postgres authoritative through the preview integration.
- Deployment: choose a topology and understand its recovery requirements.
- Cloud quickstart: create a hosted deployment.
- Cloud connections: connect applications and tools to a deployment.
- Cloud operations: inspect deployment state and switch managed plans.
For ordinary SQL requests, start with the SQL client reference. SQL-only use does not require browser sync or optimistic mutators.
Test and diagnose
- Testing: exercise queries, mutations, and synchronization.
- Devtools: inspect subscriptions and optimistic state.
- Troubleshooting: identify setup, query, and sync errors.
The sidebar groups guides by topic. The optional integration filter narrows the list to Engine & SQL or Synced apps.