Type Alias TextIndexMaintenance

Optional document-level maintenance capability for text indexes.

This surface intentionally operates on persisted qualified fields and ids so repair tooling does not need a deleted canonical item snapshot.

type TextIndexMaintenance = {
    listDocuments(
        options?: TextIndexDocumentListOptions,
    ): Promise<TextIndexDocumentPage>;
    readDocumentIndex(
        docId: DocId,
        indexField: string,
    ): Promise<string | undefined>;
    removeDocumentIndex(docId: DocId, indexField: string): Promise<void>;
}

Index

Methods

listDocuments readDocumentIndex removeDocumentIndex

Methods

listDocuments

listDocuments(
options?: TextIndexDocumentListOptions,
): Promise<TextIndexDocumentPage>
Enumerate a bounded page of indexed document/field mirrors.
Parameters
- Optionaloptions: TextIndexDocumentListOptions
Returns Promise<TextIndexDocumentPage>
- Defined in api/Indexing/Types.ts:321

readDocumentIndex

readDocumentIndex(docId: DocId, indexField: string): Promise<string | undefined>
Read the normalized persisted document mirror for one document/field pair.

Undefined means no current text-index mirror exists.
Parameters
- docId: DocId
- indexField: string
Returns Promise<string | undefined>
- Defined in api/Indexing/Types.ts:329

removeDocumentIndex

removeDocumentIndex(docId: DocId, indexField: string): Promise<void>
Remove every text-index artifact for one document/field pair.
Parameters
- docId: DocId
- indexField: string
Returns Promise<void>
- Defined in api/Indexing/Types.ts:334