Type Alias StructuredWriterDependencies

Dependencies required to persist structured index entries.

type StructuredWriterDependencies = {
    deleteRangeEntries(entries: StructuredRangeIndexKey[]): Promise<void>;
    deleteTermEntries(entries: StructuredTermIndexKey[]): Promise<void>;
    loadDocFieldsState(
        docId: DocId,
    ): Promise<StructuredDocFieldsState | undefined>;
    putDocFieldsIfVersion(
        docId: DocId,
        expectedVersion: number | undefined,
        fields: StructuredDocFieldsRecord,
    ): Promise<boolean>;
    putRangeEntries(entries: StructuredRangeIndexItem[]): Promise<void>;
    putTermEntries(entries: StructuredTermIndexItem[]): Promise<void>;
}

Index

Methods

deleteRangeEntries deleteTermEntries loadDocFieldsState putDocFieldsIfVersion putRangeEntries putTermEntries

Methods

deleteRangeEntries

deleteRangeEntries(entries: StructuredRangeIndexKey[]): Promise<void>
Delete range index entries.
Parameters
- entries: StructuredRangeIndexKey[]
  Range entry keys to delete.
Returns Promise<void>
Promise resolved once deleted.
- Defined in api/Indexing/structured/StructuredWriter.ts:65

deleteTermEntries

deleteTermEntries(entries: StructuredTermIndexKey[]): Promise<void>
Delete term index entries.
Parameters
- entries: StructuredTermIndexKey[]
  Term entry keys to delete.
Returns Promise<void>
Promise resolved once deleted.
- Defined in api/Indexing/structured/StructuredWriter.ts:53

loadDocFieldsState

loadDocFieldsState(docId: DocId): Promise<StructuredDocFieldsState | undefined>
Load previously stored fields for a document.
Parameters
- docId: DocId
  Document id to load.
Returns Promise<StructuredDocFieldsState | undefined>
Stored fields or undefined when missing.
- Defined in api/Indexing/structured/StructuredWriter.ts:29

putDocFieldsIfVersion

putDocFieldsIfVersion(
    docId: DocId,
    expectedVersion: number | undefined,
    fields: StructuredDocFieldsRecord,
): Promise<boolean>
Compare-and-swap the latest fields for a document.
Parameters
- docId: DocId
  Document id to store.
- expectedVersion: number | undefined
  Version expected by the caller.
- fields: StructuredDocFieldsRecord
  Structured fields to persist.
Returns Promise<boolean>
True when swap succeeds, false on version mismatch.
- Defined in api/Indexing/structured/StructuredWriter.ts:37

putRangeEntries

putRangeEntries(entries: StructuredRangeIndexItem[]): Promise<void>
Store range index entries.
Parameters
- entries: StructuredRangeIndexItem[]
  Range entries to store.
Returns Promise<void>
Promise resolved once stored.
- Defined in api/Indexing/structured/StructuredWriter.ts:59

putTermEntries

putTermEntries(entries: StructuredTermIndexItem[]): Promise<void>
Store term index entries.
Parameters
- entries: StructuredTermIndexItem[]
  Term entries to store.
Returns Promise<void>
Promise resolved once stored.
- Defined in api/Indexing/structured/StructuredWriter.ts:47