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

BaseIndex.md

801 lines14.1 KB

1---
2id: BaseIndex
3title: BaseIndex
4---
5​
6Defined in: [packages/db/src/indexes/base-index.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L118)
7​
8Base abstract class that all index types extend
9​
10## Extended by
11​
12- [`BasicIndex`](BasicIndex.md)
13- [`BTreeIndex`](BTreeIndex.md)
14​
15## Type Parameters
16​
17### TKey
18​
19`TKey` *extends* `string` \| `number` = `string` \| `number`
20​
21## Implements
22​
23- [`IndexInterface`](../interfaces/IndexInterface.md)\<`TKey`\>
24​
25## Constructors
26​
27### Constructor
28​
29```ts
30new BaseIndex<TKey>(
31 id,
32 expression,
33 name?,
34options?): BaseIndex<TKey>;
35```
36​
37Defined in: [packages/db/src/indexes/base-index.ts:139](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L139)
38​
39#### Parameters
40​
41##### id
42​
43`number`
44​
45##### expression
46​
47[`BasicExpression`](../@tanstack/namespaces/IR/type-aliases/BasicExpression.md)
48​
49##### name?
50​
51`string`
52​
53##### options?
54​
55`any`
56​
57#### Returns
58​
59`BaseIndex`\<`TKey`\>
60​
61## Properties
62​
63### compareFn()
64​
65```ts
66protected readonly compareFn: (a, b) => number;
67```
68​
69Defined in: [packages/db/src/indexes/base-index.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L130)
70​
71Orders indexed values. Every result is checked, because a custom
72comparator or custom collation may be supplied by the user.
73​
74#### Parameters
75​
76##### a
77​
78`any`
79​
80##### b
81​
82`any`
83​
84#### Returns
85​
86`number`
87​
88***
89​
90### compareOptions
91​
92```ts
93protected readonly compareOptions: CompareOptions;
94```
95​
96Defined in: [packages/db/src/indexes/base-index.ts:125](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L125)
97​
98***
99​
100### expression
101​
102```ts
103readonly expression: BasicExpression;
104```
105​
106Defined in: [packages/db/src/indexes/base-index.ts:123](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L123)
107​
108***
109​
110### hasCustomComparator
111​
112```ts
113protected readonly hasCustomComparator: boolean;
114```
115​
116Defined in: [packages/db/src/indexes/base-index.ts:136](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L136)
117​
118A user-supplied comparator's ordering may not match the WHERE evaluator's
119relational operators.
120​
121***
122​
123### id
124​
125```ts
126readonly id: number;
127```
128​
129Defined in: [packages/db/src/indexes/base-index.ts:121](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L121)
130​
131***
132​
133### name?
134​
135```ts
136readonly optional name: string;
137```
138​
139Defined in: [packages/db/src/indexes/base-index.ts:122](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L122)
140​
141***
142​
143### supportedOperations
144​
145```ts
146abstract readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
147```
148​
149Defined in: [packages/db/src/indexes/base-index.ts:124](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L124)
150​
151## Accessors
152​
153### keyCount
154​
155#### Get Signature
156​
157```ts
158get abstract keyCount(): number;
159```
160​
161Defined in: [packages/db/src/indexes/base-index.ts:181](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L181)
162​
163##### Returns
164​
165`number`
166​
167#### Implementation of
168​
169[`IndexInterface`](../interfaces/IndexInterface.md).[`keyCount`](../interfaces/IndexInterface.md#keycount)
170​
171***
172​
173### supportsRangeOptimization
174​
175#### Get Signature
176​
177```ts
178get supportsRangeOptimization(): boolean;
179```
180​
181Defined in: [packages/db/src/indexes/base-index.ts:205](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L205)
182​
183Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
184return every matching key. Range traversal relies on the index ordering, so
185it is unsafe when the index uses a custom comparator, whose order may not
186match the WHERE evaluator's relational operators. Callers must fall back to
187a full scan when this is `false`.
188​
189##### Returns
190​
191`boolean`
192​
193#### Implementation of
194​
195[`IndexInterface`](../interfaces/IndexInterface.md).[`supportsRangeOptimization`](../interfaces/IndexInterface.md#supportsrangeoptimization)
196​
197## Methods
198​
199### add()
200​
201```ts
202abstract add(key, item): void;
203```
204​
205Defined in: [packages/db/src/indexes/base-index.ts:157](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L157)
206​
207#### Parameters
208​
209##### key
210​
211`TKey`
212​
213##### item
214​
215`any`
216​
217#### Returns
218​
219`void`
220​
221#### Implementation of
222​
223[`IndexInterface`](../interfaces/IndexInterface.md).[`add`](../interfaces/IndexInterface.md#add)
224​
225***
226​
227### addRangeValue()
228​
229```ts
230protected addRangeValue(value): void;
231```
232​
233Defined in: [packages/db/src/indexes/base-index.ts:209](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L209)
234​
235#### Parameters
236​
237##### value
238​
239`unknown`
240​
241#### Returns
242​
243`void`
244​
245***
246​
247### build()
248​
249```ts
250abstract build(entries): void;
251```
252​
253Defined in: [packages/db/src/indexes/base-index.ts:160](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L160)
254​
255#### Parameters
256​
257##### entries
258​
259`Iterable`\<\[`TKey`, `any`\]\>
260​
261#### Returns
262​
263`void`
264​
265#### Implementation of
266​
267[`IndexInterface`](../interfaces/IndexInterface.md).[`build`](../interfaces/IndexInterface.md#build)
268​
269***
270​
271### canOptimizeRangeFor()
272​
273```ts
274canOptimizeRangeFor(value): boolean;
275```
276​
277Defined in: [packages/db/src/indexes/base-index.ts:231](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L231)
278​
279Whether the live values in this index share the predicate operand's
280relational domain. Mixed domains can sort differently in the index and
281WHERE evaluator, which can make a range lookup omit matching rows.
282​
283#### Parameters
284​
285##### value
286​
287`unknown`
288​
289#### Returns
290​
291`boolean`
292​
293#### Implementation of
294​
295[`IndexInterface`](../interfaces/IndexInterface.md).[`canOptimizeRangeFor`](../interfaces/IndexInterface.md#canoptimizerangefor)
296​
297***
298​
299### clear()
300​
301```ts
302abstract clear(): void;
303```
304​
305Defined in: [packages/db/src/indexes/base-index.ts:161](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L161)
306​
307#### Returns
308​
309`void`
310​
311#### Implementation of
312​
313[`IndexInterface`](../interfaces/IndexInterface.md).[`clear`](../interfaces/IndexInterface.md#clear)
314​
315***
316​
317### clearRangeValues()
318​
319```ts
320protected clearRangeValues(): void;
321```
322​
323Defined in: [packages/db/src/indexes/base-index.ts:227](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L227)
324​
325#### Returns
326​
327`void`
328​
329***
330​
331### equalityLookup()
332​
333```ts
334abstract equalityLookup(value): Set<TKey>;
335```
336​
337Defined in: [packages/db/src/indexes/base-index.ts:182](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L182)
338​
339#### Parameters
340​
341##### value
342​
343`any`
344​
345#### Returns
346​
347`Set`\<`TKey`\>
348​
349#### Implementation of
350​
351[`IndexInterface`](../interfaces/IndexInterface.md).[`equalityLookup`](../interfaces/IndexInterface.md#equalitylookup)
352​
353***
354​
355### evaluateIndexExpression()
356​
357```ts
358protected evaluateIndexExpression(item): any;
359```
360​
361Defined in: [packages/db/src/indexes/base-index.ts:299](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L299)
362​
363#### Parameters
364​
365##### item
366​
367`any`
368​
369#### Returns
370​
371`any`
372​
373***
374​
375### inArrayLookup()
376​
377```ts
378abstract inArrayLookup(values): Set<TKey>;
379```
380​
381Defined in: [packages/db/src/indexes/base-index.ts:183](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L183)
382​
383#### Parameters
384​
385##### values
386​
387`any`[]
388​
389#### Returns
390​
391`Set`\<`TKey`\>
392​
393#### Implementation of
394​
395[`IndexInterface`](../interfaces/IndexInterface.md).[`inArrayLookup`](../interfaces/IndexInterface.md#inarraylookup)
396​
397***
398​
399### initialize()
400​
401```ts
402abstract protected initialize(options?): void;
403```
404​
405Defined in: [packages/db/src/indexes/base-index.ts:297](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L297)
406​
407#### Parameters
408​
409##### options?
410​
411`any`
412​
413#### Returns
414​
415`void`
416​
417***
418​
419### lookup()
420​
421```ts
422abstract lookup(operation, value): Set<TKey>;
423```
424​
425Defined in: [packages/db/src/indexes/base-index.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L162)
426​
427#### Parameters
428​
429##### operation
430​
431`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
432​
433##### value
434​
435`any`
436​
437#### Returns
438​
439`Set`\<`TKey`\>
440​
441#### Implementation of
442​
443[`IndexInterface`](../interfaces/IndexInterface.md).[`lookup`](../interfaces/IndexInterface.md#lookup)
444​
445***
446​
447### matchesCompareOptions()
448​
449```ts
450matchesCompareOptions(compareOptions): boolean;
451```
452​
453Defined in: [packages/db/src/indexes/base-index.ts:253](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L253)
454​
455Checks if the compare options match the index's compare options.
456The direction is ignored because the index can be reversed if the direction is different.
457​
458#### Parameters
459​
460##### compareOptions
461​
462`CompareOptions`
463​
464#### Returns
465​
466`boolean`
467​
468#### Implementation of
469​
470[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesCompareOptions`](../interfaces/IndexInterface.md#matchescompareoptions)
471​
472***
473​
474### matchesDirection()
475​
476```ts
477matchesDirection(direction): boolean;
478```
479​
480Defined in: [packages/db/src/indexes/base-index.ts:293](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L293)
481​
482Checks if the index matches the provided direction.
483​
484#### Parameters
485​
486##### direction
487​
488[`OrderByDirection`](../@tanstack/namespaces/IR/type-aliases/OrderByDirection.md)
489​
490#### Returns
491​
492`boolean`
493​
494#### Implementation of
495​
496[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesDirection`](../interfaces/IndexInterface.md#matchesdirection)
497​
498***
499​
500### matchesField()
501​
502```ts
503matchesField(fieldPath): boolean;
504```
505​
506Defined in: [packages/db/src/indexes/base-index.ts:241](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L241)
507​
508#### Parameters
509​
510##### fieldPath
511​
512`string`[]
513​
514#### Returns
515​
516`boolean`
517​
518#### Implementation of
519​
520[`IndexInterface`](../interfaces/IndexInterface.md).[`matchesField`](../interfaces/IndexInterface.md#matchesfield)
521​
522***
523​
524### rangeQuery()
525​
526```ts
527abstract rangeQuery(options): Set<TKey>;
528```
529​
530Defined in: [packages/db/src/indexes/base-index.ts:184](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L184)
531​
532#### Parameters
533​
534##### options
535​
536[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md)
537​
538#### Returns
539​
540`Set`\<`TKey`\>
541​
542#### Implementation of
543​
544[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQuery`](../interfaces/IndexInterface.md#rangequery)
545​
546***
547​
548### rangeQueryReversed()
549​
550```ts
551rangeQueryReversed(options): Set<TKey>;
552```
553​
554Defined in: [packages/db/src/indexes/base-index.ts:187](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L187)
555​
556#### Parameters
557​
558##### options
559​
560[`BTreeRangeQueryOptions`](../interfaces/BTreeRangeQueryOptions.md) = `{}`
561​
562#### Returns
563​
564`Set`\<`TKey`\>
565​
566#### Implementation of
567​
568[`IndexInterface`](../interfaces/IndexInterface.md).[`rangeQueryReversed`](../interfaces/IndexInterface.md#rangequeryreversed)
569​
570***
571​
572### remove()
573​
574```ts
575abstract remove(key, item): void;
576```
577​
578Defined in: [packages/db/src/indexes/base-index.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L158)
579​
580#### Parameters
581​
582##### key
583​
584`TKey`
585​
586##### item
587​
588`any`
589​
590#### Returns
591​
592`void`
593​
594#### Implementation of
595​
596[`IndexInterface`](../interfaces/IndexInterface.md).[`remove`](../interfaces/IndexInterface.md#remove)
597​
598***
599​
600### removeRangeValue()
601​
602```ts
603protected removeRangeValue(value): void;
604```
605​
606Defined in: [packages/db/src/indexes/base-index.ts:218](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L218)
607​
608#### Parameters
609​
610##### value
611​
612`unknown`
613​
614#### Returns
615​
616`void`
617​
618***
619​
620### supports()
621​
622```ts
623supports(operation): boolean;
624```
625​
626Defined in: [packages/db/src/indexes/base-index.ts:201](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L201)
627​
628#### Parameters
629​
630##### operation
631​
632`"eq"` | `"gt"` | `"gte"` | `"lt"` | `"lte"` | `"in"` | `"like"` | `"ilike"`
633​
634#### Returns
635​
636`boolean`
637​
638#### Implementation of
639​
640[`IndexInterface`](../interfaces/IndexInterface.md).[`supports`](../interfaces/IndexInterface.md#supports)
641​
642***
643​
644### take()
645​
646```ts
647abstract take(
648 n,
649 from,
650 filterFn?): TKey[];
651```
652​
653Defined in: [packages/db/src/indexes/base-index.ts:163](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L163)
654​
655#### Parameters
656​
657##### n
658​
659`number`
660​
661##### from
662​
663`unknown`
664​
665##### filterFn?
666​
667(`key`) => `boolean`
668​
669#### Returns
670​
671`TKey`[]
672​
673#### Implementation of
674​
675[`IndexInterface`](../interfaces/IndexInterface.md).[`take`](../interfaces/IndexInterface.md#take)
676​
677***
678​
679### takeFromStart()
680​
681```ts
682abstract takeFromStart(n, filterFn?): TKey[];
683```
684​
685Defined in: [packages/db/src/indexes/base-index.ts:168](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L168)
686​
687#### Parameters
688​
689##### n
690​
691`number`
692​
693##### filterFn?
694​
695(`key`) => `boolean`
696​
697#### Returns
698​
699`TKey`[]
700​
701#### Implementation of
702​
703[`IndexInterface`](../interfaces/IndexInterface.md).[`takeFromStart`](../interfaces/IndexInterface.md#takefromstart)
704​
705***
706​
707### takeReversed()
708​
709```ts
710abstract takeReversed(
711 n,
712 from,
713 filterFn?): TKey[];
714```
715​
716Defined in: [packages/db/src/indexes/base-index.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L172)
717​
718#### Parameters
719​
720##### n
721​
722`number`
723​
724##### from
725​
726`unknown`
727​
728##### filterFn?
729​
730(`key`) => `boolean`
731​
732#### Returns
733​
734`TKey`[]
735​
736#### Implementation of
737​
738[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversed`](../interfaces/IndexInterface.md#takereversed)
739​
740***
741​
742### takeReversedFromEnd()
743​
744```ts
745abstract takeReversedFromEnd(n, filterFn?): TKey[];
746```
747​
748Defined in: [packages/db/src/indexes/base-index.ts:177](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L177)
749​
750#### Parameters
751​
752##### n
753​
754`number`
755​
756##### filterFn?
757​
758(`key`) => `boolean`
759​
760#### Returns
761​
762`TKey`[]
763​
764#### Implementation of
765​
766[`IndexInterface`](../interfaces/IndexInterface.md).[`takeReversedFromEnd`](../interfaces/IndexInterface.md#takereversedfromend)
767​
768***
769​
770### update()
771​
772```ts
773abstract update(
774 key,
775 oldItem,
776 newItem): void;
777```
778​
779Defined in: [packages/db/src/indexes/base-index.ts:159](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L159)
780​
781#### Parameters
782​
783##### key
784​
785`TKey`
786​
787##### oldItem
788​
789`any`
790​
791##### newItem
792​
793`any`
794​
795#### Returns
796​
797`void`
798​
799#### Implementation of
800​
801[`IndexInterface`](../interfaces/IndexInterface.md).[`update`](../interfaces/IndexInterface.md#update)