Defined in: packages/db/src/indexes/btree-index.ts:46
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/base-index.ts:140
Parameters#
id#
number
expression#
name?#
string
options?#
any
Returns#
BTreeIndex<TKey>
Inherited from#
Properties#
compareFn()#
protected readonly compareFn: (a, b) => number;
Defined in: packages/db/src/indexes/base-index.ts:131
Orders indexed values. Every result is checked, because a custom comparator or custom collation may be supplied by the user.
Parameters#
a#
any
b#
any
Returns#
number
Inherited from#
compareOptions#
protected readonly compareOptions: CompareOptions;
Defined in: packages/db/src/indexes/base-index.ts:126
Inherited from#
expression#
readonly expression: BasicExpression;
Defined in: packages/db/src/indexes/base-index.ts:124
Inherited from#
hasCustomComparator#
protected readonly hasCustomComparator: boolean;
Defined in: packages/db/src/indexes/base-index.ts:137
A user-supplied comparator's 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:122
Inherited from#
name?#
readonly optional name: string;
Defined in: packages/db/src/indexes/base-index.ts:123
Inherited from#
supportedOperations#
readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
Defined in: packages/db/src/indexes/btree-index.ts:49
Overrides#
Accessors#
keyCount#
Get Signature#
get keyCount(): number;
Defined in: packages/db/src/indexes/btree-index.ts:261
Gets the number of indexed keys
Returns#
number
Overrides#
supportsRangeOptimization#
Get Signature#
get supportsRangeOptimization(): boolean;
Defined in: packages/db/src/indexes/base-index.ts:206
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
Methods#
add()#
add(key, item): void;
Defined in: packages/db/src/indexes/btree-index.ts:81
Adds a value to the index
Parameters#
key#
TKey
item#
any
Returns#
void
Overrides#
addRangeValue()#
protected addRangeValue(value): void;
Defined in: packages/db/src/indexes/base-index.ts:210
Parameters#
value#
unknown
Returns#
void
Inherited from#
build()#
build(entries): void;
Defined in: packages/db/src/indexes/btree-index.ts:205
Builds the index from a collection of entries
Parameters#
entries#
Iterable<[TKey, any]>
Returns#
void
Overrides#
canOptimizeRangeFor()#
canOptimizeRangeFor(value): boolean;
Defined in: packages/db/src/indexes/base-index.ts:232
Whether the live values in this index share the predicate operand's relational domain. Mixed domains can sort differently in the index and WHERE evaluator, which can make a range lookup omit matching rows.
Parameters#
value#
unknown
Returns#
boolean
Inherited from#
clear()#
clear(): void;
Defined in: packages/db/src/indexes/btree-index.ts:216
Clears all data from the index
Returns#
void
Overrides#
clearRangeValues()#
protected clearRangeValues(): void;
Defined in: packages/db/src/indexes/base-index.ts:228
Returns#
void
Inherited from#
equalityLookup()#
equalityLookup(value): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:270
Performs an equality lookup
Parameters#
value#
any
Returns#
Set<TKey>
Overrides#
evaluateAddedValue()#
protected evaluateAddedValue(key, item): any;
Defined in: packages/db/src/indexes/base-index.ts:307
The indexed value of a row being added. A throwing expression fails the write.
Parameters#
key#
TKey
item#
any
Returns#
any
Inherited from#
evaluateIndexExpression()#
protected evaluateIndexExpression(item): any;
Defined in: packages/db/src/indexes/base-index.ts:300
Parameters#
item#
any
Returns#
any
Inherited from#
BaseIndex.evaluateIndexExpression
inArrayLookup()#
inArrayLookup(values): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:415
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:76
Parameters#
_options?#
BTreeIndexOptions
Returns#
void
Overrides#
lookup()#
lookup(operation, value): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:226
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:254
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:294
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:242
Parameters#
fieldPath#
string[]
Returns#
boolean
Inherited from#
rangeQuery()#
rangeQuery(options): Set<TKey>;
Defined in: packages/db/src/indexes/btree-index.ts:279
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/base-index.ts:188
Parameters#
options#
Returns#
Set<TKey>
Inherited from#
remove()#
remove(key, item): void;
Defined in: packages/db/src/indexes/btree-index.ts:122
Removes a value from the index
Parameters#
key#
TKey
item#
any
Returns#
void
Overrides#
removeRangeValue()#
protected removeRangeValue(value): void;
Defined in: packages/db/src/indexes/base-index.ts:219
Parameters#
value#
unknown
Returns#
void
Inherited from#
supports()#
supports(operation): boolean;
Defined in: packages/db/src/indexes/base-index.ts:202
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:361
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:374
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:386
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:403
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#
update()#
update(
key,
oldItem,
newItem): void;
Defined in: packages/db/src/indexes/btree-index.ts:172
Updates a value in the index
Parameters#
key#
TKey
oldItem#
any
newItem#
any
Returns#
void