kernl
ReferencekernlInterfaces

Interface: MemoryIndexBase<TQuery, TResult>

Defined in: packages/kernl/src/memory/indexes.ts:23

Base interface for memory indexes.

All indexes share common lifecycle operations (index, patch, delete) but differ in their query interface.

Extended by

Type Parameters

Type Parameter
TQuery
TResult

Properties

PropertyModifierTypeDefined in
idreadonlystringpackages/kernl/src/memory/indexes.ts:24

Methods

delete()

delete(ids: string | string[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:44

Remove one or more records from this index (DB row remains).

Parameters

ParameterType
idsstring | string[]

Returns

Promise<void>


index()

index(memories: 
  | MemoryRecord
| MemoryRecord[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:34

Index one or more memory records (idempotent upsert).

Parameters

ParameterType
memories| MemoryRecord | MemoryRecord[]

Returns

Promise<void>


query()

query(query: TQuery): Promise<TResult>;

Defined in: packages/kernl/src/memory/indexes.ts:29

Query the index.

Parameters

ParameterType
queryTQuery

Returns

Promise<TResult>


update()

update(updates: 
  | MemoryRecordUpdate
| MemoryRecordUpdate[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:39

Partially update one or more records' projections.

Parameters

ParameterType
updates| MemoryRecordUpdate | MemoryRecordUpdate[]

Returns

Promise<void>


warm()

warm(index: string): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:49

Index warming (optional).

Parameters

ParameterType
indexstring

Returns

Promise<void>

On this page