Packages

elasticsearch_ex

1.0.0
1.9.2 1.9.1 1.9.0 1.8.5 1.8.4 1.8.3 1.8.2 1.8.1 1.7.2 1.7.1 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.6.2 0.6.1 0.6.0 0.5.0 0.4.0 0.3.1 0.3.0 0.2.0 0.1.0

elasticsearch_ex is a client library for Elasticsearch

HexDocs

Current section

Files

Jump to
Readme
27 Versions
2 Dependencies
Dependants
Files
Activity
elasticsearch_ex lib elasticsearch_ex.ex
Raw

lib/elasticsearch_ex.ex 

defmodule ElasticsearchEx do

  @moduledoc """

  Provides some convenient functions.

  """



  ## Module attributes



  @type query :: map()



  @type source :: map()



  @type document_id :: binary()



  @type index :: atom() | binary()



  @type opts :: keyword()



  @type response :: {:ok, term()} | {:error, ElasticsearchEx.Error.t()}



  ## Public functions



  @doc """

  Refer to `ElasticsearchEx.Api.Search.search/2` documentation.

  """

  @spec search(query(), index(), keyword()) :: response()

  defdelegate search(query, index \\ nil, opts \\ []), to: ElasticsearchEx.Api.Search



  @doc """

  Refer to `ElasticsearchEx.Api.Document.index/4` documentation.

  """

  @spec index(source(), index(), nil | document_id(), keyword()) :: response()

  defdelegate index(source, index, document_id \\ nil, opts \\ []),

    to: ElasticsearchEx.Api.Document

end