@spec clear_scroll(
  scroll_id(),
  keyword()
) :: result()

Releases one or several scroll contexts (Clear scroll API).

scroll_id is a scroll id, a list of scroll ids, or "_all".

@spec clear_scroll!(
  scroll_id(),
  keyword()
) :: body()

Like clear_scroll/2, but returns the body directly or raises the error exception.

@spec close_point_in_time(
  id(),
  keyword()
) :: result()

Closes the point in time id (Close point in time API).

@spec close_point_in_time!(
  id(),
  keyword()
) :: body()

Like close_point_in_time/2, but returns the body directly or raises the error exception.

@spec count(
  query(),
  keyword()
) :: result()

Counts the documents matching a query (Count API).

query is the count body (query DSL map); pass %{} to count everything.

Options

• :index — index target; absent for all indices.

@spec count!(
  query(),
  keyword()
) :: body()

Like count/2, but returns the body directly or raises the error exception.

@spec delete_async_search(
  id(),
  keyword()
) :: result()

Cancels the async search id and deletes its results (Delete async search API).

@spec delete_async_search!(
  id(),
  keyword()
) :: body()

Like delete_async_search/2, but returns the body directly or raises the error exception.

@spec explain(query(), index(), id(), keyword()) :: result()

Explains whether and how the document id in index matches a query (Explain API).

query is the explain body (query DSL map).

@spec explain!(query(), index(), id(), keyword()) :: body()

Like explain/4, but returns the body directly or raises the error exception.

@spec field_caps(
  map(),
  keyword()
) :: result()

Returns the capabilities of fields across indices (Field capabilities API).

body is the request body, e.g. %{fields: ["title"], index_filter: %{...}}.

Options

• :index — index target; absent for all indices.

@spec field_caps!(
  map(),
  keyword()
) :: body()

Like field_caps/2, but returns the body directly or raises the error exception.

@spec get_async_search(
  id(),
  keyword()
) :: result()

Retrieves the results of the async search id (Get async search API).

@spec get_async_search!(
  id(),
  keyword()
) :: body()

Like get_async_search/2, but returns the body directly or raises the error exception.

@spec get_async_search_status(
  id(),
  keyword()
) :: result()

Retrieves the status of the async search id, without its results (Get async search status API).

@spec get_async_search_status!(
  id(),
  keyword()
) :: body()

Like get_async_search_status/2, but returns the body directly or raises the error exception.

@spec msearch(
  [map()],
  keyword()
) :: result()

Runs several searches in one request (Multi search API).

searches is a flat list alternating header and body maps, encoded as NDJSON:

Dowser.Elasticsearch.Search.msearch([
  %{},
  %{query: %{match_all: %{}}},
  %{index: "comments"},
  %{query: %{match: %{body: "hello"}}}
])

Options

• :index — default index target for searches whose header has none.

@spec msearch!(
  [map()],
  keyword()
) :: body()

Like msearch/2, but returns the body directly or raises the error exception.

@spec msearch_template(
  [map()],
  keyword()
) :: result()

Runs several template searches in one request (Multi search template API).

searches is a flat list alternating header and template-body maps, encoded as NDJSON (see msearch/2).

Options

• :index — default index target for searches whose header has none.

@spec msearch_template!(
  [map()],
  keyword()
) :: body()

Like msearch_template/2, but returns the body directly or raises the error exception.

@spec open_point_in_time(map(), index(), String.t(), keyword()) :: result()

Opens a point in time over index for use in later searches (Open point in time API).

body is the request body (e.g. index_filter); pass %{} to send nothing. keep_alive is how long the point in time is kept alive, e.g. "1m"; it is sent as the required keep_alive query-string parameter.

@spec open_point_in_time!(map(), index(), String.t(), keyword()) :: body()

Like open_point_in_time/4, but returns the body directly or raises the error exception.

@spec rank_eval(
  [map()],
  keyword()
) :: result()

