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
| Property | Modifier | Type | Defined in |
|---|---|---|---|
id | readonly | string | packages/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
| Parameter | Type |
|---|---|
ids | string | 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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
query | TQuery |
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
| Parameter | Type |
|---|---|
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
| Parameter | Type |
|---|---|
index | string |
Returns
Promise<void>