Browse Source

Add cancellation doc for multi search (#61418)

Relates #61337
Nhat Nguyen 5 years ago
parent
commit
35ccd06918
1 changed files with 10 additions and 0 deletions
  1. 10 0
      docs/reference/search/multi-search.asciidoc

+ 10 - 0
docs/reference/search/multi-search.asciidoc

@@ -399,3 +399,13 @@ GET _msearch/template
 To ensure fast responses, the multi search API will respond with partial results
 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
 if one or more shards fail. See <<shard-failures, Shard failures>> for more
 information.
 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.