summaryrefslogtreecommitdiff
path: root/docs/java-api/delete-by-query.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/java-api/delete-by-query.asciidoc')
-rw-r--r--docs/java-api/delete-by-query.asciidoc21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/java-api/delete-by-query.asciidoc b/docs/java-api/delete-by-query.asciidoc
new file mode 100644
index 0000000..3eab109
--- /dev/null
+++ b/docs/java-api/delete-by-query.asciidoc
@@ -0,0 +1,21 @@
+[[delete-by-query]]
+== Delete By Query API
+
+The delete by query API allows to delete documents from one or more
+indices and one or more types based on a <<query-dsl-queries,query>>. Here
+is an example:
+
+[source,java]
+--------------------------------------------------
+import static org.elasticsearch.index.query.FilterBuilders.*;
+import static org.elasticsearch.index.query.QueryBuilders.*;
+
+DeleteByQueryResponse response = client.prepareDeleteByQuery("test")
+ .setQuery(termQuery("_type", "type1"))
+ .execute()
+ .actionGet();
+--------------------------------------------------
+
+For more information on the delete by query operation, check out the
+{ref}/docs-delete-by-query.html[delete_by_query API]
+docs.