View Source ElasticsearchEx.Streamer (Elasticsearch_ex v1.7.1)

Provides an utility to generate an Elixir Stream from an Elasticsearch search.

Summary

Types

index()
opts()
query()

Functions

stream(query)
stream(query, index_or_opts)
stream(query, index, opts)

Runs an Elasticsearch by returning a Stream which is perfect for browsing large volume of data.

Types

Link to this type

index()

View Source 
@type index() :: ElasticsearchEx.index()
Link to this type

opts()

View Source 
@type opts() :: ElasticsearchEx.opts()
Link to this type

query()

View Source 
@type query() :: ElasticsearchEx.query()

Functions

Link to this function

stream(query)

View Source (since 1.5.0) 
@spec stream(query()) :: Enumerable.t()
Link to this function

stream(query, index_or_opts)

View Source (since 1.5.0) 
@spec stream(query(), index()) :: Enumerable.t()
@spec stream(query(), opts()) :: Enumerable.t()
Link to this function

stream(query, index, opts)

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

Runs an Elasticsearch by returning a Stream which is perfect for browsing large volume of data.

Examples 

iex> ElasticsearchEx.Stream.stream(
...>   %{query: %{match_all: %{}}, sort: [%{message: :desc}], size: 500},
...>   :my_index,
...>   keep_alive: "30s"
...> )
#Function<52.124013645/2 in Stream.resource/3>