View Source Hui.Query.Common (Hui v0.11.0)

Struct for common and SolrCloud query parameters.

See:

Link to this section Summary

Types

t()

Struct for the common and SolrCloud query parameters.

Link to this section Types

@type debug_query_options() :: :query | :timing | :results | :all
@type t() :: %Hui.Query.Common{
  _route_: binary(),
  cache: boolean(),
  collection: binary(),
  cursorMark: binary(),
  debug: debug_query_options() | [debug_query_options()],
  "debug.explain.structured": boolean(),
  debugQuery: boolean(),
  defType: binary(),
  distrib: boolean(),
  "distrib.singlePass": boolean(),
  echoParams: :explicit | :all | :none,
  explainOther: binary(),
  fl: binary(),
  fq: binary() | [binary()],
  "json.nl": binary(),
  "json.wrf": binary(),
  logParamsList: binary(),
  omitHeader: boolean(),
  rows: integer(),
  segmentTerminateEarly: boolean(),
  shards: binary(),
  "shards.info": boolean(),
  "shards.preference": binary(),
  "shards.tolerant": boolean(),
  sort: binary(),
  start: number(),
  timeAllowed: number(),
  tr: binary(),
  wt: binary()
}

Struct for the common and SolrCloud query parameters.

Link to this section Functions

@spec new() :: t()
Link to this function

new(rows, start \\ nil, fq \\ nil, sort \\ nil)

View Source
@spec new(integer(), integer(), binary() | [binary()], binary()) :: t()