github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity

Remove delete-by-query core docs

Browse source 
We moved delete-by-query from core to a plugin, but forgot to remove the core docs.

Closes #12585
This commit is contained in:
Michael McCandless 2015-08-01 05:14:46 -04:00 • committed by mikemccand
parent bd249448c3
commit ac2e0fd6a0
9 changed files with 5 additions and 202 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/java-api/docs.asciidoc
View file

@ -12,7 +12,6 @@ This section describes the following CRUD APIs:
.Multi-document APIs
* <<java-docs-multi-get>>
* <<java-docs-bulk>>
* <<java-docs-delete-by-query>>
NOTE: All CRUD APIs are single-index APIs. The `index` parameter accepts a single
index name, or an `alias` which points to a single index.
@ -28,5 +27,3 @@ include::docs/update.asciidoc[]
include::docs/multi-get.asciidoc[]
include::docs/bulk.asciidoc[]
include::docs/delete-by-query.asciidoc[]

34
docs/java-api/docs/delete-by-query.asciidoc
View file

@ -1,34 +0,0 @@
[[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.