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

BasicIndex.md

901 lines15.2 KB

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