Open History to see the last commit
1---
2id: QueryCollectionConfig
3title: QueryCollectionConfig
4---
5
6# Interface: QueryCollectionConfig\<T, TQueryFn, TError, TQueryKey, TKey, TSchema, TQueryData\>
7
8Defined in: [packages/query-db-collection/src/query.ts:61](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L61)
9
10Configuration options for creating a Query Collection
11
12## Extends
13
14- `BaseCollectionConfig`\<`T`, `TKey`, `TSchema`\>
15
16## Type Parameters
17
18### T
19
20`T` *extends* `object` = `object`
21
22The explicit type of items stored in the collection
23
24### TQueryFn
25
26`TQueryFn` *extends* (`context`) => `any` = (`context`) => `any`
27
28The queryFn type
29
30### TError
31
32`TError` = `unknown`
33
34The type of errors that can occur during queries
35
36### TQueryKey
37
38`TQueryKey` *extends* `QueryKey` = `QueryKey`
39
40The type of the query key
41
42### TKey
43
44`TKey` *extends* `string` \| `number` = `string` \| `number`
45
46The type of the item keys
47
48### TSchema
49
50`TSchema` *extends* `StandardSchemaV1` = `never`
51
52The schema type for validation
53
54### TQueryData
55
56`TQueryData` = `Awaited`\<`ReturnType`\<`TQueryFn`\>\>
57
58## Properties
59
60### enabled?
61
62```ts
63optional enabled: Enabled<TQueryData, TError, TQueryData, TQueryKey>;
64```
65
66Defined in: [packages/query-db-collection/src/query.ts:87](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L87)
67
68Whether the query should automatically run (default: true)
69
70***
71
72### gcTime?
73
74```ts
75optional gcTime: number;
76```
77
78Defined in: [packages/query-db-collection/src/query.ts:122](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L122)
79
80Time in milliseconds after which the collection will be garbage collected
81when it has no active subscribers. Defaults to 5 minutes (300000ms).
82
83#### Overrides
84
85```ts
86BaseCollectionConfig.gcTime
87```
88
89***
90
91### meta?
92
93```ts
94optional meta: Record<string, unknown>;
95```
96
97Defined in: [packages/query-db-collection/src/query.ts:151](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L151)
98
99Metadata to pass to the query.
100Available in queryFn via context.meta
101
102#### Example
103
104```ts
105// Using meta for error context
106queryFn: async (context) => {
107 try {
108 return await api.getTodos(userId)
109 } catch (error) {
110 // Use meta for better error messages
111 throw new Error(
112 context.meta?.errorMessage || 'Failed to load todos'
113 )
114 }
115},
116meta: {
117 errorMessage: `Failed to load todos for user ${userId}`
118}
119```
120
121***
122
123### persistedGcTime?
124
125```ts
126optional persistedGcTime: number;
127```
128
129Defined in: [packages/query-db-collection/src/query.ts:129](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L129)
130
131***
132
133### queryClient
134
135```ts
136queryClient: QueryClient;
137```
138
139Defined in: [packages/query-db-collection/src/query.ts:83](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L83)
140
141The TanStack Query client instance
142
143***
144
145### queryFn
146
147```ts
148queryFn: TQueryFn extends (context) => any[] | Promise<any[]> ? (context) => T[] | Promise<T[]> : TQueryFn;
149```
150
151Defined in: [packages/query-db-collection/src/query.ts:75](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L75)
152
153Function that fetches data from the server. Must return the complete collection state
154
155***
156
157### queryKey
158
159```ts
160queryKey: TQueryKey | TQueryKeyBuilder<TQueryKey>;
161```
162
163Defined in: [packages/query-db-collection/src/query.ts:73](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L73)
164
165The query key used by TanStack Query to identify this query
166
167***
168
169### refetchInterval?
170
171```ts
172optional refetchInterval: number | false | (query) => number | false | undefined;
173```
174
175Defined in: [packages/query-db-collection/src/query.ts:94](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L94)
176
177***
178
179### retry?
180
181```ts
182optional retry: RetryValue<TError>;
183```
184
185Defined in: [packages/query-db-collection/src/query.ts:101](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L101)
186
187***
188
189### retryDelay?
190
191```ts
192optional retryDelay: RetryDelayValue<TError>;
193```
194
195Defined in: [packages/query-db-collection/src/query.ts:108](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L108)
196
197***
198
199### select()?
200
201```ts
202optional select: (data) => T[];
203```
204
205Defined in: [packages/query-db-collection/src/query.ts:81](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L81)
206
207#### Parameters
208
209##### data
210
211`TQueryData`
212
213#### Returns
214
215`T`[]
216
217***
218
219### staleTime?
220
221```ts
222optional staleTime: StaleTimeFunction<TQueryData, TError, TQueryData, TQueryKey>;
223```
224
225Defined in: [packages/query-db-collection/src/query.ts:115](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L115)