Hui v0.5.7 Hui.F View Source
Struct and functions related to faceting.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t() :: %Hui.F{ contains: binary(), "contains.ignoreCase": binary(), "enum.cache.minDf": number(), excludeTerms: binary(), exists: boolean(), facet: boolean(), field: binary() | [binary()], interval: Hui.F.Interval.t() | [Hui.F.Range.t()], limit: number(), matches: binary(), method: binary(), mincount: number(), missing: boolean(), offset: number(), "overrequest.count": number(), "overrequest.ratio": number(), pivot: binary() | [binary()], "pivot.mincount": number(), prefix: binary(), query: binary() | [binary()], range: Hui.F.Range.t() | [Hui.F.Range.t()], sort: binary(), threads: binary() }
Struct for faceting.
Hui.URL.encode_query/1
renders this struct into URL query string.
Example
iex> %Hui.F{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: nil,
sort: nil,
threads: nil
}