View Source ElasticsearchEx (Elasticsearch_ex v1.7.1)

Provides some convenient functions.

Summary

Types

document_id()
index()
opts()
query()
response()
source()

Functions

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

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

search()

Refer to ElasticsearchEx.Api.Search.search/0 documentation.

search(query_or_index_or_opts)

Refer to ElasticsearchEx.Api.Search.search/1 documentation.

search(query_or_index, index_or_opts)

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

search(query, index, opts)

Refer to ElasticsearchEx.Api.Search.search/3 documentation.

stream(query, index \\ nil, opts \\ [])

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

Types

Link to this type

document_id()

View Source 
@type document_id() :: binary()
Link to this type

index()

View Source 
@type index() :: atom() | binary()
Link to this type

opts()

View Source 
@type opts() :: keyword()
Link to this type

query()

View Source 
@type query() :: map()
Link to this type

response()

View Source 
@type response() :: {:ok, term()} | {:error, ElasticsearchEx.Error.t()}
Link to this type

source()

View Source 
@type source() :: map()

Functions

Link to this function

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

View Source (since 1.0.0) 
@spec index(source(), index(), nil | document_id(), keyword()) :: response()

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

Link to this function

search()

View Source (since 1.5.0) 
@spec search() :: response()

Refer to ElasticsearchEx.Api.Search.search/0 documentation.

Link to this function

search(query_or_index_or_opts)

View Source (since 1.5.0) 
@spec search(query() | index() | opts()) :: response()

Refer to ElasticsearchEx.Api.Search.search/1 documentation.

Link to this function

search(query_or_index, index_or_opts)

View Source (since 1.5.0) 
@spec search(query() | index(), index() | opts()) :: response()

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

Link to this function

search(query, index, opts)

View Source (since 1.0.0) 
@spec search(query(), index(), keyword()) :: response()

Refer to ElasticsearchEx.Api.Search.search/3 documentation.

Link to this function

stream(query, index \\ nil, opts \\ [])

View Source (since 1.3.0) 
@spec stream(query(), nil | index(), keyword()) :: Enumerable.t()

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