From 6507a20772042e5dbe499ef0c975f9bb3417767b Mon Sep 17 00:00:00 2001 From: Saren Currie Date: Thu, 26 Apr 2018 20:45:48 +1200 Subject: [PATCH] Clarify documentation of scroll_id (#29424) * Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour --- docs/reference/search/request/scroll.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/search/request/scroll.asciidoc b/docs/reference/search/request/scroll.asciidoc index b1166eae9f9e6..a414aba6a8a90 100644 --- a/docs/reference/search/request/scroll.asciidoc +++ b/docs/reference/search/request/scroll.asciidoc @@ -78,9 +78,9 @@ returned with each batch of results. Each call to the `scroll` API returns the next batch of results until there are no more results left to return, ie the `hits` array is empty. -IMPORTANT: The initial search request and each subsequent scroll request -returns a new `_scroll_id` -- only the most recent `_scroll_id` should be -used. +IMPORTANT: The initial search request and each subsequent scroll request each +return a `_scroll_id`, which may change with each request -- only the most +recent `_scroll_id` should be used. NOTE: If the request specifies aggregations, only the initial search response will contain the aggregations results.