Skip to content

Commit

Permalink
[DOCS] Async search: clarify behaviour when submit returns final resu…
Browse files Browse the repository at this point in the history
…lts (#55934)

Closes #55636
  • Loading branch information
javanna committed May 6, 2020
1 parent bd7a2d2 commit ef66018
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/search/async-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit ef66018

Please sign in to comment.