Tanstack Db

作者 tanstack-skills6f5521ecbdfb无许可证35 个星标收录于 2026年10月8日更新于 2026年10月8日仓库8个月前更新

Reactive client-first store for your API with collections, live queries, and optimistic mutations.

仅含说明Software Development

AI 生成的概览

TanStack DB 参考指南：客户端响应式存储，包含集合、实时查询与乐观变更。

功能: 该技能是 TanStack DB 的文档式参考，TanStack DB 是构建在差分数据流之上的客户端嵌入式数据库层。内容讲解集合、同步模式、使用类 SQL 构建器的实时查询、连接、过滤操作符、乐观变更以及查询驱动的同步，并配有 TypeScript 代码示例。此外还列出性能数据、支持的集合类型、最佳实践与常见陷阱。
适用场景: 在前端项目中使用 TanStack DB，并需要了解如何创建集合、编写实时查询或处理乐观变更时使用。也适合用于选择同步模式或将查询谓词映射为 API 参数。
运行要求: 不附带脚本，仅为说明性内容。实践示例需要 JavaScript/TypeScript 项目，并安装 @tanstack/react-db、@tanstack/query-db-collection 与 @tanstack/db 包，同时需要可同步的 API 或数据源。

Overview

TanStack DB is a client-side embedded database layer built on differential dataflow. It maintains normalized collections, uses incremental computation for live queries, provides automatic optimistic mutations, and integrates with TanStack Query for data fetching. Sub-millisecond updates even with 100k+ rows.

Package: @tanstack/react-db Query Integration: @tanstack/query-db-collection Status: Beta (v0.5)

Installation

Core Concepts

Collections: Normalized data stores wrapping data sources (TanStack Query, Electric, etc.)
Live Queries: Reactive subscriptions with SQL-like query builder
Optimistic Mutations: Automatic instant UI updates with rollback on failure
Differential Dataflow: Only recomputes affected query results on changes

Collections

Creating a Collection

typescript

import { createCollection } from '@tanstack/react-db'import { queryCollectionOptions } from '@tanstack/query-db-collection'
const todoCollection = createCollection(  queryCollectionOptions({    queryKey: ['todos'],    queryFn: async () => api.todos.getAll(),    getKey: (item) => item.id,    schema: todoSchema,    onInsert: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.create(mutation.modified)        )      )    },    onUpdate: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.update(mutation.modified)        )      )    },    onDelete: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.delete(mutation.original.id)        )      )    },  }))

import { createCollection } from '@tanstack/react-db'import { queryCollectionOptions } from '@tanstack/query-db-collection'
const todoCollection = createCollection(  queryCollectionOptions({    queryKey: ['todos'],    queryFn: async () => api.todos.getAll(),    getKey: (item) => item.id,    schema: todoSchema,    onInsert: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.create(mutation.modified)        )      )    },    onUpdate: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.update(mutation.modified)        )      )    },    onDelete: async ({ transaction }) => {      await Promise.all(        transaction.mutations.map((mutation) =>          api.todos.delete(mutation.original.id)        )      )    },  }))

Sync Modes

typescript

// Eager (default): Load entire collection upfront. Best for <10k rows.const smallCollection = createCollection(  queryCollectionOptions({ syncMode: 'eager', /* ... */ }))
// On-Demand: Load only what queries request. Best for >50k rows, search.const largeCollection = createCollection(  queryCollectionOptions({    syncMode: 'on-demand',    queryFn: async (ctx) => {      const params = parseLoadSubsetOptions(ctx.meta?.loadSubsetOptions)      return api.getProducts(params)    },  }))
// Progressive: Load query subset immediately, full sync in background.const collaborativeCollection = createCollection(  queryCollectionOptions({ syncMode: 'progressive', /* ... */ }))

// Eager (default): Load entire collection upfront. Best for <10k rows.const smallCollection = createCollection(  queryCollectionOptions({ syncMode: 'eager', /* ... */ }))
// On-Demand: Load only what queries request. Best for >50k rows, search.const largeCollection = createCollection(  queryCollectionOptions({    syncMode: 'on-demand',    queryFn: async (ctx) => {      const params = parseLoadSubsetOptions(ctx.meta?.loadSubsetOptions)      return api.getProducts(params)    },  }))
// Progressive: Load query subset immediately, full sync in background.const collaborativeCollection = createCollection(  queryCollectionOptions({ syncMode: 'progressive', /* ... */ }))

