Class: BasicIndex<TKey>#
Defined in: packages/db/src/indexes/basic-index.ts:43
Basic index using Map + sorted Array.
- Map for O(1) equality lookups
- Sorted Array for O(log n) range queries via binary search
- O(n) updates to maintain sort order
Simpler and smaller than BTreeIndex, good for read-heavy workloads. Use BTreeIndex for write-heavy workloads with large collections.
Extends#
BaseIndex<TKey>
Type Parameters#
TKey#
TKey extends string | number = string | number
Constructors#
Constructor#
new BasicIndex<TKey>(
id,
expression,
name?,
options?): BasicIndex<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:64
Parameters#
id#
number
expression#
name?#
string
options?#
any
Returns#
BasicIndex<TKey>
Overrides#
Properties#
compareOptions#
protected compareOptions: CompareOptions;
Defined in: packages/db/src/indexes/base-index.ts:102
Inherited from#
expression#
readonly expression: BasicExpression;
Defined in: packages/db/src/indexes/base-index.ts:96
Inherited from#
hasCustomComparator#
protected hasCustomComparator: boolean = false;
Defined in: packages/db/src/indexes/base-index.ts:108
Set by subclasses when constructed with a user-supplied comparator, whose ordering may not match the WHERE evaluator's relational operators.
Inherited from#
id#
readonly id: number;
Defined in: packages/db/src/indexes/base-index.ts:94
Inherited from#
lastUpdated#
protected lastUpdated: Date;
Defined in: packages/db/src/indexes/base-index.ts:101
Inherited from#
lookupCount#
protected lookupCount: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:99
Inherited from#
name?#
readonly optional name: string;
Defined in: packages/db/src/indexes/base-index.ts:95
Inherited from#
supportedOperations#
readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
Defined in: packages/db/src/indexes/basic-index.ts:46
Overrides#
totalLookupTime#
protected totalLookupTime: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:100
Inherited from#
Accessors#
indexedKeysSet#
Get Signature#
get indexedKeysSet(): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:519
Returns#
Set<TKey>
Overrides#
keyCount#
Get Signature#
get keyCount(): number;
Defined in: packages/db/src/indexes/basic-index.ts:273
Gets the number of indexed keys
Returns#
number
Overrides#
orderedEntriesArray#
Get Signature#
get orderedEntriesArray(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/basic-index.ts:523
Returns#
[any, Set<TKey>][]
Overrides#
orderedEntriesArrayReversed#
Get Signature#
get orderedEntriesArrayReversed(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/basic-index.ts:530
Returns#
[any, Set<TKey>][]
Overrides#
BaseIndex.orderedEntriesArrayReversed
supportsRangeOptimization#
Get Signature#
get supportsRangeOptimization(): boolean;
Defined in: packages/db/src/indexes/base-index.ts:163
Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
return every matching key. Range traversal relies on the index ordering, so
it is unsafe when the index uses a custom comparator, whose order may not
match the WHERE evaluator's relational operators. Callers must fall back to
a full scan when this is false.
Returns#
boolean
Inherited from#
BaseIndex.supportsRangeOptimization
valueMapData#
Get Signature#
get valueMapData(): Map<any, Set<TKey>>;
Defined in: packages/db/src/indexes/basic-index.ts:539
Returns#
Map<any, Set<TKey>>
Overrides#
Methods#
add()#
add(key, item): void;
Defined in: packages/db/src/indexes/basic-index.ts:83
Adds a value to the index
Parameters#
key#
TKey
item#
any
Returns#
void
Overrides#
build()#
build(entries): void;
Defined in: packages/db/src/indexes/basic-index.ts:191
Builds the index from a collection of entries
Parameters#
entries#
Iterable<[TKey, any]>
Returns#
void
Overrides#
clear()#
clear(): void;
Defined in: packages/db/src/indexes/basic-index.ts:228
Clears all data from the index
Returns#
void
Overrides#
equalityLookup()#
equalityLookup(value): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:280
Performs an equality lookup - O(1)
Parameters#
value#
any
Returns#
Set<TKey>
Overrides#
evaluateIndexExpression()#
protected evaluateIndexExpression(item): any;
Defined in: packages/db/src/indexes/base-index.ts:214
Parameters#
item#
any
Returns#
any
Inherited from#
BaseIndex.evaluateIndexExpression
getStats()#
getStats(): IndexStats;
Defined in: packages/db/src/indexes/base-index.ts:202
Returns#
Inherited from#
inArrayLookup()#
inArrayLookup(values): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:504
Performs an IN array lookup - O(k) where k is values.length
Parameters#
values#
any[]
Returns#
Set<TKey>
Overrides#
initialize()#
protected initialize(_options?): void;
Defined in: packages/db/src/indexes/basic-index.ts:78
Parameters#
_options?#
Returns#
void
Overrides#
lookup()#
lookup(operation, value): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:238
Performs a lookup operation
Parameters#
operation#
"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"
value#
any
Returns#
Set<TKey>
Overrides#
matchesCompareOptions()#
matchesCompareOptions(compareOptions): boolean;
Defined in: packages/db/src/indexes/base-index.ts:179
Checks if the compare options match the index's compare options. The direction is ignored because the index can be reversed if the direction is different.
Parameters#
compareOptions#
CompareOptions
Returns#
boolean
Inherited from#
BaseIndex.matchesCompareOptions
matchesDirection()#
matchesDirection(direction): boolean;
Defined in: packages/db/src/indexes/base-index.ts:198
Checks if the index matches the provided direction.
Parameters#
direction#
Returns#
boolean
Inherited from#
matchesField()#
matchesField(fieldPath): boolean;
Defined in: packages/db/src/indexes/base-index.ts:167
Parameters#
fieldPath#
string[]
Returns#
boolean
Inherited from#
rangeQuery()#
rangeQuery(options): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:288
Performs a range query using binary search - O(log n + m)
Parameters#
options#
RangeQueryOptions = {}
Returns#
Set<TKey>
Overrides#
rangeQueryReversed()#
rangeQueryReversed(options): Set<TKey>;
Defined in: packages/db/src/indexes/basic-index.ts:349
Performs a reversed range query
Parameters#
options#
RangeQueryOptions = {}
Returns#
Set<TKey>
Overrides#
remove()#
remove(key, item): void;
Defined in: packages/db/src/indexes/basic-index.ts:124
Removes a value from the index
Parameters#
key#
TKey
item#
any
Returns#
void
Overrides#
supports()#
supports(operation): boolean;
Defined in: packages/db/src/indexes/base-index.ts:159
Parameters#
operation#
"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"
Returns#
boolean
Inherited from#
take()#
take(
n,
from?,
filterFn?): TKey[];
Defined in: packages/db/src/indexes/basic-index.ts:374
Returns the next n items in sorted order
Parameters#
n#
number
from?#
any
filterFn?#
(key) => boolean
Returns#
TKey[]
Overrides#
takeFromStart()#
takeFromStart(n, filterFn?): TKey[];
Defined in: packages/db/src/indexes/basic-index.ts:459
Returns the first n items in sorted order (from the start)
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
Overrides#
takeReversed()#
takeReversed(
n,
from?,
filterFn?): TKey[];
Defined in: packages/db/src/indexes/basic-index.ts:416
Returns the next n items in reverse sorted order
Parameters#
n#
number
from?#
any
filterFn?#
(key) => boolean
Returns#
TKey[]
Overrides#
takeReversedFromEnd()#
takeReversedFromEnd(n, filterFn?): TKey[];
Defined in: packages/db/src/indexes/basic-index.ts:478
Returns the first n items in reverse sorted order (from the end)
Parameters#
n#
number
filterFn?#
(key) => boolean
Returns#
TKey[]
Overrides#
trackLookup()#
protected trackLookup(startTime): void;
Defined in: packages/db/src/indexes/base-index.ts:220
Parameters#
startTime#
number
Returns#
void
Inherited from#
update()#
update(
key,
oldItem,
newItem): void;
Defined in: packages/db/src/indexes/basic-index.ts:162
Updates a value in the index
Parameters#
key#
TKey
oldItem#
any
newItem#
any
Returns#
void
Overrides#
updateTimestamp()#
protected updateTimestamp(): void;
Defined in: packages/db/src/indexes/base-index.ts:226
Returns#
void