IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« msearch mtermvectors »
Elastic Docs ›elasticsearch.js ›6.8 API

msearchTemplate

edit

msearchTemplate

edit
client.msearchTemplate([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

searchType

String — Search operation type

Options
  • "query_then_fetch"
  • "query_and_fetch"
  • "dfs_query_then_fetch"
  • "dfs_query_and_fetch"

typedKeys

Boolean — Specify whether aggregation and suggester names should be prefixed by their respective types in the response

maxConcurrentSearches

Number — Controls the maximum number of concurrent searches the multi search api will execute

restTotalHitsAsInt

Boolean — This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number

index

String, String[], Boolean — A comma-separated list of index names to use as default

type

String, String[], Boolean — A comma-separated list of document types to use as default

body

Object[], JSONLines — The request body, as either an array of objects or new-line delimited JSON objects. See the elasticsearch docs for details about what can be specified here.

back to top

« msearch mtermvectors »