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

[DOCS] Async search: clarify behaviour when submit returns final results (#55934) 

Closes #55636
This commit is contained in:
Luca Cavanna 2020-05-06 10:00:30 +02:00
parent bd7a2d2b01
commit ef66018119
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/search/async-search.asciidoc
View File

@ -98,7 +98,11 @@ some shards returned their results, or when the node that is coordinating the
It is possible to block and wait until the search is completed up to a certain
timeout by providing the `wait_for_completion_timeout` parameter, which
defaults to `1` second.
defaults to `1` second. When the async search completes within such timeout,
the response won't include the ID as the results are not stored in the cluster.
The `keep_on_completion` parameter, which defaults to `false`, can be set to
`true` to request that results are stored for later retrieval also when the
search completes within the `wait_for_completion_timeout`.
You can also specify how long the async search needs to be
available through the `keep_alive` parameter, which defaults to `5d` (five days).