Get Index Errors Operation
-
Use
GetIndexErrorsOperation
to get errors encountered during indexing. -
The index errors will be retrieved only from the server node defined by the current client-configuration.
-
To learn about clearing index errors, see delete index errors.
-
In this page:
Get errors for all indexes
// Define the get index errors operation
const getIndexErrorsOp = new GetIndexErrorsOperation();
// Execute the operation by passing it to maintenance.send
const indexErrors = await store.maintenance.send(getIndexErrorsOp);
// indexErrors will contain errors for ALL indexes
Get errors for specific indexes
// Define the get index errors operation for specific indexes
const getIndexErrorsOp = new GetIndexErrorsOperation(["Orders/Totals"]);
// Execute the operation by passing it to maintenance.send
// An exception will be thrown if any of the specified indexes do not exist
const indexErrors = await store.maintenance.send(getIndexErrorsOp);
// indexErrors will contain errors only for index "Orders/Totals"
Syntax
// Available overloads:
const getIndexErrorsOp = new GetIndexErrorsOperation(); // Get errors for all indexes
const getIndexErrorsOp = new GetIndexErrorsOperation(indexNames); // Get errors for specific indexes
Parameters | Type | Description |
---|---|---|
indexNames | string[] |
List of index names to get errors for |
Return value ofstore.maintenance.send(getIndexErrorsOp) |
Description |
---|---|
object[] |
List of 'index errors' objects - see definition below. An exception is thrown if any of the specified indexes doesn't exist. |
// An 'index errors' object:
{
name, // Index name
errors // List of 'error objects' for this index
}
// An 'error object':
{
// The error message
error,
// Time of error
timestamp,
// If Action is 'Map' - field will contain the document ID
// If Action is 'Reduce' - field will contain the Reduce key value
// For all other Actions - field will be null
document,
// Area where error has occurred, e.g. Map/Reduce/Analyzer/Memory/etc.
action
}