exlasticsearch v0.2.0 API Reference

Modules

Protocol for converting Ecto structs to ES-compatible maps. ExlasticSearch.Repo uses this internally to effect any conversion prior to communicating with elasticsearch itself

Base macro for generating elasticsearch modules. Is intended to be used in conjunction with a Ecto model (although that is not strictly necessary)

Wrapper for a models search result. Used for response parsing

Module responsible for any statsd monitoring of elasticsearch events

Noop implementation of monitoring. To bring your own, do config :exlasticsearch, :monitoring, MonitoringModule

Elasticsearch query building functions. Basic usage for queryable Queryable is something like

API executor for elasticsearch. The generate pattern is to define a ExlasticSearch.Model on an ecto model, then call any of these functions to manage the model

Base module for ES response parsing. Works off a few macros, schema/1, field/1, has_many/2, has_one/2

Elasticsearch hits response structure

Elasticsearch record response structure. :_source can contain a parsed model result if properly specified

Elasticsearch Search response structure

Default type inference implementation. If you desire to override it, simply do

Behaviour for inferring module types. A default implementation is available in ExlasticSearch.TypeInference.Base

Implementation of type infernce for builtin ecto types

A collection of elasticsearch dsl’s to make development simple. The usage is meant to pair with existing ecto schema, like so