exlasticsearch v1.10.1 ExlasticSearch.Query View Source

Elasticsearch query building functions. Basic usage for queryable Queryable is something like:

Queryable.search_query()
|> must(math(field, value))
|> should(match_phrash(field, value, opts))
|> filter(term(filter_field, value))
|> realize()

An ES query has 3 main clauses, must, should and filter. Must and should are near equivalents except that must clauses will reject records that fail to match. Filters require matches but do not contribute to scoring, while must/should both do. Nesting queries within queries is also supported

Currently the module only supports the boolean style of compound query, but we could add support for the others as need be.

See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html for documentation on specific query types.

Link to this section Summary

Types

t()

Functions

field_value_factor(q, fvf, opts \\ [])

filter(query, filter)

Appends a new filter scope to the running query

function_score(q, functions, opts \\ [])

ids(ids)

ids query clause

match(field, query)

Builds a match query clause

match(field, query, opts)

match_phrase(field, query, opts \\ [])

Builds a match phrase query clause

multi_match(fields, query, opts \\ [])

Multimatch query clause

must(query, must)

Appends a new must scope to the runnning query

must_not(query, must_not)

Appends a new must_not scope to the running query

nested(q, path)

options(query, opts)

Add options to the current bool compound query (for instance the minimum number of accepted matches)

query_string(query, opts \\ [])

Query string query type, that applies ES standard query rewriting

range(field, range)

range query clause

realize(query)

Converts a Query struct into an ES compliant bool or function score compound query

script_score(q, script, opts \\ [])

Converts a query to a function score query and adds the given script for scoring

should(query, should)

Appends a new should scope to the running query

sort(query, field, direction \\ "asc")

Adds a sort clause to the ES query

term(field, term)

Term query clause

terms(field, terms)

terms query clause

Link to this section Types

t()

t() :: %ExlasticSearch.Query{
  filter: term(),
  index_type: term(),
  must: term(),
  must_not: term(),
  options: term(),
  queryable: term(),
  should: term(),
  sort: term(),
  type: term()
}

Link to this section Functions