BaseIndex

Class: abstract BaseIndex<TKey>

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

Base abstract class that all index types extend

Extended by

Type Parameters

TKey extends string | number = string | number

Constructors

new BaseIndex()

ts
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:40

Parameters

id

number

expression

BasicExpression

name?

string

options?

any

Returns

BaseIndex<TKey>

Properties

expression

ts
readonly expression: BasicExpression;
readonly expression: BasicExpression;

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


id

ts
readonly id: number;
readonly id: number;

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


lastUpdated

ts
protected lastUpdated: Date;
protected lastUpdated: Date;

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


lookupCount

ts
protected lookupCount: number = 0;
protected lookupCount: number = 0;

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


name?

ts
readonly optional name: string;
readonly optional name: string;

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


supportedOperations

ts
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:34


totalLookupTime

ts
protected totalLookupTime: number = 0;
protected totalLookupTime: number = 0;

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

Accessors

keyCount

Get Signature

ts
get abstract keyCount(): number
get abstract keyCount(): number

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

Returns

number

Methods

add()

ts
abstract add(key, item): void
abstract add(key, item): void

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

Parameters

key

TKey

item

any

Returns

void


build()

ts
abstract build(entries): void
abstract build(entries): void

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

Parameters

entries

Iterable<[TKey, any]>

Returns

void


clear()

ts
abstract clear(): void
abstract clear(): void

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

Returns

void


evaluateIndexExpression()

ts
protected evaluateIndexExpression(item): any
protected evaluateIndexExpression(item): any

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

Parameters

item

any

Returns

any


getStats()

ts
getStats(): IndexStats
getStats(): IndexStats

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

Returns

IndexStats


initialize()

ts
abstract protected initialize(options?): void
abstract protected initialize(options?): void

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

Parameters

options?

any

Returns

void


lookup()

ts
abstract lookup(operation, value): Set<TKey>
abstract lookup(operation, value): Set<TKey>

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

Parameters

operation

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

value

any

Returns

Set<TKey>


matchesField()

ts
matchesField(fieldPath): boolean
matchesField(fieldPath): boolean

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

Parameters

fieldPath

string[]

Returns

boolean


remove()

ts
abstract remove(key, item): void
abstract remove(key, item): void

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

Parameters

key

TKey

item

any

Returns

void


supports()

ts
supports(operation): boolean
supports(operation): boolean

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

Parameters

operation

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

Returns

boolean


trackLookup()

ts
protected trackLookup(startTime): void
protected trackLookup(startTime): void

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

Parameters

startTime

number

Returns

void


update()

ts
abstract update(
   key, 
   oldItem, 
   newItem): void
abstract update(
   key, 
   oldItem, 
   newItem): void

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

Parameters

key

TKey

oldItem

any

newItem

any

Returns

void


updateTimestamp()

ts
protected updateTimestamp(): void
protected updateTimestamp(): void

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

Returns

void