DocsFocused reading list
Engine & SQL
A focused reading list for browser and Rust views, Node backends, SQL, and the database runtime. Choose the starting point for your application.
Start hereRead the pages relevant to your project. Compare all starting points or browse the guides.
Onboarding · Start here
- Welcome to RindleMaintain query results as data changes. Use a local engine, embed a database, stream server results, or build an optimistic synced app.
- Is Rindle for you?Decide whether Rindle fits your application: what live queries replace, where they help, and which limits matter before you start.
- Getting startedChoose a first project, see what it requires, and follow a short sequence to a working result.
- Rindle for coding agentsChoose the Rindle integration that fits the task, fetch the relevant documentation, and keep runtime boundaries clear.
Onboarding · First steps
- Choose a browser clientCompare the standalone wasm store, remote result client, normalized sync, and optimistic app client.
- Reactive queries in the browserUse the wasm client to create an in-memory browser store, write rows, and subscribe to a typed live query without a server.
- Embed SQLite and live queriesUse the database runtime to capture SQL writes and deliver query changes in one process or across read workers.
- Backends & runtimesChoose where queries run: a browser, Node, a remote server, or an embedded Rust application.
- Raw Rust engine quickstartConnect a SQLite source to the raw Rust engine, supply row changes, and observe the maintained result.
Guides · Guide directory
Guides · Core concepts
Guides · Queries & schemas
- Schema & migrationsDefine database tables with SQL, apply migrations, and generate TypeScript types for live queries.
- Compose the UI with fragmentsDefine component data requirements, combine them into named queries, and subscribe through useRoot and useFragment.
- Live counts & aggregatesMaintain counts and grouped aggregates as rows change, including counts attached to related parent rows.
- Pagination & infinite scrollChoose a growing live window or keyset pages, and define stable ordering and cursors.
- Pinned queriesKeep a server query result current between requests, even with no subscribers, and read it without a live client.
- Refining schema typesRefine generated JSON and string types in a handwritten module that survives schema regeneration.
- Fold the delta stream yourself (Rust)Consume individual view changes in Rust and assemble a result that matches a fresh query.
Guides · UI & local state
Guides · SQL & data sources
Guides · Runtime & deployment
- Deploying & scaling RindleDeploy a standalone authority or a replicated fleet, then configure read scaling, durability, and recovery.
- Cloud quickstartProvision managed Rindle SQL or a synced Rindle backend, then connect with one URL and one server-only token.
- Connect your app to Rindle CloudConnect SQL services and synced apps to Rindle Cloud with one ingress URL and one server-only database token.
- Scale & operate on Rindle CloudRead managed fleet convergence, switch between SQL and Sync, and recover a suspended Rindle Cloud app.
Reference · API & packages
Reference · Query reference
Reference · Clients & servers
Reference · Configuration & limits
- Run the daemon (rindled)Configure rindled as a standalone database authority or a read follower, and understand its network and recovery requirements.
- @rindle/cliThe npm-installed Rindle toolchain: local fleet and app lifecycle, SQL, local HCTree/wal2 inspection, migrations, schema generation, backup, and Rindle Cloud deployment.
- PerformanceRead measured query-maintenance costs, benchmark conditions, and comparisons across workloads.