Module erlastic_search

Description
Function Index
Function Details

Authors: Tristan Sloughter.

Function Index

bulk_index_docs/2
create_index/1	Takes the name of an index to create and sends the request to Elasticsearch, the default settings on localhost.
create_index/2	Takes the name of an index and the record describing the servers details to create and sends the request to Elasticsearch.
delete_doc/3
delete_doc/4
delete_doc_by_query/3
delete_doc_by_query/4
delete_doc_by_query_doc/3
delete_doc_by_query_doc/4
delete_index/1	Delete existing index.
delete_index/2
flush_all/0
flush_all/1
flush_index/1
flush_index/2
get_doc/3	Takes the index and type name and a doc id and sends it to the default Elasticsearch server on localhost:9100.
get_doc/4	Takes the index and type name and a doc id and sends it to the Elasticsearch server specified in Params.
index_doc/3	Takes the index and type name and a Json document described in Erlang terms, converts the document to a string and passes to the default server.
index_doc/4
index_doc_with_id/4	Takes the index and type name and a Json document described in Erlang terms, converts the document to a string after adding the _id field and passes to the default server.
index_doc_with_id/5
index_doc_with_id_opts/6
index_doc_with_opts/5
nodes_info/0	Takes an optional list of node names and the record describing the servers details to read the infos for these nodes.
nodes_info/1
nodes_info/2
optimize_index/1
optimize_index/2
percolate/3
percolate/4
percolator_add/3
percolator_add/4
percolator_del/2
percolator_del/3
put_mapping/3	Insert a mapping into an Elasticsearch index.
put_mapping/4
refresh_all/0
refresh_all/1
refresh_index/1
refresh_index/2
search/2	Takes the index and type name and a query as "key:value" and sends it to the Elasticsearch server specified in Params.
search/3
search/5
search_limit/4
stats_index/0	Takes an optional list of index names and the record describing the servers details to read the stats for these index.
stats_index/1
stats_index/2
upsert_doc/4	Insert the document, or replacing it when it already exists (upsert) (https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html) --------------------------------------------------------------------.
upsert_doc/5
upsert_doc_opts/6

Function Details

bulk_index_docs/2

bulk_index_docs(Erls_params::#erls_params{}, IndexTypeIdJsonTuples::list()) -> {ok, list()} | {error, any()}

create_index/1

create_index(Index::binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the name of an index to create and sends the request to Elasticsearch, the default settings on localhost.

create_index/2

create_index(Erls_params::#erls_params{}, Index::binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the name of an index and the record describing the servers details to create and sends the request to Elasticsearch.

delete_doc/4

delete_doc(Params, Index, Type, Id) -> any()

delete_doc_by_query/3

delete_doc_by_query(Index, Type, Query) -> any()

delete_doc_by_query/4

delete_doc_by_query(Params, Index, Type, Query) -> any()

delete_doc_by_query_doc/3

delete_doc_by_query_doc(Index, Type, Doc) -> any()

delete_doc_by_query_doc/4

delete_doc_by_query_doc(Params, Index, Type, Doc) -> any()

delete_index/1

delete_index(Index) -> any()

Delete existing index

get_doc/3

get_doc(Index::binary(), Type::binary(), Id::binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the index and type name and a doc id and sends it to the default Elasticsearch server on localhost:9100

get_doc/4

get_doc(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Id::binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the index and type name and a doc id and sends it to the Elasticsearch server specified in Params.

index_doc/3

index_doc(Index::binary(), Type::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the index and type name and a Json document described in Erlang terms, converts the document to a string and passes to the default server. Elasticsearch provides the doc with an id.

index_doc/4

index_doc(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

index_doc_with_id/4

index_doc_with_id(Index::binary(), Type::binary(), Id::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the index and type name and a Json document described in Erlang terms, converts the document to a string after adding the _id field and passes to the default server.

index_doc_with_id/5

index_doc_with_id(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Id::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

index_doc_with_id_opts/6

index_doc_with_id_opts(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Id::binary(), Doc::erlastic_json() | binary(), Opts::list()) -> {ok, erlastic_success_result()} | {error, any()}

index_doc_with_opts/5

index_doc_with_opts(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Doc::erlastic_json() | binary(), Opts::list()) -> {ok, erlastic_success_result()} | {error, any()}

nodes_info/0

nodes_info() -> {ok, erlastic_success_result()} | {error, any()}

Takes an optional list of node names and the record describing the servers details to read the infos for these nodes. If no index in supplied then stats for all indices are returned. https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html

nodes_info/1

nodes_info(Erls_params::#erls_params{}) -> {ok, erlastic_success_result()} | {error, any()}

nodes_info/2

nodes_info(Erls_params::#erls_params{}, Nodes::[binary()]) -> {ok, erlastic_success_result()} | {error, any()}

optimize_index/1

optimize_index(Index) -> any()

optimize_index/2

optimize_index(Params, Index) -> any()

percolate/3

percolate(Index, Type, Doc) -> any()

percolate/4

percolate(Params, Index, Type, Doc) -> any()

percolator_add/3

percolator_add(Index, Name, Query) -> any()

percolator_add/4

percolator_add(Params, Index, Name, Query) -> any()

percolator_del/2

percolator_del(Index, Name) -> any()

percolator_del/3

percolator_del(Params, Index, Name) -> any()

put_mapping/3

put_mapping(Index::binary(), Type::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

Insert a mapping into an Elasticsearch index

put_mapping/4

put_mapping(Erls_params::#erls_params{}, Index::binary(), Type::binary(), Doc::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

refresh_all/0

refresh_all() -> any()

refresh_all/1

refresh_all(Params) -> any()

refresh_index/1

refresh_index(Index) -> any()

refresh_index/2

refresh_index(Params, Index) -> any()

search/2

search(Index::binary() | list(), Query::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

Takes the index and type name and a query as "key:value" and sends it to the Elasticsearch server specified in Params.

search/3

search(Params::binary() | list() | #erls_params{}, Index::binary() | list(), Query::erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}

search/5

search(Erls_params::#erls_params{}, Index::list() | binary(), Type::list() | binary(), Query::erlastic_json() | binary(), Opts::list()) -> {ok, erlastic_success_result()} | {error, any()}

search_limit/4

search_limit(Index::binary() | list(), Type::binary(), Query::erlastic_json() | binary(), Limit::integer()) -> {ok, erlastic_success_result()} | {error, any()}

stats_index/0

stats_index() -> any()

Takes an optional list of index names and the record describing the servers details to read the stats for these index. If no index in supplied then stats for all indices are returned. https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html