Evaluates the quality of ranked search results over a set of typical queries (Ranking evaluation API).

requests is the list of rated requests.

Options

• :index — index target; absent for all indices.
• :metric — the evaluation metric, merged into the body alongside requests.

@spec rank_eval!(
  [map()],
  keyword()
) :: body()

Like rank_eval/2, but returns the body directly or raises the error exception.

@spec render_search_template(map(), id(), keyword()) :: result()

Renders the stored search template id into an actual search body (Render search template API).

template is the request body, typically %{params: %{...}}.

@spec render_search_template!(map(), id(), keyword()) :: body()

Like render_search_template/3, but returns the body directly or raises the error exception.

@spec scroll(
  id(),
  keyword()
) :: result()

Fetches the next page of a scrolling search (Scroll API).

Sends scroll_id in the request body, the form Elasticsearch recommends.

Options

• :scroll — how long to keep the scroll context alive, e.g. "1m"; merged into the body.

@spec scroll!(
  id(),
  keyword()
) :: body()

Like scroll/2, but returns the body directly or raises the error exception.

@spec search(
  query(),
  keyword()
) :: result()

Runs a search against one, several, or all indices (Search API).

query is the search body (the Elasticsearch query DSL as a map); pass %{} to match everything. It comes first so it can be piped:

%{query: %{match: %{title: "hello"}}}
|> Dowser.Elasticsearch.Search.search(index: "posts")

Every key in the response is cast per :keys. Wherever :type_codec is configured (see Dowser.Elasticsearch.TypeCodec), each hit's _source is additionally cast against its own index mapping (dates become DateTime, IPs become :inet tuples, and so on) — automatically, at any nesting depth, so msearch/2, search_template/2, scroll/2 and the rest get the same treatment with no extra options.

Options

• :index — nil/absent for all indices, a single index string, or a list of index strings (joined with ,).

@spec search!(
  query(),
  keyword()
) :: body()

Like search/2, but returns the body directly or raises the error exception.

@spec search_mvt(
  map(),
  index(),
  String.t(),
  integer(),
  integer(),
  integer(),
  keyword()
) :: result()

Searches a vector tile for geospatial values (Vector tile search API).

body is the request body (e.g. query, fields, grid_agg); pass %{} to send nothing. Returns the binary Mapbox vector tile, so the response format defaults to :raw (override with :resp_format/:format).

@spec search_mvt!(
  map(),
  index(),
  String.t(),
  integer(),
  integer(),
  integer(),
  keyword()
) :: body()

Like search_mvt/7, but returns the body directly or raises the error exception.

@spec search_shards(keyword()) :: result()

Returns the indices and shards a search would run against (Search shards API).

Options

• :index — index target; absent for all indices.

@spec search_shards!(keyword()) :: body()

Like search_shards/1, but returns the body directly or raises the error exception.

@spec search_template(
  map(),
  keyword()
) :: result()

Runs a search with a stored or inline search template (Search template API).

template is the request body, e.g. %{id: "my-template", params: %{...}} or %{source: %{...}, params: %{...}}.

Options

• :index — index target; absent for all indices.

@spec search_template!(
  map(),
  keyword()
) :: body()

Like search_template/2, but returns the body directly or raises the error exception.

@spec submit_async_search(
  query(),
  keyword()
) :: result()

Submits a search that runs asynchronously (Submit async search API).

query is the search body, exactly as in search/2.

Options

• :index — index target; absent for all indices.

@spec submit_async_search!(
  query(),
  keyword()
) :: body()

Like submit_async_search/2, but returns the body directly or raises the error exception.

@spec terms_enum(map(), index(), keyword()) :: result()

Enumerates the terms of a field that match a partial string (Terms enum API).

body is the request body and must include field, e.g. %{field: "title", string: "he"}.

@spec terms_enum!(map(), index(), keyword()) :: body()

Like terms_enum/3, but returns the body directly or raises the error exception.