Delete By Query API
editDelete By Query API
editDelete By Query Request
editA DeleteByQueryRequest
can be used to delete documents from an index. It requires an existing index (or a set of indices)
on which deletion is to be performed.
The simplest form of a DeleteByQueryRequest
looks like:
By default version conflicts abort the DeleteByQueryRequest
process but you can just count them by settings it to
proceed
in the request body
You can limit the documents by adding a query.
It’s also possible to limit the number of processed documents by setting size.
By default DeleteByQueryRequest
uses batches of 1000. You can change the batch size with setBatchSize
.
DeleteByQueryRequest
also helps in automatically parallelizing using sliced-scroll
to
slice on _uid
. Use setSlices
to specify the number of slices to use.
DeleteByQueryRequest
uses the scroll
parameter to control how long it keeps the "search context" alive.
If you provide routing then the routing is copied to the scroll query, limiting the process to the shards that match that routing value.
Optional arguments
editIn addition to the options above the following arguments can optionally be also provided:
Synchronous Execution
editBulkByScrollResponse bulkResponse = client.deleteByQuery(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of an delete by query request requires both the DeleteByQueryRequest
instance and an ActionListener
instance to be passed to the asynchronous
method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed.
A typical listener for BulkByScrollResponse
looks like:
ActionListener<BulkByScrollResponse> listener = new ActionListener<BulkByScrollResponse>() { @Override public void onResponse(BulkByScrollResponse bulkResponse) { } @Override public void onFailure(Exception e) { } };
Called when the execution is successfully completed. The response is provided as an argument and contains a list of individual results for each operation that was executed. Note that one or more operations might have failed while the others have been successfully executed. |
|
Called when the whole |
Delete By Query Response
editThe returned BulkByScrollResponse
contains information about the executed operations and
allows to iterate over each result as follows:
TimeValue timeTaken = bulkResponse.getTook(); boolean timedOut = bulkResponse.isTimedOut(); long totalDocs = bulkResponse.getTotal(); long deletedDocs = bulkResponse.getDeleted(); long batches = bulkResponse.getBatches(); long noops = bulkResponse.getNoops(); long versionConflicts = bulkResponse.getVersionConflicts(); long bulkRetries = bulkResponse.getBulkRetries(); long searchRetries = bulkResponse.getSearchRetries(); TimeValue throttledMillis = bulkResponse.getStatus().getThrottled(); TimeValue throttledUntilMillis = bulkResponse.getStatus().getThrottledUntil(); List<ScrollableHitSource.SearchFailure> searchFailures = bulkResponse.getSearchFailures(); List<BulkItemResponse.Failure> bulkFailures = bulkResponse.getBulkFailures();
Get total time taken |
|
Check if the request timed out |
|
Get total number of docs processed |
|
Number of docs that were deleted |
|
Number of batches that were executed |
|
Number of skipped docs |
|
Number of version conflicts |
|
Number of times request had to retry bulk index operations |
|
Number of times request had to retry search operations |
|
The total time this request has throttled itself not including the current throttle time if it is currently sleeping |
|
Remaining delay of any current throttle sleep or 0 if not sleeping |
|
Failures during search phase |
|
Failures during bulk index operation |