Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 4 commits into from
May 6, 2020
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e8ec34
[DOCS] Async search: clarify behaviour when submit returns final results
javanna Apr 29, 2020
33c4227
reword
javanna Apr 29, 2020
3d2eaf1
Merge branch 'master' into docs/async_search_sync_id
javanna May 6, 2020
a245161
iter
javanna May 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/reference/search/async-search.asciidoc
View file
Open in desktop
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: s/the ID/the id/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is how @jrodewig prefers us to mention the id, I will defer to him :)

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