Class StructuredIndexWriter

Storage-neutral writer that diffs structured fields and persists term/range entries through driver dependencies.

Index

Constructors

Methods

Constructors

constructor

new StructuredIndexWriter(
dependencies: StructuredWriterDependencies,
options?: StructuredWriterOptions,
): StructuredIndexWriter
Parameters
- dependencies: StructuredWriterDependencies
  Writer dependencies for persistence.
- options: StructuredWriterOptions = {}
Returns StructuredIndexWriter
- Defined in api/Indexing/structured/StructuredWriter.ts:283

Methods

write

write(
    docId: DocId,
    fields: StructuredDocFieldsRecord,
    context?: StructuredWriteContext,
): Promise<void>
Write structured fields for a document, diffing term/range entries.
Parameters
- docId: DocId
  Document id to write.
- fields: StructuredDocFieldsRecord
  Structured fields to store.
- context: StructuredWriteContext = {}
Returns Promise<void>
Promise resolved once all writes complete.
- Defined in api/Indexing/structured/StructuredWriter.ts:296