@@ -19,11 +19,6 @@ POST /twitter/_delete_by_query
19
19
--------------------------------------------------
20
20
// TEST[setup:big_twitter]
21
21
22
- [[docs-delete-by-query-api-request]]
23
- ==== {api-request-title}
24
-
25
- `POST /<index>/_delete_by_query`
26
-
27
22
////
28
23
29
24
[source,console-result]
@@ -49,6 +44,11 @@ POST /twitter/_delete_by_query
49
44
// TESTRESPONSE[s/"took" : 147/"took" : "$body.took"/]
50
45
////
51
46
47
+ [[docs-delete-by-query-api-request]]
48
+ ==== {api-request-title}
49
+
50
+ `POST /<index>/_delete_by_query`
51
+
52
52
[[docs-delete-by-query-api-desc]]
53
53
==== {api-description-title}
54
54
@@ -89,8 +89,7 @@ request to be refreshed. Unlike the delete API, it does not support
89
89
90
90
If the request contains `wait_for_completion=false`, {es}
91
91
performs some preflight checks, launches the request, and returns a
92
- <<docs-delete-by-query-task-api,`task`>>
93
- you can use to cancel or get the status of the task. {es} creates a
92
+ <<tasks,`task`>> you can use to cancel or get the status of the task. {es} creates a
94
93
record of this task as a document at `.tasks/task/${taskId}`. When you are
95
94
done with a task, you should delete the task document so {es} can reclaim the
96
95
space.
@@ -227,9 +226,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout]
227
226
228
227
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=version]
229
228
230
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout]
231
-
232
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
229
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
233
230
234
231
[[docs-delete-by-query-api-request-body]]
235
232
==== {api-request-body-title}
@@ -239,7 +236,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards
239
236
using the <<query-dsl,Query DSL>>.
240
237
241
238
242
- [[docs-delete-by-quer -api-response-body]]
239
+ [[docs-delete-by-query -api-response-body]]
243
240
==== Response body
244
241
245
242
//////////////////////////
@@ -330,7 +327,7 @@ The number of requests per second effectively executed during the delete by quer
330
327
`throttled_until_millis`::
331
328
332
329
This field should always be equal to zero in a `_delete_by_query` response. It only
333
- has meaning when using the <<docs-delete-by-query-task-api , Task API>>, where it
330
+ has meaning when using the <<tasks , Task API>>, where it
334
331
indicates the next time (in milliseconds since epoch) a throttled request will be
335
332
executed again in order to conform to `requests_per_second`.
336
333
@@ -541,7 +538,7 @@ Adding `slices` to `_delete_by_query` just automates the manual process used in
541
538
the section above, creating sub-requests which means it has some quirks:
542
539
543
540
* You can see these requests in the
544
- <<docs-delete-by-query-task-api ,Tasks APIs>>. These sub-requests are "child"
541
+ <<tasks ,Tasks APIs>>. These sub-requests are "child"
545
542
tasks of the task for the request with `slices`.
546
543
* Fetching the status of the task for the request with `slices` only contains
547
544
the status of completed slices.
@@ -655,7 +652,7 @@ you to delete that document.
655
652
656
653
[float]
657
654
[[docs-delete-by-query-cancel-task-api]]
658
- ==== Cancel a delete by query operation
655
+ ===== Cancel a delete by query operation
659
656
660
657
Any delete by query can be canceled using the <<tasks,task cancel API>>:
661
658
0 commit comments