Hui v0.9.0 Hui.Q View Source

This module is deprecated. Please use `Hui.Query.Standard` and `Hui.Query.Common` instead. .

Link to this section Summary

Types

t()

Struct for the standard query and common request parameters

Link to this section Types

t() :: %Hui.Q{
  cache: boolean(),
  collection: binary(),
  cursorMark: binary(),
  debug: binary(),
  debugQuery: boolean(),
  defType: binary(),
  df: binary(),
  distrib: boolean(),
  echoParams: binary(),
  explainOther: binary(),
  fl: binary(),
  fq: binary() | [binary()],
  "json.nl": binary(),
  "json.wrf": binary(),
  logParamsList: binary(),
  omitHeader: boolean(),
  q: binary(),
  "q.op": binary(),
  rows: integer(),
  segmentTerminateEarly: boolean(),
  shards: binary(),
  "shards.info": boolean(),
  "shards.preference": binary(),
  "shards.tolerant": boolean(),
  sort: binary(),
  sow: boolean(),
  start: number(),
  timeAllowed: number(),
  tr: binary(),
  wt: binary()
}

Struct for the standard query and common request parameters.