Hui v0.5.4 Hui.Q View Source

Struct and functions related to query parsers and common request parameters.

Correspond to the default standard query parser known as the lucene parser, the Maximum Disjunction (DisMax) parser, as well as common parameters such as rows, sort, start etc.

See below for more details:

Link to this section Summary

Types

t()

Struct for the standard, DisMax query parsers and common request parameters

Link to this section Types

t()

t() :: %Hui.Q{
  bf: binary(),
  bq: binary(),
  cache: boolean(),
  debug: binary(),
  debugQuery: boolean(),
  defType: binary(),
  df: binary(),
  echoParams: binary(),
  explainOther: binary(),
  fl: binary(),
  fq: binary() | [binary()],
  "json.nl": binary(),
  "json.wrf": binary(),
  logParamsList: term(),
  mm: binary(),
  omitHeader: boolean(),
  pf: binary(),
  ps: integer(),
  q: binary(),
  "q.alt": binary(),
  "q.op": binary(),
  qf: binary(),
  qs: integer(),
  rows: integer(),
  segmentTerminateEarly: boolean(),
  sort: binary(),
  sow: boolean(),
  start: number(),
  tie: float(),
  timeAllowed: number(),
  tr: binary(),
  wt: binary()
}

Struct for the standard, DisMax query parsers and common request parameters.

Hui.URL.encode_query/1 renders this struct into URL query string.