Hui v0.5.0 Hui.F.Range View Source

Struct and functions related to range faceting parameters.

Link to this section Summary

Types

t()

Use this struct to specify range faceting parameters in conjunction with the main t:Hui.F.t/0 struct

Link to this section Types

Link to this type t() View Source
t() :: %Hui.F.Range{
  per_field: boolean(),
  range: binary(),
  "range.end": binary(),
  "range.gap": binary(),
  "range.hardend": boolean(),
  "range.include": binary(),
  "range.method": binary(),
  "range.other": binary(),
  "range.start": binary()
}

Use this struct to specify range faceting parameters in conjunction with the main t:Hui.F.t/0 struct.

Example

iex> x = %Hui.F.Range{range: "year", "range.gap": "+10YEARS", "range.start": 1700, "range.end": 1799}
%Hui.F.Range{
  per_field: false,
  range: "year",
  "range.end": 1799,
  "range.gap": "+10YEARS",
  "range.hardend": nil,
  "range.include": nil,
  "range.method": nil,
  "range.other": nil,
  "range.start": 1700
}
iex> %Hui.F{range: x, field: ["type", "year"], query: "year:[2000 TO NOW]"}
%Hui.F{
  contains: nil,
  "contains.ignoreCase": nil,
  "enum.cache.minDf": nil,
  excludeTerms: nil,
  exists: nil,
  facet: true,
  field: ["type", "year"],
  interval: nil,
  limit: nil,
  matches: nil,
  method: nil,
  mincount: nil,
  missing: nil,
  offset: nil,
  "overrequest.count": nil,
  "overrequest.ratio": nil,
  pivot: [],
  "pivot.mincount": nil,
  prefix: nil,
  query: "year:[2000 TO NOW]",
  range: %Hui.F.Range{
    per_field: false,
    range: "year",
    "range.end": 1799,
    "range.gap": "+10YEARS",
    "range.hardend": nil,
    "range.include": nil,
    "range.method": nil,
    "range.other": nil,
    "range.start": 1700
  },
  sort: nil,
  threads: nil
}