@tanstack/browser-db-sqlite-persistence

Thin browser SQLite persistence for TanStack DB using wa-sqlite + OPFS.

Public API

• createBrowserWASQLitePersistence(...)
• openBrowserWASQLiteOPFSDatabase(...)
• persistedCollectionOptions(...) (re-exported from core)

Quick start

import { createCollection } from '@tanstack/db'
import {
  createBrowserWASQLitePersistence,
  openBrowserWASQLiteOPFSDatabase,
  persistedCollectionOptions,
} from '@tanstack/browser-db-sqlite-persistence'

type Todo = {
  id: string
  title: string
  completed: boolean
}

const database = await openBrowserWASQLiteOPFSDatabase({
  databaseName: `tanstack-db.sqlite`,
})

const persistence = createBrowserWASQLitePersistence({
  database,
})

export const todosCollection = createCollection(
  persistedCollectionOptions<Todo, string>({
    id: `todos`,
    getKey: (todo) => todo.id,
    persistence,
    schemaVersion: 1, // Per-collection schema version
  }),
)

Notes

• This package is Phase 7 single-tab browser wiring: it uses SingleProcessCoordinator semantics by default.
• openBrowserWASQLiteOPFSDatabase(...) starts a dedicated Web Worker and routes SQL operations through it. OPFS sync access handle APIs are used in that worker context.
• Single-tab mode does not require BroadcastChannel or Web Locks for correctness.
• OPFS capability failures are surfaced as PersistenceUnavailableError.