IndexerCurrentState interface

Package:

@azure/search-documents

Represents all of the state that defines and dictates the indexer's current execution.

Properties

allDocsFinalTrackingState	Change tracking state value when indexing finishes on all documents in the datasource.
allDocsInitialTrackingState	Change tracking state used when indexing starts on all documents in the datasource.
mode	The mode the indexer is running in.
resetDatasourceDocumentIds	The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
resetDocsFinalTrackingState	Change tracking state value when indexing finishes on select, reset documents in the datasource.
resetDocsInitialTrackingState	Change tracking state used when indexing starts on select, reset documents in the datasource.
resetDocumentKeys	The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
resyncFinalTrackingState	Change tracking state value when indexing finishes on selective options from the datasource.
resyncInitialTrackingState	Change tracking state used when indexing starts on selective options from the datasource.

Property Details

allDocsFinalTrackingState

Change tracking state value when indexing finishes on all documents in the datasource.

allDocsFinalTrackingState?: string

Property Value

string

allDocsInitialTrackingState

Change tracking state used when indexing starts on all documents in the datasource.

allDocsInitialTrackingState?: string

Property Value

string

mode

The mode the indexer is running in.

mode?: string

Property Value

string

resetDatasourceDocumentIds

The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.

resetDatasourceDocumentIds?: string[]

Property Value

string[]

resetDocsFinalTrackingState

Change tracking state value when indexing finishes on select, reset documents in the datasource.

resetDocsFinalTrackingState?: string

Property Value

string

resetDocsInitialTrackingState

Change tracking state used when indexing starts on select, reset documents in the datasource.

resetDocsInitialTrackingState?: string

Property Value

string

resetDocumentKeys

The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.

resetDocumentKeys?: string[]

Property Value

string[]

resyncFinalTrackingState

Change tracking state value when indexing finishes on selective options from the datasource.

resyncFinalTrackingState?: string

Property Value

string

resyncInitialTrackingState

Change tracking state used when indexing starts on selective options from the datasource.

resyncInitialTrackingState?: string

Property Value

string