ReverseIndex

Defined in: packages/db/src/indexes/reverse-index.ts:5

Type Parameters#

TKey#

TKey extends string | number

Implements#

• IndexReader<TKey>

Constructors#

Constructor#

new ReverseIndex<TKey>(index, nullsFirst?): ReverseIndex<TKey>;

Defined in: packages/db/src/indexes/reverse-index.ts:16

Parameters#

index#

IndexInterface<TKey>

nullsFirst?#

boolean

Whether nullish values come first in the reversed order. The original index keeps them at the opposite end, so reversing it alone would move them; ordered reads put them back. Omit it to read the original index's plain reversed walk, as earlier releases did.

Returns#

ReverseIndex<TKey>

Accessors#

keyCount#

Get Signature#

get keyCount(): number;

Defined in: packages/db/src/indexes/reverse-index.ts:114

Returns#

number

Implementation of#

IndexReader.keyCount

supportsOrderOptimization#

Get Signature#

get supportsOrderOptimization(): boolean;

Defined in: packages/db/src/indexes/reverse-index.ts:106

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

Returns#

boolean

Implementation of#

IndexReader.supportsOrderOptimization

supportsRangeOptimization#

Get Signature#

get supportsRangeOptimization(): boolean;

Defined in: packages/db/src/indexes/reverse-index.ts:102

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

Implementation of#

IndexReader.supportsRangeOptimization

Methods#

canOptimizeRangeFor()#

canOptimizeRangeFor(value): boolean;

Defined in: packages/db/src/indexes/reverse-index.ts:110

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

Implementation of#

IndexReader.canOptimizeRangeFor

lookup()#

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

Defined in: packages/db/src/indexes/reverse-index.ts:25

Parameters#

operation#

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

value#

any

Returns#

Set<TKey>

Implementation of#

IndexReader.lookup

rangeQuery()#

rangeQuery(options): Set<TKey>;

Defined in: packages/db/src/indexes/reverse-index.ts:39

Parameters#

options#

RangeQueryOptions = {}

Returns#

Set<TKey>

Implementation of#

IndexReader.rangeQuery

supports()#

supports(operation): boolean;

Defined in: packages/db/src/indexes/reverse-index.ts:98

Parameters#

operation#

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

Returns#

boolean

Implementation of#

IndexReader.supports

take()#

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

Defined in: packages/db/src/indexes/reverse-index.ts:49

Parameters#

n#

number

from#

any

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexReader.take

takeFromStart()#

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

Defined in: packages/db/src/indexes/reverse-index.ts:56

Parameters#

n#

number

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexReader.takeFromStart