-
Notifications
You must be signed in to change notification settings - Fork 24.4k
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.
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
[DOCS] add docs for async search #53675
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
5a7adf0
[DOCS] add docs for async search
javanna b2fe1a4
Apply suggestions from code review
javanna 414c444
remove pre_filter_shard_size from async search spec
javanna b74707d
small corrections
javanna bbebf3c
small corrections
javanna 4635ba2
Merge branch 'master' into docs/async_search
javanna 08639b9
small corrections
javanna 134b02f
note on security
javanna c57c16c
Merge branch 'master' into docs/async_search
javanna d7c0073
iter
javanna d804de0
iter
javanna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
[role="xpack"] | ||
[testenv="basic"] | ||
[[async-search-intro]] | ||
== Long-running searches | ||
|
||
{es} generally allows you to quickly search across big amounts of data. There are | ||
situations where a search executes on many many shards, possibly against | ||
<<frozen-indices,frozen indices>> and spanning multiple | ||
<<modules-remote-clusters,remote clusters>>, for which | ||
results are not expected to be returned in milliseconds. When you need to | ||
execute long-running searches, synchronously | ||
waiting for its results to be returned is not ideal. Instead, Async search lets | ||
you submit a search request that gets executed _asynchronously_, | ||
monitor the progress of the request, and retrieve results at a later stage. | ||
You can also retrieve partial results as they become available but | ||
before the search has completed. | ||
|
||
You can submit an async search request using the <<submit-async-search,submit | ||
async search>> API. The <<get-async-search,get async search>> API allows you to | ||
monitor the progress of an async search request and retrieve its results. An | ||
ongoing async search can be deleted through the <<delete-async-search,delete | ||
async search>> API. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was hoping this would work but it does cause problems. I need to see if this escaping is needed, to my mind it isn't but I may be wrong. In that case I need to only escape unless curly brackets are part of an expression like ${expression}, which I don't look forward to.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
turns out this is easy to address, there were only a couple of tests where we were using unescaped
|
which we can manually escape instead.