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
$getIndexErrorsOp = new GetIndexErrorsOperation();
// Execute the operation by passing it to maintenance.send
/** @var IndexErrorsArray $indexErrors */
$indexErrors = $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
$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
/** @var IndexErrorsArray $indexErrors */
$indexErrors = $store->maintenance()->send($getIndexErrorsOp);
// indexErrors will contain errors only for index "Orders/Totals"
Syntax
// Available overloads:
GetIndexErrorsOperation() // Get errors for all indexes
GetIndexErrorsOperation(array $indexNames) // Get errors for specific indexes
Parameters | Type | Description |
---|---|---|
$indexNames | array |
List of index names to get errors for |
$getIndexErrorsOp operation Return value |
Description |
---|---|
?IndexingErrorArray |
List of IndexingError classes - see definition below.An exception is thrown if any of the specified indexes doesn't exist. |
public class IndexErrors
{
private ?string $name = null; // Index name
private ?IndexingErrorArray $errors = null; // List of errors for this index
// ... getters and setters
}
public class IndexingError
{
// The error message
private ?string $error = null;
// Time of error
private ?DateTimeInterface $timestamp = null;
// 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
private ?string $document = null;
// Area where error has occurred, e.g. Map/Reduce/Analyzer/Memory/etc.
private ?string $action = null;
// ... getters and setters
}