BTreeIndex

Defined in: packages/db/src/indexes/btree-index.ts:28

Base abstract class that all index types extend

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:158

Parameters#

id#

number

expression#

BasicExpression

name?#

string

options?#

any

Returns#

BTreeIndex<TKey>

Inherited from#

BaseIndex.constructor

Properties#

compareFn()#

protected readonly compareFn: (a, b) => number;

Defined in: packages/db/src/indexes/base-index.ts:149

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#

BaseIndex.compareFn

compareOptions#

protected readonly compareOptions: CompareOptions;

Defined in: packages/db/src/indexes/base-index.ts:144

Inherited from#

BaseIndex.compareOptions

expression#

readonly expression: BasicExpression;

Defined in: packages/db/src/indexes/base-index.ts:142

Inherited from#

BaseIndex.expression

hasCustomComparator#

protected readonly hasCustomComparator: boolean;

Defined in: packages/db/src/indexes/base-index.ts:155

A user-supplied comparator's ordering may not match the WHERE evaluator's relational operators.

Inherited from#

BaseIndex.hasCustomComparator

id#

readonly id: number;

Defined in: packages/db/src/indexes/base-index.ts:140

Inherited from#

BaseIndex.id

name?#

readonly optional name: string;

Defined in: packages/db/src/indexes/base-index.ts:141

Inherited from#

BaseIndex.name

supportedOperations#

readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;

Defined in: packages/db/src/indexes/base-index.ts:143

Inherited from#

BaseIndex.supportedOperations

Accessors#

keyCount#

Get Signature#

get keyCount(): number;

Defined in: packages/db/src/indexes/btree-index.ts:162

Returns#

number

Overrides#

BaseIndex.keyCount

supportsOrderOptimization#

Get Signature#

get supportsOrderOptimization(): boolean;

Defined in: packages/db/src/indexes/base-index.ts:259

Whether a query can use this index for its declared ordered prefix.

Returns#

boolean

Whether a query can use this index for its declared ordered prefix.

Inherited from#

BaseIndex.supportsOrderOptimization

supportsRangeOptimization#

Get Signature#

get supportsRangeOptimization(): boolean;

Defined in: packages/db/src/indexes/base-index.ts:255

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:37

Parameters#

key#

TKey

item#

any

Returns#

void

Overrides#

BaseIndex.add

addRangeValue()#

protected addRangeValue(value): void;

Defined in: packages/db/src/indexes/base-index.ts:277

Parameters#

value#

unknown

Returns#

void

Inherited from#

BaseIndex.addRangeValue

build()#

build(entries): void;

Defined in: packages/db/src/indexes/btree-index.ts:140

Parameters#

entries#

Iterable<[TKey, any]>

Returns#

void

Overrides#

BaseIndex.build

canOptimizeRangeFor()#

canOptimizeRangeFor(value): boolean;

Defined in: packages/db/src/indexes/base-index.ts:299

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#

BaseIndex.canOptimizeRangeFor

clear()#

clear(): void;

Defined in: packages/db/src/indexes/btree-index.ts:145

Returns#

void

Overrides#

BaseIndex.clear

clearRangeValues()#

protected clearRangeValues(): void;

Defined in: packages/db/src/indexes/base-index.ts:295

Returns#

void

Inherited from#

BaseIndex.clearRangeValues

equalityLookup()#

equalityLookup(value): Set<TKey>;

Defined in: packages/db/src/indexes/btree-index.ts:166

Parameters#

value#

any

Returns#

Set<TKey>

Overrides#

BaseIndex.equalityLookup

evaluateAddedValue()#

protected evaluateAddedValue(key, item): any;

Defined in: packages/db/src/indexes/base-index.ts:374

The indexed value of a row being added. A throwing expression fails the write.

Parameters#

key#

TKey

item#

any

Returns#

any

Inherited from#

BaseIndex.evaluateAddedValue

evaluateIndexExpression()#

protected evaluateIndexExpression(item): any;

Defined in: packages/db/src/indexes/base-index.ts:367

Parameters#

item#

any

Returns#

any

Inherited from#

BaseIndex.evaluateIndexExpression

exactBucketKeys()#

protected exactBucketKeys(value): Iterable<TKey, any, any> | undefined;

Defined in: packages/db/src/indexes/btree-index.ts:170

Parameters#

value#

any

