exlasticsearch

v1.2.0

exlasticsearch v1.2.0 ExlasticSearch.Repo View Source

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.

To configure the url the repo points to, do:

config :exlasticsearch, ExlasticSearch.Repo,
  url: "https://elasticsearch.url.io:9200"

Link to this section Summary

Types

response()

Functions

bulk(operations, opts \\ [])

Generates an Elasticsearch bulk request. operations should be of the form

close_index(model)

Close an index for model

create_index(model)

Creates an index as defined in model

create_mapping(model)

Updates an index’s mappings to the current definition in model

delete(struct)

Removes struct from the index of its model

delete_index(model)

Removes the index defined in model

exists?(model)

Checks if the index for model exists

get(struct)

Gets an ES document by _id

index(struct)

Adds a struct into it’s associated index. The struct will be passed through the ExlasticSearch.Indexable protocol prior to insertion

index_stream(stream, parallelism \\ 10, demand \\ 10)
open_index(model)

open an index for model

paginate(pageable, options \\ [])
refresh(model)

Refreshes model’s index

search(query, params)

Creates a call to search/3 by realizing query (using Exlasticsearch.Query.realize/1) and any provided search opts

search(model, search, params)

Searches the index and type associated with model according to query search

update_index(model)

Updates the index for model

Link to this section Types

Link to this type response() View Source 
response() ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}
  | {:error, any()}

Link to this section Functions

Link to this function bulk(operations, opts \\ []) View Source

Generates an Elasticsearch bulk request. operations should be of the form:

[
  {:index, struct}, 
  {:delete, other_struct}, 
  {:update, third_struct}
]

The function will handle formatting the bulk request properly and passing each struct to the ExlasticSearch.Indexable protocol

Link to this function close_index(model) View Source

Close an index for model

Link to this function create_index(model) View Source 
create_index(atom()) :: response()

Creates an index as defined in model

Link to this function create_mapping(model) View Source 
create_mapping(atom()) :: response()

Updates an index’s mappings to the current definition in model

Link to this function delete(struct) View Source 
delete(struct()) :: response()

Removes struct from the index of its model

Link to this function delete_index(model) View Source 
delete_index(atom()) :: response()

Removes the index defined in model

Link to this function exists?(model) View Source 
exists?(atom()) :: boolean()

Checks if the index for model exists

Link to this function get(struct) View Source 
get(struct()) :: response()

Gets an ES document by _id

Link to this function index(struct) View Source 
index(struct()) :: response()

Adds a struct into it’s associated index. The struct will be passed through the ExlasticSearch.Indexable protocol prior to insertion

Link to this function index_stream(stream, parallelism \\ 10, demand \\ 10) View Source
Link to this function open_index(model) View Source

open an index for model

Link to this function paginate(pageable, options \\ []) View Source 
paginate(any(), map() | Keyword.t()) :: Scrivener.Page.t()
Link to this function refresh(model) View Source

Refreshes model’s index

Link to this function search(query, params) View Source 
search(ExlasticSearch.Query.t(), list()) :: response()

Creates a call to search/3 by realizing query (using Exlasticsearch.Query.realize/1) and any provided search opts

Link to this function search(model, search, params) View Source 
search(atom(), map(), list()) :: response()

Searches the index and type associated with model according to query search

Link to this function update_index(model) View Source

Updates the index for model