tanstack-db

name	tanstack-db
description	Octane bindings for TanStack DB. useLiveQuery hook with dependency arrays (8 overloads: query function, config object, pre-created collection, disabled state via returning undefined/null). useLiveSuspenseQuery for Octane Suspense with Error Boundaries (data always defined). useLiveInfiniteQuery for cursor-based pagination (pageSize, fetchNextPage, hasNextPage, isFetchingNextPage). usePacedMutations for debounced Octane state updates. Return shape: data, state, collection, status, isLoading, isReady, isError. Import from @octanejs/tanstack-db (re-exports all of @tanstack/db).
type	framework
library	db
framework	octane
library_version	0.6.0
requires	["db-core"]
sources	["TanStack/db:docs/framework/octane/overview.md","TanStack/db:docs/guides/live-queries.md","TanStack/db:packages/octane-db/src/useLiveQuery.ts","TanStack/db:packages/octane-db/src/useLiveInfiniteQuery.ts","TanStack/db:packages/octane-db/src/useLiveQueryEffect.ts"]

This skill builds on db-core. Read it first for collection setup, query builder, and mutation patterns.

TanStack DB — Octane

Setup

import { useLiveQuery, eq, not } from '@octanejs/tanstack-db'

function TodoList() {
  const { data: todos, isLoading } = useLiveQuery((q) =>
    q
      .from({ todo: todoCollection })
      .where(({ todo }) => not(todo.completed))
      .orderBy(({ todo }) => todo.created_at, 'asc'),
  )

  if (isLoading) return <div>Loading...</div>

  return (
    <ul>
      {todos.map((todo) => (
        <li key={todo.id}>{todo.text}</li>
      ))}
    </ul>
  )
}

@octanejs/tanstack-db re-exports everything from @tanstack/db. In Octane projects, import everything from @octanejs/tanstack-db.

Hooks

useLiveQuery

// Query function with dependency array
const {
  data,
  state,
  collection,
  status,
  isLoading,
  isReady,
  isError,
  isIdle,
  isCleanedUp,
} = (
  
    q
      .({ : todoCollection })
      .( (todo., userId)),
  [userId],
)


 { data } = ({
  :  q.({ : todoCollection }),
  : ,
})


 { data } = (preloadedCollection)


 { data, status } = (
   {
     (!userId)  
     q
      .({ : todoCollection })
      .( (todo., userId))
  },
  [userId],
)