TanStack DB: supabaseCollectionOptions()

Builds the configuration for a TanStack DB collection backed by a Postgres table. Pass the result to createCollection() from @tanstack/react-db.

• To receive changes from other clients, enable Realtime for the table in the Table Editor, or run alter publication supabase_realtime add table todos;.
• Create one collection per table.
• Reads page past your project's max rows setting automatically. The default is 1000 rows. If a collection can grow past it, order by a unique column so pages stay consistent.

Parameters

• tableName

  (Required)

  The Postgres table this collection reads from and writes to.

• keys

  (Required)

  The primary key column or columns for the table. Must match the table's primary key.

• schema

  (Required)

  A schema used to validate and type each row. Works with any [Standard Schema](https://standardschema.dev) library, such as Zod or Valibot.

• supabase

  (Required)

  The Supabase client instance to query and subscribe through.

• queryClient

  (Optional)

  An existing TanStack Query client to share, if you already use one. If omitted, a shared global client is used.

• realtime

  (Optional)

  Keep the collection in sync across clients using Supabase Realtime. Defaults to `false`.

• realtimeUseFilter

  (Optional)

  Experimental. Apply server-side filtering to Realtime updates instead of filtering on the client. Only applies when `realtime` is `true`. Queries that can't be expressed as a Realtime filter, like `or(...)`, fall back to the unfiltered subscription. Defaults to `false`.

Examples

Create a collection

import { createCollection } from '@tanstack/react-db'
import { supabaseCollectionOptions } from '@supabase-labs/tanstack-db'
import { z } from 'zod'

const todosSchema = z.object({
  id: z.string(),
  title: z.string(),
  completed: z.boolean(),
})

export const todos = createCollection(
  supabaseCollectionOptions({
    tableName: 'todos',
    keys: ['id'],
    schema: todosSchema,
    supabase,
    realtime: true,
  })
)