Type Alias StructuredWriterDependencies

Dependencies required to persist structured index entries.

type StructuredWriterDependencies = {
    deleteRangeEntries(entries: IndexTableKey[]): Promise<void>;
    deleteTermEntries(entries: IndexTableKey[]): Promise<void>;
    loadDocFieldsState(
        docId: DocId,
    ): Promise<StructuredDocFieldsState | undefined>;
    loadOccupancyGenerationState?(): Promise<
        StructuredOccupancyGenerationState
        | undefined,
    >;
    putDocFieldsIfVersion(
        docId: DocId,
        expectedVersion: number | undefined,
        fields: StructuredDocFieldsRecord,
        occupancyFields?: StructuredOccupancyFieldMap,
    ): Promise<boolean>;
    putRangeEntries(entries: StructuredRangeIndexItem[]): Promise<void>;
    putTermEntries(entries: StructuredTermIndexItem[]): Promise<void>;
    writeDerivedEntries?(mutation: StructuredDerivedMutation): Promise<void>;
}

Index

Methods

deleteRangeEntries deleteTermEntries loadDocFieldsState loadOccupancyGenerationState? putDocFieldsIfVersion putRangeEntries putTermEntries writeDerivedEntries?

Methods

deleteRangeEntries

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

deleteTermEntries

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

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:38

`Optional`loadOccupancyGenerationState

loadOccupancyGenerationState?(): Promise<
StructuredOccupancyGenerationState
| undefined,
>
Load active/building occupancy generations.

Returns Promise<StructuredOccupancyGenerationState | undefined>
- Defined in api/Indexing/structured/StructuredWriter.ts:79

putDocFieldsIfVersion

putDocFieldsIfVersion(
    docId: DocId,
    expectedVersion: number | undefined,
    fields: StructuredDocFieldsRecord,
    occupancyFields?: StructuredOccupancyFieldMap,
): 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.
- OptionaloccupancyFields: StructuredOccupancyFieldMap
Returns Promise<boolean>
True when swap succeeds, false on version mismatch.
- Defined in api/Indexing/structured/StructuredWriter.ts:48

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:71

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:59

`Optional`writeDerivedEntries

writeDerivedEntries?(mutation: StructuredDerivedMutation): Promise<void>
Apply all derived structured mutations through one batched coordinator.
Parameters
- mutation: StructuredDerivedMutation
Returns Promise<void>
- Defined in api/Indexing/structured/StructuredWriter.ts:83

Type Alias StructuredWriterDependencies

Index

Methods

Methods

deleteRangeEntries

Parameters

Returns Promise<void>

deleteTermEntries

Parameters

Returns Promise<void>

loadDocFieldsState

Parameters

Returns Promise<StructuredDocFieldsState | undefined>

`Optional`loadOccupancyGenerationState

Returns Promise<StructuredOccupancyGenerationState | undefined>

putDocFieldsIfVersion

Parameters

Returns Promise<boolean>

putRangeEntries

Parameters

Returns Promise<void>

putTermEntries

Parameters

Returns Promise<void>

`Optional`writeDerivedEntries

Parameters

Returns Promise<void>

Settings

On This Page

Type Alias StructuredWriterDependencies

Index

Methods

Methods

deleteRangeEntries

Parameters

Returns Promise<void>

deleteTermEntries

Parameters

Returns Promise<void>

loadDocFieldsState

Parameters

Returns Promise<StructuredDocFieldsState | undefined>

OptionalloadOccupancyGenerationState

Returns Promise<StructuredOccupancyGenerationState | undefined>

putDocFieldsIfVersion

Parameters

Returns Promise<boolean>

putRangeEntries

Parameters

Returns Promise<void>

putTermEntries

Parameters

Returns Promise<void>

OptionalwriteDerivedEntries

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`loadOccupancyGenerationState

`Optional`writeDerivedEntries