honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12997 from jpountz/fix/doc_scroll_close 

Fix documentation: scrolls are not closed automatically.
This commit is contained in:
Adrien Grand 2015-08-20 09:24:02 +02:00
parent a0243200e0 551e92ec71
commit 7662705f37
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/search/request/scroll.asciidoc
View File

@ -176,9 +176,11 @@ curl -XGET localhost:9200/_nodes/stats/indices/search?pretty
==== Clear scroll API
Search contexts are removed automatically either when all results have been
retrieved or when the `scroll` timeout has been exceeded. However, you can
clear a search context manually with the `clear-scroll` API:
Search context are automatically removed when the `scroll` timeout has been
exceeded. However keeping scrolls open has a cost, as discussed in the
<<scroll-search-context,previous section>> so scrolls should be explicitly
cleared as soon as the scroll is not being used anymore using the
`clear-scroll` API:
[source,js]
---------------------------------------