Hui v0.5.3 Hui.Q View Source

Struct and functions related to standard and common request parameters.

These correspond to the default query parser known as the lucene parser for structured queries, as well as the common parameters such as as sorting and pagination parameters (rows, sort, start etc).

See below for more details:

Example

iex> %Hui.Q{q: "edinburgh", fl: "id,title", fq: ["type:image"], rows: 15}
%Hui.Q{
  cache: nil,
  debug: nil,
  debugQuery: nil,
  defType: nil,
  df: nil,
  echoParams: nil,
  explainOther: nil,
  fl: "id,title",
  fq: ["type:image"],
  "json.nl": nil,
  "json.wrf": nil,
  logParamsList: nil,
  omitHeader: nil,
  q: "edinburgh",
  "q.op": nil,
  rows: 15,
  segmentTerminateEarly: nil,
  sort: nil,
  sow: nil,
  start: nil,
  timeAllowed: nil,
  tr: nil,
  wt: nil
}

Link to this section Summary

Types

t()

Struct for standard and common request parameters

Link to this section Types

Link to this type t() View Source
t() :: %Hui.Q{
  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(),
  omitHeader: boolean(),
  q: binary(),
  "q.op": binary(),
  rows: integer(),
  segmentTerminateEarly: boolean(),
  sort: binary(),
  sow: boolean(),
  start: number(),
  timeAllowed: number(),
  tr: binary(),
  wt: binary()
}

Struct for standard and common request parameters.

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