Class: BTreeIndex<TKey>#
Defined in: packages/db/src/indexes/btree-index.ts:35
B+Tree index for sorted data with range queries This maintains items in sorted order and provides efficient range operations
Extends#
BaseIndex<TKey>
Type Parameters#
TKey#
TKey extends string | number = string | number
Constructors#
Constructor#
new BTreeIndex<TKey>(
id,
expression,
name?,
options?): BTreeIndex<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:55
Parameters#
id#
number
expression#
name?#
string
options?#
any
Returns#
BTreeIndex<TKey>
Overrides#
Properties#
compareOptions#
protected compareOptions: CompareOptions;
Defined in: packages/db/src/indexes/base-index.ts:92
Inherited from#
expression#
readonly expression: BasicExpression;
Defined in: packages/db/src/indexes/base-index.ts:86
Inherited from#
id#
readonly id: number;
Defined in: packages/db/src/indexes/base-index.ts:84
Inherited from#
lastUpdated#
protected lastUpdated: Date;
Defined in: packages/db/src/indexes/base-index.ts:91
Inherited from#
lookupCount#
protected lookupCount: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:89
Inherited from#
name?#
readonly optional name: string;
Defined in: packages/db/src/indexes/base-index.ts:85
Inherited from#
supportedOperations#
readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
Defined in: packages/db/src/indexes/btree-index.ts:38
Overrides#
totalLookupTime#
protected totalLookupTime: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:90
Inherited from#
Accessors#
indexedKeysSet#
Get Signature#
get indexedKeysSet(): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:400
Returns#
Set<TKey>
Overrides#
keyCount#
Get Signature#
get keyCount(): number;
Defined in: packages/db/src/indexes/btree-index.ts:213
Gets the number of indexed keys
Returns#
number
Overrides#
orderedEntriesArray#
Get Signature#
get orderedEntriesArray(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/btree-index.ts:404
Returns#
[any, Set<TKey>][]
Overrides#
orderedEntriesArrayReversed#
Get Signature#
get orderedEntriesArrayReversed(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/btree-index.ts:413
Returns#
[any, Set<TKey>][]
Overrides#
BaseIndex.orderedEntriesArrayReversed
valueMapData#
Get Signature#
get valueMapData(): Map<any, Set<TKey>>;
Defined in: packages/db/src/indexes/btree-index.ts:420
Returns#
Map<any, Set<TKey>>
Overrides#
Methods#
add()#
add(key, item): void;
Defined in: packages/db/src/indexes/btree-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/btree-index.ts:157
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/btree-index.ts:168
Clears all data from the index
Returns#
void
Overrides#
equalityLookup()#
equalityLookup(value): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:222
Performs an equality lookup
Parameters#
value#
any
Returns#
Set<TKey>
Overrides#
evaluateIndexExpression()#
protected evaluateIndexExpression(item): any;
Defined in: packages/db/src/indexes/base-index.ts:194
Parameters#
item#
any
Returns#
any
Inherited from#
BaseIndex.evaluateIndexExpression
getStats()#
getStats(): IndexStats;
Defined in: packages/db/src/indexes/base-index.ts:182
Returns#
Inherited from#
inArrayLookup()#
inArrayLookup(values): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:385
Performs an IN array lookup
Parameters#
values#
any[]
Returns#
Set<TKey>
Overrides#
initialize()#
protected initialize(_options?): void;
Defined in: packages/db/src/indexes/btree-index.ts:78
Parameters#
_options?#
BTreeIndexOptions
Returns#
void
Overrides#
lookup()#
lookup(operation, value): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:178
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:159
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:178
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:147
Parameters#
fieldPath#
string[]
Returns#
boolean
Inherited from#
rangeQuery()#
rangeQuery(options): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:231
Performs a range query with options This is more efficient for compound queries like "WHERE a > 5 AND a < 10"
Parameters#
options#
Returns#
Set<TKey>
Overrides#
rangeQueryReversed()#
rangeQueryReversed(options): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:269
Performs a reversed range query
Parameters#
options#
Returns#
Set<TKey>
Overrides#
remove()#
remove(key, item): void;
Defined in: packages/db/src/indexes/btree-index.ts:114
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:143
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/btree-index.ts:331
Returns the next n items after the provided item.
Parameters#
n#
number
The number of items to return
from#
any
The item to start from (exclusive).
filterFn?#
(key) => boolean
Returns#
TKey[]
The next n items after the provided key.
Overrides#
takeFromStart()#
takeFromStart(n, filterFn?): TKey[];
Defined in: packages/db/src/indexes/btree-index.ts:344
Returns the first n items from the beginning.
Parameters#
n#
number
The number of items to return
filterFn?#
(key) => boolean
Optional filter function
Returns#
TKey[]
The first n items
Overrides#
takeReversed()#
takeReversed(
n,
from,
filterFn?): TKey[];
Defined in: packages/db/src/indexes/btree-index.ts:356
Returns the next n items before the provided item (in descending order).
Parameters#
n#
number
The number of items to return
from#
any
The item to start from (exclusive). Required.
filterFn?#
(key) => boolean
Returns#
TKey[]
The next n items before the provided key.
Overrides#
takeReversedFromEnd()#
takeReversedFromEnd(n, filterFn?): TKey[];
Defined in: packages/db/src/indexes/btree-index.ts:373
Returns the last n items from the end.
Parameters#
n#
number
The number of items to return
filterFn?#
(key) => boolean
Optional filter function
Returns#
TKey[]
The last n items
Overrides#
trackLookup()#
protected trackLookup(startTime): void;
Defined in: packages/db/src/indexes/base-index.ts:199
Parameters#
startTime#
number
Returns#
void
Inherited from#
update()#
update(
key,
oldItem,
newItem): void;
Defined in: packages/db/src/indexes/btree-index.ts:149
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:205
Returns#
void