searchedit

client.search([params, [callback]])

Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either simple query strings in the q parameter, or by specifying a full request definition using the Elasticsearch Query DSL in the body parameter.

bodybuilder and elastic-builder can be used to make building query bodies easier.

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

Search with a simple query string query.

const response = await client.search({
  index: 'myindex',
  q: 'title:test'
});

Passing a full request definition in the Elasticsearch’s Query DSL as a Hash.

const response = await client.search({
  index: 'myindex',
  body: {
    query: {
      match: {
        title: 'test'
      }
    },
    facets: {
      tags: {
        terms: {
          field: 'tags'
        }
      }
    }
  }
});

Params

analyzer

String — The analyzer to use for the query string

analyzeWildcard

Boolean — Specify whether wildcard and prefix queries should be analyzed (default: false)

[ccsMinimizeRoundtrips=true]

Boolean — Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

[defaultOperator=OR]

String — The default operator for query string query (AND or OR)

Options
  • "AND"
  • "OR"

df

String — The field to use as default where no field prefix is given in the query string

explain

Boolean — Specify whether to return detailed information about score computation as part of a hit

storedFields

String, String[], Boolean — A comma-separated list of stored fields to return as part of a hit

docvalueFields

String, String[], Boolean — A comma-separated list of fields to return as the docvalue representation of a field for each hit

from

Number — Starting offset (default: 0)

ignoreUnavailable

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

ignoreThrottled

Boolean — Whether specified concrete, expanded or aliased indices should be ignored when throttled

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"

lenient

Boolean — Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

preference

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

q

String — Query in the Lucene query string syntax

routing

String, String[], Boolean — A comma-separated list of specific routing values

scroll

DurationString — Specify how long a consistent view of the index should be maintained for scrolled search

searchType

String — Search operation type

Options
  • "query_then_fetch"
  • "dfs_query_then_fetch"

size

Number — Number of hits to return (default: 10)

sort

String, String[], Boolean — A comma-separated list of <field>:<direction> pairs

_source

String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return

_sourceExcludes

String, String[], Boolean — A list of fields to exclude from the returned _source field

_sourceIncludes

String, String[], Boolean — A list of fields to extract and return from the _source field

terminateAfter

Number — The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

stats

String, String[], Boolean — Specific tag of the request for logging and statistical purposes

suggestField

String — Specify which field to use for suggestions

[suggestMode=missing]

String — Specify suggest mode

Options
  • "missing"
  • "popular"
  • "always"

suggestSize

Number — How many suggestions to return in response

suggestText

String — The source text for which the suggestions should be returned

timeout

DurationString — Explicit operation timeout

trackScores

Boolean — Whether to calculate and return scores even if they are not used for sorting

trackTotalHits

Boolean — Indicate if the number of documents that match the query should be tracked

[allowPartialSearchResults=true]

Boolean — Indicate if an error should be returned if there is a partial search failure or timeout

typedKeys

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

version

Boolean — Specify whether to return document version as part of a hit

seqNoPrimaryTerm

Boolean — Specify whether to return sequence number and primary term of the last modification of each hit

requestCache

Boolean — Specify if request cache should be used for this request or not, defaults to index level setting

[batchedReduceSize=512]

Number — The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.

[maxConcurrentShardRequests=5]

Number — The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

[preFilterShardSize=128]

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.

restTotalHitsAsInt

Boolean — Indicates whether hits.total should be rendered as an integer or an object in the rest search response

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