Live Queries

Basic Query

typescript

import { useLiveQuery } from '@tanstack/react-db'import { eq } from '@tanstack/db'
function TodoList() {  const { data: todos } = useLiveQuery((query) =>    query      .from({ todos: todoCollection })      .where(({ todos }) => eq(todos.completed, false))  )
  return <ul>{todos.map(todo => <li key={todo.id}>{todo.text}</li>)}</ul>}

import { useLiveQuery } from '@tanstack/react-db'import { eq } from '@tanstack/db'
function TodoList() {  const { data: todos } = useLiveQuery((query) =>    query      .from({ todos: todoCollection })      .where(({ todos }) => eq(todos.completed, false))  )
  return <ul>{todos.map(todo => <li key={todo.id}>{todo.text}</li>)}</ul>}

Query Builder API

typescript

const { data } = useLiveQuery((q) =>  q    .from({ t: todoCollection })    .where(({ t }) => eq(t.status, 'active'))    .orderBy(({ t }) => t.createdAt, 'desc')    .limit(10))

const { data } = useLiveQuery((q) =>  q    .from({ t: todoCollection })    .where(({ t }) => eq(t.status, 'active'))    .orderBy(({ t }) => t.createdAt, 'desc')    .limit(10))

Joins

typescript

const { data } = useLiveQuery((q) =>  q    .from({ t: todoCollection })    .innerJoin(      { u: userCollection },      ({ t, u }) => eq(t.userId, u.id)    )    .innerJoin(      { p: projectCollection },      ({ u, p }) => eq(u.projectId, p.id)    )    .where(({ p }) => eq(p.id, currentProject.id)))

const { data } = useLiveQuery((q) =>  q    .from({ t: todoCollection })    .innerJoin(      { u: userCollection },      ({ t, u }) => eq(t.userId, u.id)    )    .innerJoin(      { p: projectCollection },      ({ u, p }) => eq(u.projectId, p.id)    )    .where(({ p }) => eq(p.id, currentProject.id)))

Filter Operators

typescript

import { eq, lt, and } from '@tanstack/db'
// Equalityeq(field, value)
// Less thanlt(field, value)
// ANDand(eq(product.category, 'electronics'), lt(product.price, 100))

import { eq, lt, and } from '@tanstack/db'
// Equalityeq(field, value)
// Less thanlt(field, value)
// ANDand(eq(product.category, 'electronics'), lt(product.price, 100))

With Ordering and Limits

typescript

const { data } = useLiveQuery((q) =>  q    .from({ product: productsCollection })    .where(({ product }) =>      and(eq(product.category, 'electronics'), lt(product.price, 100))    )    .orderBy(({ product }) => product.price, 'asc')    .limit(10))

const { data } = useLiveQuery((q) =>  q    .from({ product: productsCollection })    .where(({ product }) =>      and(eq(product.category, 'electronics'), lt(product.price, 100))    )    .orderBy(({ product }) => product.price, 'asc')    .limit(10))

Optimistic Mutations

Insert

typescript

todoCollection.insert({  id: uuid(),  text: 'New todo',  completed: false,})// Immediately: updates all live queries referencing this collection// Background: calls onInsert handler to sync with server// On failure: automatic rollback

todoCollection.insert({  id: uuid(),  text: 'New todo',  completed: false,})// Immediately: updates all live queries referencing this collection// Background: calls onInsert handler to sync with server// On failure: automatic rollback

No Manual Boilerplate

Query-Driven Sync (On-Demand)

Live queries automatically generate optimized network requests:

typescript

// This live query...useLiveQuery((q) =>  q.from({ product: productsCollection })    .where(({ product }) => and(eq(product.category, 'electronics'), lt(product.price, 100)))    .orderBy(({ product }) => product.price, 'asc')    .limit(10))
// ...automatically generates:// GET /api/products?category=electronics&price_lt=100&sort=price:asc&limit=10

