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.

« search searchTemplate »
Elastic Docs ›elasticsearch.js ›5.6 API

searchShards

edit

searchShards

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

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

Params

preference

String — Specify the node or shard the operation should be performed on (default: random)

routing

String — Specific routing value

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

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, String[], Boolean — A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

type

String, String[], Boolean — A comma-separated list of document types to search; leave empty to perform the operation on all types

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« search searchTemplate »