elasticsearch/docs/java-api/docs/delete-by-query.asciidoc

[[java-docs-delete-by-query]]
=== Delete By Query API

The delete by query API allows one to delete documents from one or more
indices and one or more types based on a <<java-query-dsl,query>>.

It's available as a plugin so you need to explicitly declare it in your project:

[source,xml]
--------------------------------------------------
<dependency>
    <groupId>org.elasticsearch.plugin</groupId>
    <artifactId>elasticsearch-delete-by-query</artifactId>
    <version>${es.version}</version>
</dependency>
--------------------------------------------------

To use it from Java, you can do the following:

[source,java]
--------------------------------------------------
import static org.elasticsearch.index.query.QueryBuilders.*;

DeleteByQueryResponse response = client
    .prepareDeleteByQuery("test")          <1>
    .setQuery(termQuery("_type", "type1")) <2>
    .get();
--------------------------------------------------
<1> index name
<2> query

For more information on the delete by query operation, check out the
{ref}/docs-delete-by-query.html[delete_by_query API]
docs.