feat: added sample script for multisearch #657
Conversation
Signed-off-by: tejeshreddy <[email protected]>
tejeshreddy
requested review from
ananzh,
kavilla,
dblock,
VachaShah,
nhtruong,
harshavamsi and
timursaurus
as code owners
tejeshreddy
changed the title
tejeshreddy
changed the title
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: Tejesh Reddy <[email protected]>
guides/msearch.md
Outdated
| @@ -0,0 +1,63 @@ | |||
| # Multi-Search (msearch) | |||
|
|
|||
| OpenSearch's Multi-Search (`msearch`) API is a tool that allows you to execute multiple search operations for documents within an index efficiently. This API supports various parameters that provide flexibility in customizing your search operations. It's crucial to understand the key differences between `msearch` and a regular `search` operation in OpenSearch. Unlike a single search operation, `msearch` enables you to perform multiple searches in a single API call, significantly reducing network overhead as it need not initialize a new network connection for each search. This proves particularly advantageous for batch operations or scenarios where searches span multiple indices. By combining searches into one request, `msearch` streamlines the process and enhances overall efficiency. Explore the functionalities of the msearch API with the provided sample code in [../samples/msearch.js](../samples/msearch.js). | |||
There was a problem hiding this comment.
"is a tool that allows you to" -> "allows you to", it's an API, not a tool :)
I'd be curious to hear what the downsides of msearch are. For example, does msearch require the caller to examine errors themselves?
There was a problem hiding this comment.
I'd be curious to hear what the downsides of msearch are. For example, does msearch require the caller to examine errors themselves?
@dblock did you mean to say this could be one of the disadvantages? I will include a couple of cons related to msearch in comparison to search
There was a problem hiding this comment.
I have added a con I came across when reading about the difference in both.
does msearch require the caller to examine errors themselves?
For the above point, I wasn't able to find anything substantial. It would be great if you could link doc/resources so I can add it to the guide.
guides/msearch.md
Outdated
| ); | ||
| ``` |
There was a problem hiding this comment.
It's not clear to me what happens in case of errors? Does the user have to handle that, and if so how? I think the sample should explicitly call it out.
There was a problem hiding this comment.
I have added a try-catch block in the code snippet. Please let me know if there is anything else you're referring to here.
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Signed-off-by: tejeshreddy <[email protected]>
Description
msearchundersamples/msearch.jsmsearchunderguides/msearch.mdIssues Resolved
#634
Check List
yarn run lintdoesn't show any errorsBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.