BatchIndexer | ioredisearch

A batch indexer allows you to automatically batch document indexing in pipelines, flushing it every N documents.

Hierarchy

BatchIndexer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BatchIndexer(client: Client, chunkSize?: number): BatchIndexer

- Defined in batch-indexer.ts:23
Parameters
- client: Client
- Default value chunkSize: number = 1000
Returns BatchIndexer

Properties

Private chunkSize

chunkSize: number

Private client

client: Client

Private pipeline

pipeline: Redis

Methods

addDocuments

addDocuments<T>(docs: BatchDoc<T>[], noSave?: boolean, replace?: boolean, partial?: boolean): Promise<"OK">

- Defined in batch-indexer.ts:36
Add multiple documents via Redis pipelining

Type parameters
- T: SchemaDictionary
Parameters
- docs: BatchDoc<T>[]
  
  array of objects containing document related properties (score defaults to 1.0 if omitted)
- Default value noSave: boolean = false
- Default value replace: boolean = false
- Default value partial: boolean = false
Returns Promise<"OK">

Private commit

commit(): Promise<any>

- Defined in batch-indexer.ts:78
Manually commit and flush the batch indexing query

Returns Promise<any>

Private partialAddDoc

partialAddDoc<T>(noSave: boolean, replace: boolean, partial: boolean): (Anonymous function)

- Defined in batch-indexer.ts:57
Type parameters
- T
Parameters
- noSave: boolean
- replace: boolean
- partial: boolean
Returns (Anonymous function)

Generated using TypeDoc