Class: ReverseIndex<TKey>#

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

Type Parameters#

TKey#

TKey extends string | number

Implements#

• IndexInterface<TKey>

Constructors#

Constructor#

new ReverseIndex<TKey>(index): ReverseIndex<TKey>;

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

Parameters#

index#

IndexInterface<TKey>

Returns#

ReverseIndex<TKey>

Accessors#

indexedKeysSet#

Get Signature#

get indexedKeysSet(): Set<TKey>;

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

Returns#

Set<TKey>

Implementation of#

IndexInterface.indexedKeysSet

keyCount#

Get Signature#

get keyCount(): number;

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

Returns#

number

Implementation of#

IndexInterface.keyCount

orderedEntriesArray#

Get Signature#

get orderedEntriesArray(): [any, Set<TKey>][];

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

Returns#

[any, Set<TKey>][]

Implementation of#

IndexInterface.orderedEntriesArray

orderedEntriesArrayReversed#

Get Signature#

get orderedEntriesArrayReversed(): [any, Set<TKey>][];

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

Returns#

[any, Set<TKey>][]

Implementation of#

IndexInterface.orderedEntriesArrayReversed

supportsRangeOptimization#

Get Signature#

get supportsRangeOptimization(): boolean;

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

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#

IndexInterface.supportsRangeOptimization

valueMapData#

Get Signature#

get valueMapData(): Map<any, Set<TKey>>;

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

Returns#

Map<any, Set<TKey>>

Implementation of#

IndexInterface.valueMapData

Methods#

add()#

add(key, item): void;

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

Parameters#

key#

TKey

item#

any

Returns#

void

Implementation of#

IndexInterface.add

build()#

build(entries): void;

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

Parameters#

entries#

Iterable<[TKey, any]>

Returns#

void

Implementation of#

IndexInterface.build

clear()#

clear(): void;

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

Returns#

void

Implementation of#

IndexInterface.clear

equalityLookup()#

equalityLookup(value): Set<TKey>;

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

Parameters#

value#

any

Returns#

Set<TKey>

Implementation of#

IndexInterface.equalityLookup

getStats()#

getStats(): IndexStats;

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

Returns#

IndexStats

Implementation of#

IndexInterface.getStats

inArrayLookup()#

inArrayLookup(values): Set<TKey>;

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

Parameters#

values#

any[]

Returns#

Set<TKey>

Implementation of#

IndexInterface.inArrayLookup

lookup()#

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

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

Parameters#

operation#

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

value#

any

Returns#

Set<TKey>

Implementation of#

IndexInterface.lookup

matchesCompareOptions()#

matchesCompareOptions(compareOptions): boolean;

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

Parameters#

compareOptions#

CompareOptions

Returns#

boolean

Implementation of#

IndexInterface.matchesCompareOptions

matchesDirection()#

matchesDirection(direction): boolean;

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

Parameters#

direction#

OrderByDirection

Returns#

boolean

Implementation of#

IndexInterface.matchesDirection

matchesField()#

matchesField(fieldPath): boolean;

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

Parameters#

fieldPath#

string[]

Returns#

boolean

Implementation of#

IndexInterface.matchesField

rangeQuery()#

rangeQuery(options): Set<TKey>;

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

Parameters#

options#

BTreeRangeQueryOptions = {}

Returns#

Set<TKey>

Implementation of#

IndexInterface.rangeQuery

rangeQueryReversed()#

rangeQueryReversed(options): Set<TKey>;

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

Parameters#

options#

BTreeRangeQueryOptions = {}

Returns#

Set<TKey>

Implementation of#

IndexInterface.rangeQueryReversed

remove()#

remove(key, item): void;

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

Parameters#

key#

TKey

item#

any

Returns#

void

Implementation of#

IndexInterface.remove

supports()#

supports(operation): boolean;

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

Parameters#

operation#

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

Returns#

boolean

Implementation of#

IndexInterface.supports

take()#

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

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

Parameters#

n#

number

from#

any

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexInterface.take

takeFromStart()#

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

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

Parameters#

n#

number

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexInterface.takeFromStart

takeReversed()#

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

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

Parameters#

n#

number

from#

any

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexInterface.takeReversed

takeReversedFromEnd()#

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

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

Parameters#

n#

number

filterFn?#

(key) => boolean

Returns#

TKey[]

Implementation of#

IndexInterface.takeReversedFromEnd

update()#

update(
   key, 
   oldItem, 
   newItem): void;

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

Parameters#

key#

TKey

oldItem#

any

newItem#

any

Returns#

void

Implementation of#

IndexInterface.update