jazz.tools

# Documentation

- [FAQ](/docs/faq): Frequently asked questions about Jazz.
- [Overview](/docs): The database that syncs.
- [Quickstart](/docs/quickstart): Scaffold a synced local-first app in one command.
- [Authentication](/docs/auth/authentication): Create accounts, authenticate identities, and link ordinary provider JWTs.
- [Lifecycle](/docs/auth/lifecycle): One session owns account selection, graceful client replacement, logout, and recovery.
- [Local-first auth](/docs/auth/local-first-auth): Start offline with a recoverable account, then link an external identity without changing ownership.
- [Permissions](/docs/auth/permissions): Jazz's approach to row-level security using relationship-based access controls, and how to build policies of varying complexity.
- [Sessions](/docs/auth/sessions): Read account ownership, exact authorship, and provider claims from the current session.
- [Branches](/docs/concepts/branches): Model application-owned branches with ordinary columns and head-over-base views.
- [How Sync Works](/docs/concepts/how-sync-works): An overview of how Jazz syncs data between clients, covering query subscriptions, infrastructure tiers, offline behavior, and eventual consistency.
- [Local-First Data Model](/docs/concepts/local-first-data-model): An overview of how Jazz manages local state, row histories, conflicts, and loading behavior.
- [Filters, Sorting & Pagination](/docs/reading/filters-and-sorting): Filter rows with where(), sort with orderBy(), and paginate with limit/offset.
- [Includes & Relations](/docs/reading/includes-and-relations): Resolve references with include(), pick columns with select(), inspect permissions, and run recursive queries.
- [Queries](/docs/reading/queries): One-shot queries, subscriptions, framework hooks, Suspense integration, and read durability options.
- [Effect](/docs/recipes/effect): Use Jazz from Effect v4 programs, in the browser and on the server.
- [Testing](/docs/recipes/testing): Patterns for testing Jazz applications.
- [Client Setup](/docs/getting-started/client-setup): Set up Jazz in your app — works out of the box with most frameworks, with manual configuration available when needed.
- [Server Setup](/docs/getting-started/server-setup): Hosted and self-hosted database server configuration, app provisioning, and backend context setup.
- [Client](/docs/install/client): Build a local-first to-do app with Jazz, step by step.
- [TypeScript Server](/docs/install/typescript-server): Build a server-side to-do API with Jazz and Hono, step by step.
- [Agent skills](/docs/reference/agent-skills): Project-local guidance installed by create-jazz for coding agents working in a Jazz app.
- [Durability Tiers](/docs/reference/durability-tiers): API reference for read and write durability tiers: the options that control how far data must propagate before an operation confirms.
- [Examples](/docs/reference/examples): What each example app in the Jazz monorepo uniquely demonstrates.
- [Framework Patterns](/docs/reference/framework-patterns): Side-by-side reference for React/Expo, Vue, Svelte, and Solid Jazz APIs.
- [Inspector](/docs/reference/inspector): Standalone admin client for exploring Jazz sync servers, schemas, permissions, and subscriptions.
- [Advanced Internals](/docs/reference/internals): How Jazz works under the hood: raw tables, row histories, sync, the query pipeline, and the browser architecture.
- [Local-first auth internals](/docs/reference/local-first-auth-internals): How a local signing identity founds an offline account and links ordinary provider identities through the core registry.
- [Upgrading from alpha.55](/docs/reference/upgrading-from-alpha-55): The breaking changes between alpha.55 and alpha.58, what to change in your app, and what happens to clients that haven't upgraded yet.
- [WHERE Operators](/docs/reference/where-operators): Full reference for filter operators available in Jazz query builders, with examples for each column kind.
- [Transactions](/docs/writing/transactions): Group related reads and writes into one mergeable or exclusive transaction.
- [Writing Data](/docs/writing/writing-data): Insert, update, and delete APIs with local-first execution, framework context hooks, and an intro to durability tiers.
- [Column Types](/docs/schemas/column-types): Every column type available in the TypeScript DSL and its SQL equivalent.
- [Defining Tables](/docs/schemas/defining-tables): Define tables and relationships in schema.ts using the TypeScript DSL.
- [Migrations](/docs/schemas/migrations): Change your schema while keeping older clients working.
- [Auth provider integration](/docs/recipes/auth/auth-provider-integration): Connect an external auth provider to Jazz with JWT validation, with examples for Better Auth and WorkOS.
- [Better Auth Adapter](/docs/recipes/auth/better-auth-adapter): Use Better Auth with Jazz as the database adapter.
- [Group permissions](/docs/recipes/access-control/group-permissions): Model a workspace with role-based access control using a members table and existence-based permissions.
- [Invite links](/docs/recipes/access-control/invite-links): Let users share a URL that grants another user access to a private resource without knowing their identity in advance.
- [Shared access between users](/docs/recipes/access-control/shared-access): Grant other users access to your data using a shares table and existence-based permissions.
- [User-owned data](/docs/recipes/access-control/user-owned-data): End-to-end walkthrough of the most common Jazz pattern: data that belongs to the user who created it.
- [Nested data with permission inheritance](/docs/recipes/data-patterns/nested-data): Model a project/task/comment hierarchy with inherited permissions, queries, and multi-level inserts.
- [Real-time collaborative list](/docs/recipes/data-patterns/real-time-collaborative-list): Multiple users subscribing to the same data and seeing each other's changes in real-time.