Abstract Class: BaseIndex<TKey>#
Defined in: packages/db/src/indexes/base-index.ts:76
Base abstract class that all index types extend
Extended by#
Type Parameters#
TKey#
TKey extends string | number = string | number
Implements#
IndexInterface<TKey>
Constructors#
Constructor#
new BaseIndex<TKey>(
id,
expression,
name?,
options?): BaseIndex<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:89
Parameters#
id#
number
expression#
name?#
string
options?#
any
Returns#
BaseIndex<TKey>
Properties#
compareOptions#
protected compareOptions: CompareOptions;
Defined in: packages/db/src/indexes/base-index.ts:87
expression#
readonly expression: BasicExpression;
Defined in: packages/db/src/indexes/base-index.ts:81
id#
readonly id: number;
Defined in: packages/db/src/indexes/base-index.ts:79
lastUpdated#
protected lastUpdated: Date;
Defined in: packages/db/src/indexes/base-index.ts:86
lookupCount#
protected lookupCount: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:84
name?#
readonly optional name: string;
Defined in: packages/db/src/indexes/base-index.ts:80
supportedOperations#
abstract readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;
Defined in: packages/db/src/indexes/base-index.ts:82
totalLookupTime#
protected totalLookupTime: number = 0;
Defined in: packages/db/src/indexes/base-index.ts:85
Accessors#
indexedKeysSet#
Get Signature#
get abstract indexedKeysSet(): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:126
Returns#
Set<TKey>
Implementation of#
keyCount#
Get Signature#
get abstract keyCount(): number;
Defined in: packages/db/src/indexes/base-index.ts:119
Returns#
number
Implementation of#
orderedEntriesArray#
Get Signature#
get abstract orderedEntriesArray(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/base-index.ts:124
Returns#
[any, Set<TKey>][]
Implementation of#
IndexInterface.orderedEntriesArray
orderedEntriesArrayReversed#
Get Signature#
get abstract orderedEntriesArrayReversed(): [any, Set<TKey>][];
Defined in: packages/db/src/indexes/base-index.ts:125
Returns#
[any, Set<TKey>][]
Implementation of#
IndexInterface.orderedEntriesArrayReversed
valueMapData#
Get Signature#
get abstract valueMapData(): Map<any, Set<TKey>>;
Defined in: packages/db/src/indexes/base-index.ts:127
Returns#
Map<any, Set<TKey>>
Implementation of#
Methods#
add()#
abstract add(key, item): void;
Defined in: packages/db/src/indexes/base-index.ts:103
Parameters#
key#
TKey
item#
any
Returns#
void
Implementation of#
build()#
abstract build(entries): void;
Defined in: packages/db/src/indexes/base-index.ts:106
Parameters#
entries#
Iterable<[TKey, any]>
Returns#
void
Implementation of#
clear()#
abstract clear(): void;
Defined in: packages/db/src/indexes/base-index.ts:107
Returns#
void
Implementation of#
equalityLookup()#
abstract equalityLookup(value): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:120
Parameters#
value#
any
Returns#
Set<TKey>
Implementation of#
evaluateIndexExpression()#
protected evaluateIndexExpression(item): any;
Defined in: packages/db/src/indexes/base-index.ts:182
Parameters#
item#
any
Returns#
any
getStats()#
getStats(): IndexStats;
Defined in: packages/db/src/indexes/base-index.ts:169
Returns#
Implementation of#
inArrayLookup()#
abstract inArrayLookup(values): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:121
Parameters#
values#
any[]
Returns#
Set<TKey>
Implementation of#
initialize()#
abstract protected initialize(options?): void;
Defined in: packages/db/src/indexes/base-index.ts:180
Parameters#
options?#
any
Returns#
void
lookup()#
abstract lookup(operation, value): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:108
Parameters#
operation#
"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"
value#
any
Returns#
Set<TKey>
Implementation of#
matchesCompareOptions()#
matchesCompareOptions(compareOptions): boolean;
Defined in: packages/db/src/indexes/base-index.ts:146
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
Implementation of#
IndexInterface.matchesCompareOptions
matchesDirection()#
matchesDirection(direction): boolean;
Defined in: packages/db/src/indexes/base-index.ts:165
Checks if the index matches the provided direction.
Parameters#
direction#
Returns#
boolean
Implementation of#
IndexInterface.matchesDirection
matchesField()#
matchesField(fieldPath): boolean;
Defined in: packages/db/src/indexes/base-index.ts:134
Parameters#
fieldPath#
string[]
Returns#
boolean
Implementation of#
rangeQuery()#
abstract rangeQuery(options): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:122
Parameters#
options#
Returns#
Set<TKey>
Implementation of#
rangeQueryReversed()#
abstract rangeQueryReversed(options): Set<TKey>;
Defined in: packages/db/src/indexes/base-index.ts:123
Parameters#
options#
Returns#
Set<TKey>
Implementation of#
IndexInterface.rangeQueryReversed
remove()#
abstract remove(key, item): void;
Defined in: packages/db/src/indexes/base-index.ts:104
Parameters#
key#
TKey
item#
any
Returns#
void
Implementation of#
supports()#
supports(operation): boolean;
Defined in: packages/db/src/indexes/base-index.ts:130
Parameters#
operation#
"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"
Returns#
boolean
Implementation of#
take()#
abstract take(
n,
from?,
filterFn?): TKey[];
Defined in: packages/db/src/indexes/base-index.ts:109
Parameters#
n#
number
from?#
TKey
filterFn?#
(key) => boolean
Returns#
TKey[]
Implementation of#
takeReversed()#
abstract takeReversed(
n,
from?,
filterFn?): TKey[];
Defined in: packages/db/src/indexes/base-index.ts:114
Parameters#
n#
number
from?#
TKey
filterFn?#
(key) => boolean
Returns#
TKey[]
Implementation of#
trackLookup()#
protected trackLookup(startTime): void;
Defined in: packages/db/src/indexes/base-index.ts:187
Parameters#
startTime#
number
Returns#
void
update()#
abstract update(
key,
oldItem,
newItem): void;
Defined in: packages/db/src/indexes/base-index.ts:105
Parameters#
key#
TKey
oldItem#
any
newItem#
any
Returns#
void
Implementation of#
updateTimestamp()#
protected updateTimestamp(): void;
Defined in: packages/db/src/indexes/base-index.ts:193
Returns#
void