Returns#

Iterable<TKey, any, any> | undefined

Overrides#

BaseIndex.exactBucketKeys

inArrayLookup()#

inArrayLookup(values): Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:228

Combine exact buckets without copying each bucket first.

Parameters#

values#

any[]

Returns#

Set<TKey>

Inherited from#

BaseIndex.inArrayLookup

initialize()#

protected initialize(_options?): void;

Defined in: packages/db/src/indexes/base-index.ts:365

Parameters#

_options?#

any

Returns#

void

Inherited from#

BaseIndex.initialize

lookup()#

lookup(operation, value): Set<TKey>;

Defined in: packages/db/src/indexes/btree-index.ts:152

Parameters#

operation#

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

value#

any

Returns#

Set<TKey>

Overrides#

BaseIndex.lookup

lookupSupportedOperation()#

protected lookupSupportedOperation(operation, value): Set<TKey> | undefined;

Defined in: packages/db/src/indexes/base-index.ts:211

Parameters#

operation#

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

value#

any

Returns#

Set<TKey> | undefined

Inherited from#

BaseIndex.lookupSupportedOperation

matchesCompareOptions()#

matchesCompareOptions(compareOptions): boolean;

Defined in: packages/db/src/indexes/base-index.ts:321

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:361

Checks if the index matches the provided direction.

Parameters#

direction#

OrderByDirection

Returns#

boolean

Inherited from#

BaseIndex.matchesDirection

matchesField()#

matchesField(fieldPath): boolean;

Defined in: packages/db/src/indexes/base-index.ts:309

Parameters#

fieldPath#

string[]

Returns#

boolean

Inherited from#

BaseIndex.matchesField

rangeQuery()#

rangeQuery(options): Set<TKey>;

Defined in: packages/db/src/indexes/btree-index.ts:176

Parameters#

options#

RangeQueryOptions = {}

Returns#

Set<TKey>

Overrides#

BaseIndex.rangeQuery

rangeQueryReversed()#

rangeQueryReversed(options): Set<TKey>;

Defined in: packages/db/src/indexes/base-index.ts:237

Parameters#

options#

RangeQueryOptions = {}

Returns#

Set<TKey>

Inherited from#

BaseIndex.rangeQueryReversed

remove()#

remove(key, item): void;

Defined in: packages/db/src/indexes/btree-index.ts:72

Parameters#

key#

TKey

item#

any

Returns#

void

Overrides#

BaseIndex.remove

removeRangeValue()#

protected removeRangeValue(value): void;

Defined in: packages/db/src/indexes/base-index.ts:286

Parameters#

value#

unknown

Returns#

void

Inherited from#

BaseIndex.removeRangeValue

supports()#

supports(operation): boolean;

Defined in: packages/db/src/indexes/base-index.ts:251

Parameters#

operation#

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

Returns#

boolean

Inherited from#

BaseIndex.supports

take()#

take(
   n, 
   from, 
   filterFn?): TKey[];

Defined in: packages/db/src/indexes/btree-index.ts:225

Parameters#

n#

number

from#

any

filterFn?#

(key) => boolean

Returns#

TKey[]

Overrides#

BaseIndex.take

takeFromStart()#

takeFromStart(n, filterFn?): TKey[];

Defined in: packages/db/src/indexes/btree-index.ts:229

Parameters#

n#

number

filterFn?#

(key) => boolean

Returns#

TKey[]

Overrides#

BaseIndex.takeFromStart

takeReversed()#

takeReversed(
   n, 
   from, 
   filterFn?): TKey[];

Defined in: packages/db/src/indexes/btree-index.ts:233

Parameters#

n#

number

from#

any

filterFn?#

(key) => boolean

Returns#

TKey[]

Overrides#

BaseIndex.takeReversed

takeReversedFromEnd()#

takeReversedFromEnd(n, filterFn?): TKey[];

Defined in: packages/db/src/indexes/btree-index.ts:241

Parameters#

n#

number

filterFn?#

(key) => boolean

Returns#

TKey[]

Overrides#

BaseIndex.takeReversedFromEnd

update()#

update(
   key, 
   oldItem, 
   newItem): void;

Defined in: packages/db/src/indexes/btree-index.ts:109

Parameters#

key#

TKey

oldItem#

any

newItem#

any

Returns#

void

Overrides#

BaseIndex.update