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.

« mget msearch »
Elastic Docs ›elasticsearch.js ›5.6 API

mpercolate

edit

mpercolate

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

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

Params

ignoreUnavailable

Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)

allowNoIndices

Boolean — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

[expandWildcards=open]

String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

Options
  • "open"
  • "closed"
  • "none"
  • "all"

index

String — The index of the document being count percolated to use as default

type

String — The type of the document being percolated 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

« mget msearch »