Skip to main content
Version: 2026.0

IncrementalIndexerRunConfig

Configuration for the incremental indexer.

Methods

addUid

addUid(pUid): IncrementalIndexerRunConfig

Adds a uid, that should be indexed.

Parameters

pUid
string | number | boolean

the uid

Returns

IncrementalIndexerRunConfig

addUids

addUids(pUids): IncrementalIndexerRunConfig

Adds multiple uids, that should be indexed.

Parameters

pUids
string[]

the uids

Returns

IncrementalIndexerRunConfig

group

group(pGroup): IncrementalIndexerRunConfig

Specifies the group that should be indexed.

Parameters

pGroup
string | number | boolean

the group

Returns

IncrementalIndexerRunConfig

runImmediately

runImmediately(): IncrementalIndexerRunConfig

Notifies the incremental indexer, that the update should be performed immediately, without delay.

Only run the indexing immediately if necessary, the indexer will automatically group indexing tasks within a time span, to maximize performance. Running the indexer immediately bypasses the delay required to accumulate similar indexing tasks.

Returns

IncrementalIndexerRunConfig