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