WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

msearch

edit

msearch

edit

client.msearch({
  index: string | string[],
  type: string | string[],
  search_type: 'query_then_fetch' | 'query_and_fetch' | 'dfs_query_then_fetch' | 'dfs_query_and_fetch',
  max_concurrent_searches: number,
  typed_keys: boolean,
  pre_filter_shard_size: number,
  body: object
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names to use as default
`type`	`string \| string[]` - A comma-separated list of document types to use as default
`search_type` or `searchType`	`'query_then_fetch' \| 'query_and_fetch' \| 'dfs_query_then_fetch' \| 'dfs_query_and_fetch'` - Search operation type
`max_concurrent_searches` or `maxConcurrentSearches`	`number` - Controls the maximum number of concurrent searches the multi search api will execute
`typed_keys` or `typedKeys`	`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
`pre_filter_shard_size` or `preFilterShardSize`	`number` - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it’s rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. Default: `128`
`body`	`object` - The request definitions (metadata-search request definition pairs), separated by newlines

« mpercolate msearchTemplate »