📄 tanstack/db/latest/docs/reference/query-db-collection/interfaces/QueryCollectionConfig

File: QueryCollectionConfig.md | Updated: 11/15/2025

Source: https://tanstack.com/db/latest/docs/reference/query-db-collection/interfaces/QueryCollectionConfig

TanStack

DB v0v0

Search...

+ K

Auto

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React logo

React

Version

Latest

Search...

+ K

Getting Started

Guides

Collections

Frameworks

Community

Resources & Packages

core

API Reference

Framework

React logo

React

Version

Latest

Getting Started

Guides

Collections

Frameworks

Community

Resources & Packages

core

API Reference

On this page

QueryCollectionConfig

Copy Markdown

Interface: QueryCollectionConfig<T, TQueryFn, TError, TQueryKey, TKey, TSchema, TQueryData>
===========================================================================================

Defined in: packages/query-db-collection/src/query.ts:59

Configuration options for creating a Query Collection

Extends
-------

BaseCollectionConfig<T, TKey, TSchema>

Type Parameters
--------------- ### T

T extends object = object

The explicit type of items stored in the collection

### TQueryFn

TQueryFn extends (context) => Promise<any> = (context) => Promise<any>

The queryFn type

### TError

TError = unknown

The type of errors that can occur during queries

### TQueryKey

TQueryKey extends QueryKey = QueryKey

The type of the query key

### TKey

TKey extends string | number = string | number

The type of the item keys

### TSchema

TSchema extends StandardSchemaV1 = never

The schema type for validation

### TQueryData

TQueryData = Awaited<ReturnType<TQueryFn>>

Properties
---------- ### enabled?

optional enabled: boolean;


optional enabled: boolean;

Defined in: packages/query-db-collection/src/query.ts:85

Whether the query should automatically run (default: true)

### meta?

optional meta: Record<string, unknown>;


optional meta: Record<string, unknown>;

Defined in: packages/query-db-collection/src/query.ts:135

Metadata to pass to the query. Available in queryFn via context.meta

#### Example

// Using meta for error context
queryFn: async (context) => {
  try {
    return await api.getTodos(userId)
  } catch (error) {
    // Use meta for better error messages
    throw new Error(
      context.meta?.errorMessage || 'Failed to load todos'
    )
  }
},
meta: {
  errorMessage: `Failed to load todos for user ${userId}`
}


// Using meta for error context
queryFn: async (context) => {
  try {
    return await api.getTodos(userId)
  } catch (error) {
    // Use meta for better error messages
    throw new Error(
      context.meta?.errorMessage || 'Failed to load todos'
    )
  }
},
meta: {
  errorMessage: `Failed to load todos for user ${userId}`
}

### queryClient

queryClient: QueryClient;


queryClient: QueryClient;

Defined in: packages/query-db-collection/src/query.ts:81

The TanStack Query client instance

### queryFn

queryFn: TQueryFn extends (context) => Promise<any[]> ? (context) => Promise<T[]> : TQueryFn;


queryFn: TQueryFn extends (context) => Promise<any[]> ? (context) => Promise<T[]> : TQueryFn;

Defined in: packages/query-db-collection/src/query.ts:73

Function that fetches data from the server. Must return the complete collection state

### queryKey

queryKey: TQueryKey | TQueryKeyBuilder<TQueryKey>;


queryKey: TQueryKey | TQueryKeyBuilder<TQueryKey>;

Defined in: packages/query-db-collection/src/query.ts:71

The query key used by TanStack Query to identify this query

### refetchInterval?

optional refetchInterval: number | false | (query) => number | false | undefined;


optional refetchInterval: number | false | (query) => number | false | undefined;

Defined in: packages/query-db-collection/src/query.ts:86

### retry?

optional retry: RetryValue<TError>;


optional retry: RetryValue<TError>;

Defined in: packages/query-db-collection/src/query.ts:93

### retryDelay?

optional retryDelay: RetryDelayValue<TError>;


optional retryDelay: RetryDelayValue<TError>;

Defined in: packages/query-db-collection/src/query.ts:100

### select()?

optional select: (data) => T[];


optional select: (data) => T[];

Defined in: packages/query-db-collection/src/query.ts:79

#### Parameters ##### data

TQueryData

#### Returns

T[]

### staleTime?

optional staleTime: StaleTimeFunction<T[], TError, T[], TQueryKey>;


optional staleTime: StaleTimeFunction<T[], TError, T[], TQueryKey>;

Defined in: packages/query-db-collection/src/query.ts:107

Edit on GitHub

Home

Partners Become a Partner

scarf analytics