Skip to content

Commit

Permalink
[DOCS] Add clear scroll API reference docs (#57367) (#57613)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Jun 3, 2020
1 parent 70bbb9c commit 1998fe5
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/reference/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ include::search/async-search.asciidoc[]

include::search/scroll-api.asciidoc[]

include::search/clear-scroll-api.asciidoc[]

include::search/search-template.asciidoc[]

include::search/search-shards.asciidoc[]
Expand Down
86 changes: 86 additions & 0 deletions docs/reference/search/clear-scroll-api.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
[[clear-scroll-api]]
=== Clear scroll API
++++
<titleabbrev>Clear scroll</titleabbrev>
++++

Clears the search context and results for a
<<request-body-search-scroll,scrolling search>>.

////
[source,console]
--------------------------------------------------
GET /_search?scroll=1m
{
"size": 1,
"query": {
"match_all": {}
}
}
--------------------------------------------------
// TEST[setup:twitter]
////

[source,console]
--------------------------------------------------
DELETE /_search/scroll
{
"scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}
--------------------------------------------------
// TEST[continued]
// TEST[s/DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==/$body._scroll_id/]

[[clear-scroll-api-request]]
==== {api-request-title}

`DELETE /_search/scroll/<scroll_id>`
deprecated:[7.0.0]

`DELETE /_search/scroll`

[[clear-scroll-api-path-params]]
==== {api-path-parms-title}

`<scroll_id>`::
deprecated:[7.0.0]
(Optional, string)
Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`.
+
IMPORTANT: Scroll IDs can be long. We recommend only specifying
scroll IDs using the <<clear-scroll-api-scroll-id-param,`scroll_id` request body
parameter>>.

[[clear-scroll-api-query-params]]
==== {api-query-parms-title}

`scroll_id`::
deprecated:[7.0.0]
(Optional, string)
Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`.
+
IMPORTANT: Scroll IDs can be long. We recommend only specifying
scroll IDs using the <<clear-scroll-api-scroll-id-param,`scroll_id` request body
parameter>>.

[role="child_attributes"]
[[clear-scroll-api-request-body]]
==== {api-request-body-title}

[[clear-scroll-api-scroll-id-param]]
`scroll_id`::
(Required, string or array of strings)
Scroll IDs to clear. To clear all scroll IDs, use `_all`.

[role="child_attributes"]
[[clear-scroll-api-response-body]]
==== {api-response-body-title}

`succeeded`::
(boolean)
If `true`, the request succeeded. This does not indicate whether any scrolling
search requests were cleared.

`num_freed`::
(integer)
Number of scrolling search requests cleared.

0 comments on commit 1998fe5

Please sign in to comment.