Type Alias StructuredWriterDependencies

Dependencies required to persist structured index entries.

type StructuredWriterDependencies = {
    deleteRangeEntries(entries: StructuredRangeIndexKey[]): Promise<void>;
    deleteTermEntries(entries: StructuredTermIndexKey[]): Promise<void>;
    loadDocFields(docId: DocId): Promise<StructuredDocFieldsRecord | undefined>;
    putDocFields(
        docId: DocId,
        fields: StructuredDocFieldsRecord,
    ): Promise<void>;
    putRangeEntries(entries: StructuredRangeIndexItem[]): Promise<void>;
    putTermEntries(entries: StructuredTermIndexItem[]): Promise<void>;
}

Index

Methods

deleteRangeEntries deleteTermEntries loadDocFields putDocFields 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:56

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

loadDocFields

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

putDocFields

putDocFields(docId: DocId, fields: StructuredDocFieldsRecord): Promise<void>
Store the latest fields for a document.
Parameters
- docId: DocId
  Document id to store.
- fields: StructuredDocFieldsRecord
  Structured fields to persist.
Returns Promise<void>
Promise resolved once stored.
- Defined in api/Indexing/structured/StructuredWriter.ts:32

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

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