Behaviours: application.
destination() = atom() | pid()
doc() = binary() | map()
id() = binary() | undefined
index() = binary()
node_name() = binary()
params() = [tuple()]
pool_name() = atom()
response() = tirerl_worker:response()
type() = binary()
aliases/2 | Operate on aliases (as compared to 'alias'). |
bulk/2 | Perform bulk operations on the ElasticSearch cluster. |
bulk/3 | Perform bulk operations on the ElasticSearch cluster with a default index. |
bulk/4 | Perform bulk operations on the ElasticSearch cluster with a default index and a default type. |
clear_cache/1 | Clear all the caches. |
clear_cache/2 | Equivalent to clear_cache(Destination, Indexes, []). |
clear_cache/3 | Equivalent to clear_cache(Destination, Indexes, []). |
close_index/2 | Close an index in the ElasticSearch cluster. |
cluster_state/1 | Equivalent to cluster_state(Destination, []). |
cluster_state/2 | Get the state of the ElasticSearch cluster. |
count/2 | Equivalent to count(Destination, <<"_all">>, [], Doc, []). |
count/3 | Equivalent to count(Destination, <<"_all">>, [], Doc, Params). |
count/4 | Equivalent to count(Destination, Index, [], Doc, Params). |
count/5 | Get the number of matches for a query. |
create_index/2 | Equivalent to create_index(Destination, Index, <<>>). |
create_index/3 | Create an index in the ElasticSearch cluster. |
delete_alias/3 | Delete an alias (as compared to 'aliases'). |
delete_by_query/2 | Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, []). |
delete_by_query/3 | Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, Params). |
delete_by_query/4 | Equivalent to delete_by_query(Destination, Index, [], Doc, Params). |
delete_by_query/5 | Get the number of matches for a query. |
delete_doc/4 | Equivalent to delete_doc(Destination, Index, Type, Id, []). |
delete_doc/5 | Delete a doc from the ElasticSearch cluster. |
delete_index/1 | Delete all the indices in the ElasticSearch cluster. |
delete_index/2 | Delete an index(es) in the ElasticSearch cluster. |
delete_mapping/3 | Delete a mapping from an ElasticSearch index. |
flush/1 | Flush all indices. |
flush/2 | Flush one or more indices. |
get_alias/3 | Gets an alias(or more, based on the string). |
get_doc/4 | Equivalent to get_doc(Destination, Index, Type, Id, []). |
get_doc/5 | Get a doc from the ElasticSearch cluster. |
get_mapping/3 | Get a mapping from an ElasticSearch index. |
health/1 | Get the health the ElasticSearch cluster. |
indices_stats/2 | Get the stats of an index/indices in the ElasticSearch cluster. |
insert_alias/3 | Insert an alias (as compared to 'aliases'). |
insert_alias/4 | Insert an alias with options(as compared to 'aliases'). |
insert_doc/5 | Equivalent to insert_doc(Destination, Index, Type, Id, Doc, []). |
insert_doc/6 | Insert a doc into the ElasticSearch cluster. |
is_alias/3 | Checks if an alias exists (Alias can be a string with a wildcard). |
is_doc/4 | Checks to see if the doc exists. |
is_index/2 | Check if an index/indices exists in the ElasticSearch cluster. |
is_type/3 | Check if a type exists in an index/indices in the ElasticSearch cluster. |
mget_doc/2 | Equivalent to mget_doc(Destination, <<>>, <<>>, Doc). |
mget_doc/3 | Equivalent to mget_doc(Destination, Index, <<>>, Doc). |
mget_doc/4 | Get a doc from the ElasticSearch cluster. |
nodes_info/1 | Equivalent to nodes_info(Destination, [], []). |
nodes_info/2 | Equivalent to nodes_info(Destination, [NodeName], []). |
nodes_info/3 | Get the nodes_info of the ElasticSearch cluster. |
nodes_stats/1 | Equivalent to nodes_stats(Destination, [], []). |
nodes_stats/2 | Equivalent to nodes_stats(Destination, [NodeName], []). |
nodes_stats/3 | Get the nodes_stats of the ElasticSearch cluster. |
open_index/2 | Open an index in the ElasticSearch cluster. |
optimize/1 | Optimize all indices. |
optimize/2 | Optimize one or more indices. |
put_mapping/4 | Insert a mapping into an ElasticSearch index. |
refresh/1 | Refresh all indices. |
refresh/2 | Refresh one or more indices. |
search/4 | Equivalent to search(Destination, Index, Type, Doc, []). |
search/5 | Search for docs in the ElasticSearch cluster. |
segments/1 | Optimize all indices. |
segments/2 | Optimize one or more indices. |
start/0 | Start the application and all its dependencies. |
start/2 | |
start_pool/1 | Start a poolboy instance. |
start_pool/2 | Start a poolboy instance. |
state/1 | Equivalent to state(Destination, []). |
state/2 | Get the state of the ElasticSearch cluster. |
status/2 | Get the status of an index/indices in the ElasticSearch cluster. |
stop/0 | Stop the application and all its dependencies. |
stop/1 | |
stop_pool/1 | Stop a worker pool instance. |
update_doc/5 | Equivalent to update_doc(Destination, Index, Type, Id, Doc, []). |
update_doc/6 | Insert a doc into the ElasticSearch cluster. |
aliases(Destination::destination(), Doc::doc()) -> response()
Operate on aliases (as compared to 'alias')
bulk(Destination::destination(), Doc::doc()) -> response()
Perform bulk operations on the ElasticSearch cluster
bulk(Destination::destination(), Index::index(), Doc::doc()) -> response()
Perform bulk operations on the ElasticSearch cluster with a default index
bulk(Destination::destination(), Index::index(), Type::type(), Doc::doc()) -> response()
Perform bulk operations on the ElasticSearch cluster with a default index and a default type
clear_cache(Destination::destination()) -> response()
Equivalent to clear_cache(Destination, <<"_all">>, []).
Clear all the caches
clear_cache(Destination::destination(), Index::index() | [index()]) -> response()
Equivalent to clear_cache(Destination, Indexes, []).
clear_cache(Destination::destination(), Index::index() | [index()], Params::params()) -> response()
Equivalent to clear_cache(Destination, Indexes, []).
close_index(Destination::destination(), Index::index()) -> response()
Close an index in the ElasticSearch cluster
cluster_state(Destination::destination()) -> response()
Equivalent to cluster_state(Destination, []).
cluster_state(Destination::destination(), Params::params()) -> response()
Equivalent to state(Destination, Params).
Get the state of the ElasticSearch cluster
count(Destination::destination(), Doc::doc()) -> response()
Equivalent to count(Destination, <<"_all">>, [], Doc, []).
count(Destination::destination(), Doc::doc(), Params::params()) -> response()
Equivalent to count(Destination, <<"_all">>, [], Doc, Params).
count(Destination::destination(), Index::index() | [index()], Doc::doc(), Params::params()) -> response()
Equivalent to count(Destination, Index, [], Doc, Params).
count(Destination::destination(), Index::index() | [index()], Type::type() | [type()], Doc::doc(), Params::params()) -> response()
Get the number of matches for a query
create_index(Destination::destination(), Index::index()) -> response()
Equivalent to create_index(Destination, Index, <<>>).
create_index(Destination::destination(), Index::index(), Doc::doc()) -> response()
Create an index in the ElasticSearch cluster
delete_alias(Destination::destination(), Index::index(), Alias::index()) -> response()
Delete an alias (as compared to 'aliases')
delete_by_query(Destination::destination(), Doc::doc()) -> response()
Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, []).
delete_by_query(Destination::destination(), Doc::doc(), Params::params()) -> response()
Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, Params).
delete_by_query(Destination::destination(), Index::index() | [index()], Doc::doc(), Params::params()) -> response()
Equivalent to delete_by_query(Destination, Index, [], Doc, Params).
delete_by_query(Destination::destination(), Index::index() | [index()], Type::type() | [type()], Doc::doc(), Params::params()) -> response()
Get the number of matches for a query
delete_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> response()
Equivalent to delete_doc(Destination, Index, Type, Id, []).
delete_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Params::params()) -> response()
Delete a doc from the ElasticSearch cluster
delete_index(Destination::destination()) -> response()
Delete all the indices in the ElasticSearch cluster
delete_index(Destination::destination(), Index::index() | [index()]) -> response()
Delete an index(es) in the ElasticSearch cluster
delete_mapping(Destination::destination(), Index::index() | [index()], Type::type()) -> response()
Delete a mapping from an ElasticSearch index
flush(Destination::destination()) -> response()
Equivalent to flush(Destination, <<"_all">>).
Flush all indices
flush(Destination::destination(), Index::index() | [index()]) -> response()
Flush one or more indices
get_alias(Destination::destination(), Index::index(), Alias::index()) -> response()
Gets an alias(or more, based on the string)
get_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> response()
Equivalent to get_doc(Destination, Index, Type, Id, []).
get_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Params::params()) -> response()
Get a doc from the ElasticSearch cluster
get_mapping(Destination::destination(), Index::index() | [index()], Type::type()) -> response()
Get a mapping from an ElasticSearch index
health(Destination::destination()) -> response()
Get the health the ElasticSearch cluster
indices_stats(Destination::destination(), Index::index() | [index()]) -> response()
Get the stats of an index/indices in the ElasticSearch cluster
insert_alias(Destination::destination(), Index::index(), Alias::index()) -> response()
Insert an alias (as compared to 'aliases')
insert_alias(Destination::destination(), Index::index(), Alias::index(), Doc::doc()) -> response()
Insert an alias with options(as compared to 'aliases')
insert_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc()) -> response()
Equivalent to insert_doc(Destination, Index, Type, Id, Doc, []).
insert_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc(), Params::params()) -> response()
Insert a doc into the ElasticSearch cluster
is_alias(Destination::destination(), Index::index(), Alias::index()) -> boolean()
Checks if an alias exists (Alias can be a string with a wildcard)
is_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> boolean()
Checks to see if the doc exists
is_index(Destination::destination(), Index::index() | [index()]) -> boolean()
Check if an index/indices exists in the ElasticSearch cluster
is_type(Destination::destination(), Index::index() | [index()], Type::type() | [type()]) -> boolean()
Check if a type exists in an index/indices in the ElasticSearch cluster
mget_doc(Destination::destination(), Doc::doc()) -> response()
Equivalent to mget_doc(Destination, <<>>, <<>>, Doc).
mget_doc(Destination::destination(), Index::index(), Doc::doc()) -> response()
Equivalent to mget_doc(Destination, Index, <<>>, Doc).
mget_doc(Destination::destination(), Index::index(), Type::type(), Doc::doc()) -> response()
Get a doc from the ElasticSearch cluster
nodes_info(Destination::destination()) -> response()
Equivalent to nodes_info(Destination, [], []).
nodes_info(Destination::destination(), NodeName::node_name()) -> response()
Equivalent to nodes_info(Destination, [NodeName], []).
nodes_info(Destination::destination(), NodeNames::[node_name()], Params::params()) -> response()
Get the nodes_info of the ElasticSearch cluster
nodes_stats(Destination::destination()) -> response()
Equivalent to nodes_stats(Destination, [], []).
nodes_stats(Destination::destination(), NodeName::node_name()) -> response()
Equivalent to nodes_stats(Destination, [NodeName], []).
nodes_stats(Destination::destination(), NodeNames::[node_name()], Params::params()) -> response()
Get the nodes_stats of the ElasticSearch cluster
open_index(Destination::destination(), Index::index()) -> response()
Open an index in the ElasticSearch cluster
optimize(Destination::destination()) -> response()
Equivalent to optimize(Destination, <<"_all">>).
Optimize all indices
optimize(Destination::destination(), Index::index() | [index()]) -> response()
Optimize one or more indices
put_mapping(Destination::destination(), Index::index() | [index()], Type::type(), Doc::doc()) -> response()
Insert a mapping into an ElasticSearch index
refresh(Destination::destination()) -> response()
Equivalent to refresh(Destination, <<"_all">>).
Refresh all indices
refresh(Destination::destination(), Index::index() | [index()]) -> response()
Refresh one or more indices
search(Destination::destination(), Index::index(), Type::type(), Doc::doc()) -> response()
Equivalent to search(Destination, Index, Type, Doc, []).
search(Destination::destination(), Index::index(), Type::type(), Doc::doc(), Params::params()) -> response()
Search for docs in the ElasticSearch cluster
segments(Destination::destination()) -> response()
Equivalent to segments(Destination, <<"_all">>).
Optimize all indices
segments(Destination::destination(), Index::index() | [index()]) -> response()
Optimize one or more indices
start() -> {ok, [atom()]}
Start the application and all its dependencies.
start(StartType::normal | {takeover, node()} | {failover, node()}, StartArgs::[term()]) -> {ok, pid()}
start_pool(Name::pool_name()) -> supervisor:startchild_ret()
Start a poolboy instance
start_pool(PoolName::pool_name(), Options::params()) -> supervisor:startchild_ret()
Start a poolboy instance
state(Destination::destination()) -> response()
Equivalent to state(Destination, []).
state(Destination::destination(), Params::params()) -> response()
Get the state of the ElasticSearch cluster
status(Destination::destination(), Index::index() | [index()]) -> response()
Get the status of an index/indices in the ElasticSearch cluster
stop() -> ok
Stop the application and all its dependencies.
stop(State::[]) -> ok
stop_pool(Name::pool_name()) -> true
Stop a worker pool instance
update_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc()) -> response()
Equivalent to update_doc(Destination, Index, Type, Id, Doc, []).
update_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc(), Params::params()) -> response()
Insert a doc into the ElasticSearch cluster
Generated by EDoc