Packages

exlasticsearch

2.2.0
2.3.0 2.2.3 2.2.2 2.2.1 2.2.0 2.1.0 2.0.0 1.11.0 1.10.1 1.10.0 1.9.0 1.8.0 1.7.0 1.6.5 1.6.4 1.6.3 1.6.2 1.6.1 1.6.0 1.5.4 1.5.3 1.5.2 1.5.1 1.5.0 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.3 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0 0.2.2 0.2.1 0.2.0 0.1.0

Ecto-friendly Elasticsearch DSL

HexDocs

Current section

Files

Jump to
Readme
39 Versions
6 Dependencies
Dependants
Files
Activity
exlasticsearch lib exlasticsearch indexable.ex
Raw

lib/exlasticsearch/indexable.ex 

defprotocol ExlasticSearch.Indexable do

  @moduledoc """

  Protocol for converting Ecto structs to ES-compatible maps.  `ExlasticSearch.Repo` uses

  this internally to effect any conversion prior to communicating with elasticsearch itself

  """



  @doc "ES record id"

  @spec id(struct) :: binary

  def id(_)



  @doc "Properties map to be inserted into ES"

  @spec document(struct, atom) :: map

  def document(_, _)



  @doc "Properties map to be inserted into ES"

  @spec document(struct) :: map

  def document(_)



  @doc "Any preloads needed to call `document/2`"

  @spec preload(struct, atom) :: struct

  def preload(_, _)



  @doc "Any preloads needed to call `document/2`"

  @spec preload(struct) :: struct

  def preload(_)

end