Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

createLiveQueryCollection.md

135 lines3.6 KB

1---
2id: createLiveQueryCollection
3title: createLiveQueryCollection
4---
5​
6## Call Signature
7​
8```ts
9function createLiveQueryCollection<TQueryFn, TQuery>(query): CollectionForContext<ExtractContext<TQuery>, RootQueryResult<ExtractContext<TQuery>>, {
10}> & object;
11```
12​
13Defined in: [packages/db/src/query/live-query-collection.ts:128](https://github.com/TanStack/db/blob/main/packages/db/src/query/live-query-collection.ts#L128)
14​
15Creates a live query collection directly
16​
17### Type Parameters
18​
19#### TQueryFn
20​
21`TQueryFn` *extends* (`q`) => [`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`any`\>
22​
23#### TQuery
24​
25`TQuery` *extends* [`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`any`\> = `ReturnType`\<`TQueryFn`\>
26​
27### Parameters
28​
29#### query
30​
31`TQueryFn` & `RootQueryFn`\<`TQuery`\>
32​
33### Returns
34​
35`CollectionForContext`\<[`ExtractContext`](../type-aliases/ExtractContext.md)\<`TQuery`\>, `RootQueryResult`\<[`ExtractContext`](../type-aliases/ExtractContext.md)\<`TQuery`\>\>, \{
36\}\> & `object`
37​
38### Example
39​
40```typescript
41// Minimal usage - just pass a query function
42const activeUsers = createLiveQueryCollection(
43 (q) => q
44 .from({ user: usersCollection })
45 .where(({ user }) => eq(user.active, true))
46 .select(({ user }) => ({ id: user.id, name: user.name }))
48​
49// Full configuration with custom options
50const searchResults = createLiveQueryCollection({
51 id: "search-results", // Custom ID (auto-generated if omitted)
52 query: (q) => q
53 .from({ post: postsCollection })
54 .where(({ post }) => like(post.title, `%${searchTerm}%`))
55 .select(({ post }) => ({
56 id: post.id,
57 title: post.title,
58 excerpt: post.excerpt,
59 })),
60 getKey: (item) => item.id, // Custom key function (uses stream key if omitted)
61 utils: {
62 updateSearchTerm: (newTerm: string) => {
63 // Custom utility functions
64 }
65 }
66})
67```
68​
69## Call Signature
70​
71```ts
72function createLiveQueryCollection<TQuery, TContext, TUtils>(config): CollectionForContext<TContext, RootQueryResult<TContext>, {
73}> & object;
74```
75​
76Defined in: [packages/db/src/query/live-query-collection.ts:141](https://github.com/TanStack/db/blob/main/packages/db/src/query/live-query-collection.ts#L141)
77​
78Creates a live query collection directly
79​
80### Type Parameters
81​
82#### TQuery
83​
84`TQuery` *extends* [`QueryBuilder`](../type-aliases/QueryBuilder.md)\<`any`\>
85​
86#### TContext
87​
88`TContext` *extends* [`Context`](../interfaces/Context.md) = [`ExtractContext`](../type-aliases/ExtractContext.md)\<`TQuery`\>
89​
90#### TUtils
91​
92`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = \{
93\}
94​
95### Parameters
96​
97#### config
98​
99[`LiveQueryCollectionConfig`](../interfaces/LiveQueryCollectionConfig.md)\<`TContext`, `RootQueryResult`\<`TContext`\>\> & `object`
100​
101### Returns
102​
103`CollectionForContext`\<`TContext`, `RootQueryResult`\<`TContext`\>, \{
104\}\> & `object`
105​
106### Example
107​
108```typescript
109// Minimal usage - just pass a query function
110const activeUsers = createLiveQueryCollection(
111 (q) => q
112 .from({ user: usersCollection })
113 .where(({ user }) => eq(user.active, true))
114 .select(({ user }) => ({ id: user.id, name: user.name }))
116​
117// Full configuration with custom options
118const searchResults = createLiveQueryCollection({
119 id: "search-results", // Custom ID (auto-generated if omitted)
120 query: (q) => q
121 .from({ post: postsCollection })
122 .where(({ post }) => like(post.title, `%${searchTerm}%`))
123 .select(({ post }) => ({
124 id: post.id,
125 title: post.title,
126 excerpt: post.excerpt,
127 })),
128 getKey: (item) => item.id, // Custom key function (uses stream key if omitted)
129 utils: {
130 updateSearchTerm: (newTerm: string) => {
131 // Custom utility functions
132 }
133 }
134})
135```