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