@@ -5,7 +5,7 @@ title: BaseQueryBuilder
55
66# Class: BaseQueryBuilder\< TContext\>
77
8- Defined in: [ packages/db/src/query/builder/index.ts:54 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L54 )
8+ Defined in: [ packages/db/src/query/builder/index.ts:55 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L55 )
99
1010## Type Parameters
1111
@@ -21,7 +21,7 @@ Defined in: [packages/db/src/query/builder/index.ts:54](https://github.com/TanSt
2121new BaseQueryBuilder <TContext >(query ): BaseQueryBuilder < TContext > ;
2222```
2323
24- Defined in: [ packages/db/src/query/builder/index.ts:57 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L57 )
24+ Defined in: [ packages/db/src/query/builder/index.ts:58 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L58 )
2525
2626#### Parameters
2727
@@ -43,7 +43,7 @@ Defined in: [packages/db/src/query/builder/index.ts:57](https://github.com/TanSt
4343get fn (): object ;
4444```
4545
46- Defined in: [ packages/db/src/query/builder/index.ts:729 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L729 )
46+ Defined in: [ packages/db/src/query/builder/index.ts:744 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L744 )
4747
4848Functional variants of the query builder
4949These are imperative function that are called for ery row.
@@ -176,7 +176,7 @@ query
176176_getQuery (): QueryIR ;
177177```
178178
179- Defined in: [ packages/db/src/query/builder/index.ts:816 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L816 )
179+ Defined in: [ packages/db/src/query/builder/index.ts:831 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L831 )
180180
181181#### Returns
182182
@@ -190,7 +190,7 @@ Defined in: [packages/db/src/query/builder/index.ts:816](https://github.com/TanS
190190distinct (): QueryBuilder < TContext > ;
191191```
192192
193- Defined in: [ packages/db/src/query/builder/index.ts:668 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L668 )
193+ Defined in: [ packages/db/src/query/builder/index.ts:683 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L683 )
194194
195195Specify that the query should return distinct rows.
196196Deduplicates rows based on the selected columns.
@@ -219,7 +219,7 @@ query
219219findOne (): QueryBuilder < TContext & SingleResult > ;
220220```
221221
222- Defined in: [ packages/db/src/query/builder/index.ts:688 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L688 )
222+ Defined in: [ packages/db/src/query/builder/index.ts:703 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L703 )
223223
224224Specify that the query should return a single result
225225
@@ -252,7 +252,7 @@ from<TSource>(source): QueryBuilder<{
252252}>;
253253```
254254
255- Defined in: [ packages/db/src/query/builder/index.ts:136 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L136 )
255+ Defined in: [ packages/db/src/query/builder/index.ts:137 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L137 )
256256
257257Specify the source table or subquery for the query
258258
@@ -300,7 +300,7 @@ query.from({ activeUsers })
300300fullJoin <TSource >(source , onCallback ): QueryBuilder < MergeContextWithJoinType < TContext , SchemaFromSource < TSource > , " full" >> ;
301301```
302302
303- Defined in: [ packages/db/src/query/builder/index.ts:327 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L327 )
303+ Defined in: [ packages/db/src/query/builder/index.ts:328 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L328 )
304304
305305Perform a FULL JOIN with another table or subquery
306306
@@ -347,7 +347,7 @@ query
347347groupBy (callback ): QueryBuilder < TContext > ;
348348```
349349
350- Defined in: [ packages/db/src/query/builder/index.ts:590 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L590 )
350+ Defined in: [ packages/db/src/query/builder/index.ts:605 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L605 )
351351
352352Group rows by one or more columns for aggregation
353353
@@ -396,7 +396,7 @@ query
396396having (callback ): QueryBuilder < TContext > ;
397397```
398398
399- Defined in: [ packages/db/src/query/builder/index.ts:414 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L414 )
399+ Defined in: [ packages/db/src/query/builder/index.ts:422 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L422 )
400400
401401Filter grouped rows based on aggregate conditions
402402
@@ -445,7 +445,7 @@ query
445445innerJoin <TSource >(source , onCallback ): QueryBuilder < MergeContextWithJoinType < TContext , SchemaFromSource < TSource > , " inner" >> ;
446446```
447447
448- Defined in: [ packages/db/src/query/builder/index.ts:301 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L301 )
448+ Defined in: [ packages/db/src/query/builder/index.ts:302 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L302 )
449449
450450Perform an INNER JOIN with another table or subquery
451451
@@ -495,7 +495,7 @@ join<TSource, TJoinType>(
495495type ): QueryBuilder < MergeContextWithJoinType < TContext , SchemaFromSource < TSource > , TJoinType >> ;
496496```
497497
498- Defined in: [ packages/db/src/query/builder/index.ts:179 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L179 )
498+ Defined in: [ packages/db/src/query/builder/index.ts:180 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L180 )
499499
500500Join another table or subquery to the current query
501501
@@ -563,7 +563,7 @@ query
563563leftJoin <TSource >(source , onCallback ): QueryBuilder < MergeContextWithJoinType < TContext , SchemaFromSource < TSource > , " left" >> ;
564564```
565565
566- Defined in: [ packages/db/src/query/builder/index.ts:249 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L249 )
566+ Defined in: [ packages/db/src/query/builder/index.ts:250 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L250 )
567567
568568Perform a LEFT JOIN with another table or subquery
569569
@@ -610,7 +610,7 @@ query
610610limit (count ): QueryBuilder < TContext > ;
611611```
612612
613- Defined in: [ packages/db/src/query/builder/index.ts:623 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L623 )
613+ Defined in: [ packages/db/src/query/builder/index.ts:638 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L638 )
614614
615615Limit the number of rows returned by the query
616616` orderBy ` is required for ` limit `
@@ -647,7 +647,7 @@ query
647647offset (count ): QueryBuilder < TContext > ;
648648```
649649
650- Defined in: [ packages/db/src/query/builder/index.ts:647 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L647 )
650+ Defined in: [ packages/db/src/query/builder/index.ts:662 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L662 )
651651
652652Skip a number of rows before returning results
653653` orderBy ` is required for ` offset `
@@ -685,7 +685,7 @@ query
685685orderBy (callback , options ): QueryBuilder < TContext > ;
686686```
687687
688- Defined in: [ packages/db/src/query/builder/index.ts:514 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L514 )
688+ Defined in: [ packages/db/src/query/builder/index.ts:529 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L529 )
689689
690690Sort the query results by one or more columns
691691
@@ -735,7 +735,7 @@ query
735735rightJoin <TSource >(source , onCallback ): QueryBuilder < MergeContextWithJoinType < TContext , SchemaFromSource < TSource > , " right" >> ;
736736```
737737
738- Defined in: [ packages/db/src/query/builder/index.ts:275 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L275 )
738+ Defined in: [ packages/db/src/query/builder/index.ts:276 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L276 )
739739
740740Perform a RIGHT JOIN with another table or subquery
741741
@@ -782,7 +782,7 @@ query
782782select <TSelectObject >(callback ): QueryBuilder < WithResult < TContext , ResultTypeFromSelect < TSelectObject >>> ;
783783```
784784
785- Defined in: [ packages/db/src/query/builder/index.ts:473 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L473 )
785+ Defined in: [ packages/db/src/query/builder/index.ts:488 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L488 )
786786
787787Select specific columns or computed values from the query
788788
@@ -843,7 +843,7 @@ query
843843where (callback ): QueryBuilder < TContext > ;
844844```
845845
846- Defined in: [ packages/db/src/query/builder/index.ts:366 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L366 )
846+ Defined in: [ packages/db/src/query/builder/index.ts:367 ] ( https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/index.ts#L367 )
847847
848848Filter rows based on a condition
849849
0 commit comments