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

Add cancellation doc for multi search (#61418) 

Relates #61337
This commit is contained in:
Nhat Nguyen 2020-08-21 10:10:05 -04:00
parent d47bbbafe0
commit f34d3efae7
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/search/multi-search.asciidoc
View File

@ -399,3 +399,13 @@ GET _msearch/template
To ensure fast responses, the multi search API will respond with partial results
if one or more shards fail. See <<shard-failures, Shard failures>> for more
information.
[[msearch-cancellation]]
=== Search Cancellation
Multi searches can be cancelled using standard <<task-cancellation,task cancellation>>
mechanism and are also automatically cancelled when the http connection used to
perform the request is closed by the client. It is fundamental that the http
client sending requests closes connections whenever requests time out or are
aborted. Cancelling an msearch request will also cancel all of the corresponding
sub search requests.