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.

« search searchTemplate »

› ›

searchShards

edit

searchShards

edit

client.searchShards({
  index: string | string[],
  type: string | string[],
  preference: string,
  routing: string,
  local: boolean,
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all'
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`	`string \| string[]` - A comma-separated list of document types to search; leave empty to perform the operation on all types
`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)
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allow_no_indices` or `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)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`

« search searchTemplate »