// This live query...useLiveQuery((q) =>  q.from({ product: productsCollection })    .where(({ product }) => and(eq(product.category, 'electronics'), lt(product.price, 100)))    .orderBy(({ product }) => product.price, 'asc')    .limit(10))
// ...automatically generates:// GET /api/products?category=electronics&price_lt=100&sort=price:asc&limit=10

Predicate Mapping

typescript

queryFn: async (ctx) => {  const { filters, sorts, limit } = parseLoadSubsetOptions(ctx.meta?.loadSubsetOptions)
  const params = new URLSearchParams()  filters.forEach(({ field, operator, value }) => {    if (operator === 'eq') params.set(field.join('.'), String(value))    else if (operator === 'lt') params.set(`${field.join('.')}_lt`, String(value))  })  if (limit) params.set('limit', String(limit))
  return fetch(`/api/products?${params}`).then(r => r.json())}

queryFn: async (ctx) => {  const { filters, sorts, limit } = parseLoadSubsetOptions(ctx.meta?.loadSubsetOptions)
  const params = new URLSearchParams()  filters.forEach(({ field, operator, value }) => {    if (operator === 'eq') params.set(field.join('.'), String(value))    else if (operator === 'lt') params.set(`${field.join('.')}_lt`, String(value))  })  if (limit) params.set('limit', String(limit))
  return fetch(`/api/products?${params}`).then(r => r.json())}

Performance

Supported Collection Types

Query Collection - TanStack Query integration
Electric Collection - Electric SQL real-time sync
TrailBase Collection - TrailBase backend
RxDB Collection - RxDB integration
PowerSync Collection - PowerSync sync
LocalStorage Collection - Browser persistence
LocalOnly Collection - In-memory only

API Summary

typescript

import { createCollection, useLiveQuery } from '@tanstack/react-db'import { queryCollectionOptions } from '@tanstack/query-db-collection'import { eq, lt, and, parseLoadSubsetOptions } from '@tanstack/db'

import { createCollection, useLiveQuery } from '@tanstack/react-db'import { queryCollectionOptions } from '@tanstack/query-db-collection'import { eq, lt, and, parseLoadSubsetOptions } from '@tanstack/db'

Best Practices

Define collections at module level - they're singletons
Choose the right sync mode: eager (<10k), on-demand (>50k), progressive (collaborative)
Use joins instead of view-specific APIs - load normalized collections once
Let TanStack Query handle fetching - DB augments Query, doesn't replace it
Use parseLoadSubsetOptions to map live query predicates to API params
Rely on automatic optimistic updates - don't manually manage optimistic state
Use schemas for runtime validation and TypeScript inference
Leverage incremental computation - let the engine handle filtering vs manual .filter()

Common Pitfalls

Creating collections inside components (should be module-level)
Trying to replace TanStack Query entirely (DB builds on top of it)
Using manual .filter() in render instead of live query where clauses
Not providing getKey for proper normalization
Forgetting mutation handlers (onInsert, onUpdate, onDelete) for server sync

来源与署名

来源：tanstack-skills/tanstack-skills位于plugins/tanstack-db/skills/tanstack-db提交6f5521e

许可证：无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

Before (TanStack Query only)	After (TanStack DB)
Manual `onMutate` for optimistic state	Automatic
Manual `onError` rollback logic	Automatic
Per-mutation cache invalidation	All live queries update automatically

Operation	Latency
Single row update (100k sorted collection)	~0.7 ms
Subsequent queries (after sync)	<1 ms
Join across collections	Sub-millisecond

Tanstack Db

Overview

Installation

Core Concepts

Collections

Creating a Collection

Sync Modes

Live Queries

Basic Query

Query Builder API

Joins

Filter Operators

With Ordering and Limits

Optimistic Mutations

Insert

No Manual Boilerplate

Query-Driven Sync (On-Demand)

Predicate Mapping

Performance

Supported Collection Types

API Summary

Best Practices

Common Pitfalls

来源与署名

更多来自 tanstack-skills/tanstack-skills 的技能

Tanstack Virtual

Tanstack Table

Tanstack Store

Tanstack Start

Tanstack Router

Tanstack Ranger

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices