Merge pull request #22235 from dadoonet/doc/dbq-java-api

Add documentation for Delete By Query Java API
This commit is contained in:
David Pilato 2016-12-23 16:04:19 +01:00 committed by GitHub
commit 4fba1c562f
2 changed files with 46 additions and 0 deletions

View File

@ -7,6 +7,7 @@ This section describes the following CRUD APIs:
* <<java-docs-index>> * <<java-docs-index>>
* <<java-docs-get>> * <<java-docs-get>>
* <<java-docs-delete>> * <<java-docs-delete>>
* <<java-docs-delete-by-query>>
* <<java-docs-update>> * <<java-docs-update>>
.Multi-document APIs .Multi-document APIs

View File

@ -35,3 +35,48 @@ DeleteResponse response = client.prepareDelete("twitter", "tweet", "1")
.setOperationThreaded(false) .setOperationThreaded(false)
.get(); .get();
-------------------------------------------------- --------------------------------------------------
[[java-docs-delete-by-query]]
=== Delete By Query API
The delete by query API allows one to delete a given set of documents based on
the result of a query:
[source,java]
--------------------------------------------------
BulkIndexByScrollResponse response =
DeleteByQueryAction.INSTANCE.newRequestBuilder(client)
.filter(QueryBuilders.matchQuery("gender", "male")) <1>
.source("persons") <2>
.get(); <3>
long deleted = response.getDeleted(); <4>
--------------------------------------------------
<1> query
<2> index
<3> execute the operation
<4> number of deleted documents
As it can be a long running operation, if you wish to do it asynchronously, you can call `execute` instead of `get`
and provide a listener like:
[source,java]
--------------------------------------------------
DeleteByQueryAction.INSTANCE.newRequestBuilder(client)
.filter(QueryBuilders.matchQuery("gender", "male")) <1>
.source("persons") <2>
.execute(new ActionListener<BulkIndexByScrollResponse>() { <3>
@Override
public void onResponse(BulkIndexByScrollResponse response) {
long deleted = response.getDeleted(); <4>
}
@Override
public void onFailure(Exception e) {
// Handle the exception
}
});
--------------------------------------------------
<1> query
<2> index
<3> listener
<4> number of deleted documents