Class StructuredInMemoryBackend

In-memory structured backend with its own maps and query implementation.

It shares only the neutral structured record builders used by every storage implementation. It does not instantiate or depend on the cloud driver.

Implements

StructuredSearchDependencies
StructuredWriter

Index

Constructors

constructor

new StructuredInMemoryBackend(
tokenizer?: Partial<StructuredStringTokenizerConfig>,
): StructuredInMemoryBackend
Parameters
- Optionaltokenizer: Partial<StructuredStringTokenizerConfig>
  Optional tokenizer overrides for structured contains indexing.
Returns StructuredInMemoryBackend
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:133

Methods

activateOccupancyRebuild

activateOccupancyRebuild(): Promise<void>
Activate an optional replacement generation.

Returns Promise<void>
Deprecated
Prefer occupancyMaintenance.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:570

beginOccupancyRebuild

beginOccupancyRebuild(generation: string): Promise<void>
Begin an optional replacement-generation repair/compaction.
Parameters
- generation: string
Returns Promise<void>
Deprecated
Prefer occupancyMaintenance.
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:561

snapshotIndexRecordMap

snapshotIndexRecordMap(): ReadonlyMap<string, Record<string, unknown>>
Deep-cloned keyed map of conceptual in-memory index records.

Returns ReadonlyMap<string, Record<string, unknown>>
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:580

snapshotIndexRecords

snapshotIndexRecords(): Record<string, unknown>[]
Deep-cloned conceptual records stored by the in-memory backend.

Returns Record<string, unknown>[]
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:575

write

write(
    docId: DocId,
    fields: StructuredDocFieldsRecord,
    context?: StructuredWriteContext,
): Promise<void>
Write canonical and derived records through the generic structured strategy.
Parameters
- docId: DocId
- fields: StructuredDocFieldsRecord
- context: StructuredWriteContext = {}
Returns Promise<void>
Implementation of StructuredWriter.write
- Defined in api/ORM/drivers/InMemoryDataItemDBDriver/Indexing/StructuredInMemoryBackend.ts:548

Properties

`Readonly`documents

documents:
    | {
        get(docId: DocId): Promise<StructuredDocFieldsRecord | undefined>;
        getMany?(
            docIds: DocId[],
        ): Promise<ReadonlyMap<DocId, StructuredDocFieldsRecord>>;
        list?(
            options?: StructuredDocumentListOptions,
        ): Promise<StructuredDocumentPage>;
    }
    | undefined = ...

Canonical structured fields used by compound verification.

Type Declaration

{
    get(docId: DocId): Promise<StructuredDocFieldsRecord | undefined>;
    getMany?(
        docIds: DocId[],
    ): Promise<ReadonlyMap<DocId, StructuredDocFieldsRecord>>;
    list?(
        options?: StructuredDocumentListOptions,
    ): Promise<StructuredDocumentPage>;
}
- get: function
  - get(docId: DocId): Promise<StructuredDocFieldsRecord | undefined>
    Parameters
    docId: DocId
    Returns Promise<StructuredDocFieldsRecord | undefined>
    Defined in api/Indexing/structured/SearchStructured.ts:131
- getMany?: function
  - getMany?(
    docIds: DocId[],
    ): Promise<ReadonlyMap<DocId, StructuredDocFieldsRecord>>
    Batch-load canonical fields when the storage backend supports it.
    Parameters
    docIds: DocId[]
    Returns Promise<ReadonlyMap<DocId, StructuredDocFieldsRecord>>
    Defined in api/Indexing/structured/SearchStructured.ts:133
- list?: function
  - list?(options?: StructuredDocumentListOptions): Promise<StructuredDocumentPage>
    Enumerate bounded structured document mirrors for maintenance.
    Parameters
    Optionaloptions: StructuredDocumentListOptions
    Returns Promise<StructuredDocumentPage>
    Defined in api/Indexing/structured/SearchStructured.ts:137
undefined

`Readonly`missing

missing: StructuredMissingIndex = ...

Stable document-id stream for missing eligible sort values.

`Readonly`occupancy

occupancy: StructuredOccupancyIndex = ...

Sparse occupancy traversal over persisted in-memory records.

`Readonly`occupancyMaintenance

occupancyMaintenance: {
    activateRebuild: () => Promise<void>;
    backfill: (
        documents:
            | Iterable<StructuredOccupancyBackfillDocument, any, any>
            | AsyncIterable<StructuredOccupancyBackfillDocument, any, any>,
    ) => Promise<number>;
    backfillDocument: (
        document: StructuredOccupancyBackfillDocument,
    ) => Promise<void>;
    beginRebuild: (generation: string) => Promise<void>;
    getState: () => Promise<StructuredOccupancyGenerationState>;
    retireGeneration: (generation: string, fields: string[]) => Promise<number>;
} = ...

Optional in-memory repair/compaction lifecycle.

`Readonly`ranges

ranges: StructuredRangeIndex = ...

Range traversal over independently stored range records.

`Readonly`terms

terms: StructuredTermIndex = ...

Term lookup over independently stored term records.

`Optional` `Readonly`tokenizer

tokenizer?: Partial<StructuredStringTokenizerConfig>

Optional tokenizer overrides for structured contains indexing.

Class StructuredInMemoryBackend

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns StructuredInMemoryBackend

Methods

activateOccupancyRebuild

Returns Promise<void>

Deprecated

beginOccupancyRebuild

Parameters

Returns Promise<void>

Deprecated

snapshotIndexRecordMap

Returns ReadonlyMap<string, Record<string, unknown>>

snapshotIndexRecords

Returns Record<string, unknown>[]

write

Parameters

Returns Promise<void>

Properties

Readonlydocuments

Type Declaration

get: function

Parameters

Returns Promise<StructuredDocFieldsRecord | undefined>

getMany?: function

Parameters

Returns Promise<ReadonlyMap<DocId, StructuredDocFieldsRecord>>

list?: function

Parameters

Returns Promise<StructuredDocumentPage>

Readonlymissing

Readonlyoccupancy

ReadonlyoccupancyMaintenance

Readonlyranges

Readonlyterms

Optional Readonlytokenizer

Settings

On This Page

`Readonly`documents

`Readonly`missing

`Readonly`occupancy

`Readonly`occupancyMaintenance

`Readonly`ranges

`Readonly`terms

`Optional` `Readonly`tokenizer