API Reference Dowser.Elasticsearch v#0.1.0

View Source

Modules

Elasticsearch client, built on Dowser.Client.

The built-in field codec: dispatches a value to the Dowser.Client.Field module matching its mapping entry, built with Dowser.Client.CodecBuilder.

The Elasticsearch document APIs — every endpoint tagged document in the Elasticsearch OpenAPI specification (single-document CRUD, bulk, multi-get, by-query operations, reindex, term vectors).

An error response returned by Elasticsearch — a non-2xx HTTP status.

binary — a Base64 string <-> a raw binary.

date — ISO-8601 strings or epoch millis <-> DateTime.

date_range — the %{"gte" => _, "lte" => _} object form <-> a Date.Range.

geo_point — the %{"lat" => _, "lon" => _} object form <-> a {lat, lon} tuple.

ip — a string <-> an :inet address tuple ({1, 2, 3, 4}).

integer_range — the %{"gte" => _, "lte" => _} object form <-> an Elixir Range.

Shared plumbing for the API modules: result parsing, path building and option handling.

The Elasticsearch indices APIs — every endpoint tagged indices in the Elasticsearch OpenAPI specification (index management, mappings, settings, aliases, templates, dangling indices, …) — plus segment/1, the index-target helper used by all API modules.

Per-node cache of Elasticsearch index mappings.

The repository pattern: binds the index-related API functions to a fixed or computed index.

The Elasticsearch search APIs — every endpoint tagged search in the Elasticsearch OpenAPI specification.

Whole-body type casting for Elasticsearch documents and search results — a Dowser.Client.Codec implementation, set as :codec_adapter (see Dowser.Client) to cast values (dates, IPs, ...) per field, based on each document's own index mapping