Module tirerl

Main module with all API functions.

Behaviours: application.

Description

Main module with all API functions.

Data Types

destination()

destination() = atom() | pid()

doc()

doc() = binary() | #{}

id()

id() = binary() | undefined

index()

index() = binary()

node_name()

node_name() = binary()

params()

params() = [tuple()]

pool_name()

pool_name() = atom()

response()

response() = tirerl_worker:response()

type()

type() = binary()

Function Index

aliases/2Operate on aliases (as compared to 'alias').
bulk/2Perform bulk operations on the ElasticSearch cluster.
bulk/3Perform bulk operations on the ElasticSearch cluster with a default index.
bulk/4Perform bulk operations on the ElasticSearch cluster with a default index and a default type.
clear_cache/1Clear all the caches.
clear_cache/2Equivalent to clear_cache(Destination, Indexes, []).
clear_cache/3Equivalent to clear_cache(Destination, Indexes, []).
close_index/2Close an index in the ElasticSearch cluster.
cluster_state/1Equivalent to cluster_state(Destination, []).
cluster_state/2Get the state of the ElasticSearch cluster.
count/2Equivalent to count(Destination, <<"_all">>, [], Doc, []).
count/3Equivalent to count(Destination, <<"_all">>, [], Doc, Params).
count/4Equivalent to count(Destination, Index, [], Doc, Params).
count/5Get the number of matches for a query.
create_index/2Equivalent to create_index(Destination, Index, <<>>).
create_index/3Create an index in the ElasticSearch cluster.
delete_alias/3Delete an alias (as compared to 'aliases').
delete_by_query/2Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, []).
delete_by_query/3Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, Params).
delete_by_query/4Equivalent to delete_by_query(Destination, Index, [], Doc, Params).
delete_by_query/5Get the number of matches for a query.
delete_doc/4Equivalent to delete_doc(Destination, Index, Type, Id, []).
delete_doc/5Delete a doc from the ElasticSearch cluster.
delete_index/1Delete all the indices in the ElasticSearch cluster.
delete_index/2Delete an index(es) in the ElasticSearch cluster.
delete_mapping/3Delete a mapping from an ElasticSearch index.
flush/1Flush all indices.
flush/2Flush one or more indices.
get_alias/3Gets an alias(or more, based on the string).
get_doc/4Equivalent to get_doc(Destination, Index, Type, Id, []).
get_doc/5Get a doc from the ElasticSearch cluster.
get_mapping/3Get a mapping from an ElasticSearch index.
health/1Get the health the ElasticSearch cluster.
indices_stats/2Get the stats of an index/indices in the ElasticSearch cluster.
insert_alias/3Insert an alias (as compared to 'aliases').
insert_alias/4Insert an alias with options(as compared to 'aliases').
insert_doc/5Equivalent to insert_doc(Destination, Index, Type, Id, Doc, []).
insert_doc/6Insert a doc into the ElasticSearch cluster.
is_alias/3Checks if an alias exists (Alias can be a string with a wildcard).
is_doc/4Checks to see if the doc exists.
is_index/2Check if an index/indices exists in the ElasticSearch cluster.
is_type/3Check if a type exists in an index/indices in the ElasticSearch cluster.
mget_doc/2Equivalent to mget_doc(Destination, <<>>, <<>>, Doc).
mget_doc/3Equivalent to mget_doc(Destination, Index, <<>>, Doc).
mget_doc/4Get a doc from the ElasticSearch cluster.
nodes_info/1Equivalent to nodes_info(Destination, [], []).
nodes_info/2Equivalent to nodes_info(Destination, [NodeName], []).
nodes_info/3Get the nodes_info of the ElasticSearch cluster.
nodes_stats/1Equivalent to nodes_stats(Destination, [], []).
nodes_stats/2Equivalent to nodes_stats(Destination, [NodeName], []).
nodes_stats/3Get the nodes_stats of the ElasticSearch cluster.
open_index/2Open an index in the ElasticSearch cluster.
optimize/1Optimize all indices.
optimize/2Optimize one or more indices.
put_mapping/4Insert a mapping into an ElasticSearch index.
refresh/1Refresh all indices.
refresh/2Refresh one or more indices.
search/4Equivalent to search(Destination, Index, Type, Doc, []).
search/5Search for docs in the ElasticSearch cluster.
segments/1Optimize all indices.
segments/2Optimize one or more indices.
start/0Start the application and all its dependencies.
start/2
start_pool/1Start a poolboy instance.
start_pool/2Start a poolboy instance.
state/1Equivalent to state(Destination, []).
state/2Get the state of the ElasticSearch cluster.
status/2Get the status of an index/indices in the ElasticSearch cluster.
stop/0Stop the application and all its dependencies.
stop/1
stop_pool/1Stop a worker pool instance.
update_doc/5Equivalent to update_doc(Destination, Index, Type, Id, Doc, []).
update_doc/6Insert a doc into the ElasticSearch cluster.

Function Details

aliases/2

aliases(Destination::destination(), Doc::doc()) -> response()

Operate on aliases (as compared to 'alias')

bulk/2

bulk(Destination::destination(), Doc::doc()) -> response()

Perform bulk operations on the ElasticSearch cluster

bulk/3

bulk(Destination::destination(), Index::index(), Doc::doc()) -> response()

Perform bulk operations on the ElasticSearch cluster with a default index

bulk/4

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/1

clear_cache(Destination::destination()) -> response()

Equivalent to clear_cache(Destination, <<"_all">>, []).

Clear all the caches

clear_cache/2

clear_cache(Destination::destination(), Index::index() | [index()]) -> response()

Equivalent to clear_cache(Destination, Indexes, []).

clear_cache/3

clear_cache(Destination::destination(), Index::index() | [index()], Params::params()) -> response()

Equivalent to clear_cache(Destination, Indexes, []).

close_index/2

close_index(Destination::destination(), Index::index()) -> response()

Close an index in the ElasticSearch cluster

cluster_state/1

cluster_state(Destination::destination()) -> response()

Equivalent to cluster_state(Destination, []).

cluster_state/2

cluster_state(Destination::destination(), Params::params()) -> response()

Equivalent to state(Destination, Params).

Get the state of the ElasticSearch cluster

count/2

count(Destination::destination(), Doc::doc()) -> response()

Equivalent to count(Destination, <<"_all">>, [], Doc, []).

count/3

count(Destination::destination(), Doc::doc(), Params::params()) -> response()

Equivalent to count(Destination, <<"_all">>, [], Doc, Params).

count/4

count(Destination::destination(), Index::index() | [index()], Doc::doc(), Params::params()) -> response()

Equivalent to count(Destination, Index, [], Doc, Params).

count/5

count(Destination::destination(), Index::index() | [index()], Type::type() | [type()], Doc::doc(), Params::params()) -> response()

Get the number of matches for a query

create_index/2

create_index(Destination::destination(), Index::index()) -> response()

Equivalent to create_index(Destination, Index, <<>>).

create_index/3

create_index(Destination::destination(), Index::index(), Doc::doc()) -> response()

Create an index in the ElasticSearch cluster

delete_alias/3

delete_alias(Destination::destination(), Index::index(), Alias::index()) -> response()

Delete an alias (as compared to 'aliases')

delete_by_query/2

delete_by_query(Destination::destination(), Doc::doc()) -> response()

Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, []).

delete_by_query/3

delete_by_query(Destination::destination(), Doc::doc(), Params::params()) -> response()

Equivalent to delete_by_query(Destination, <<"_all">>, [], Doc, Params).

delete_by_query/4

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/5

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/4

delete_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> response()

Equivalent to delete_doc(Destination, Index, Type, Id, []).

delete_doc/5

delete_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Params::params()) -> response()

Delete a doc from the ElasticSearch cluster

delete_index/1

delete_index(Destination::destination()) -> response()

Delete all the indices in the ElasticSearch cluster

delete_index/2

delete_index(Destination::destination(), Index::index() | [index()]) -> response()

Delete an index(es) in the ElasticSearch cluster

delete_mapping/3

delete_mapping(Destination::destination(), Index::index() | [index()], Type::type()) -> response()

Delete a mapping from an ElasticSearch index

flush/1

flush(Destination::destination()) -> response()

Equivalent to flush(Destination, <<"_all">>).

Flush all indices

flush/2

flush(Destination::destination(), Index::index() | [index()]) -> response()

Flush one or more indices

get_alias/3

get_alias(Destination::destination(), Index::index(), Alias::index()) -> response()

Gets an alias(or more, based on the string)

get_doc/4

get_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> response()

Equivalent to get_doc(Destination, Index, Type, Id, []).

get_doc/5

get_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Params::params()) -> response()

Get a doc from the ElasticSearch cluster

get_mapping/3

get_mapping(Destination::destination(), Index::index() | [index()], Type::type()) -> response()

Get a mapping from an ElasticSearch index

health/1

health(Destination::destination()) -> response()

Get the health the ElasticSearch cluster

indices_stats/2

indices_stats(Destination::destination(), Index::index() | [index()]) -> response()

Get the stats of an index/indices in the ElasticSearch cluster

insert_alias/3

insert_alias(Destination::destination(), Index::index(), Alias::index()) -> response()

Insert an alias (as compared to 'aliases')

insert_alias/4

insert_alias(Destination::destination(), Index::index(), Alias::index(), Doc::doc()) -> response()

Insert an alias with options(as compared to 'aliases')

insert_doc/5

insert_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc()) -> response()

Equivalent to insert_doc(Destination, Index, Type, Id, Doc, []).

insert_doc/6

insert_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc(), Params::params()) -> response()

Insert a doc into the ElasticSearch cluster

is_alias/3

is_alias(Destination::destination(), Index::index(), Alias::index()) -> boolean()

Checks if an alias exists (Alias can be a string with a wildcard)

is_doc/4

is_doc(Destination::destination(), Index::index(), Type::type(), Id::id()) -> boolean()

Checks to see if the doc exists

is_index/2

is_index(Destination::destination(), Index::index() | [index()]) -> boolean()

Check if an index/indices exists in the ElasticSearch cluster

is_type/3

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/2

mget_doc(Destination::destination(), Doc::doc()) -> response()

Equivalent to mget_doc(Destination, <<>>, <<>>, Doc).

mget_doc/3

mget_doc(Destination::destination(), Index::index(), Doc::doc()) -> response()

Equivalent to mget_doc(Destination, Index, <<>>, Doc).

mget_doc/4

mget_doc(Destination::destination(), Index::index(), Type::type(), Doc::doc()) -> response()

Get a doc from the ElasticSearch cluster

nodes_info/1

nodes_info(Destination::destination()) -> response()

Equivalent to nodes_info(Destination, [], []).

nodes_info/2

nodes_info(Destination::destination(), NodeName::node_name()) -> response()

Equivalent to nodes_info(Destination, [NodeName], []).

nodes_info/3

nodes_info(Destination::destination(), NodeNames::[node_name()], Params::params()) -> response()

Get the nodes_info of the ElasticSearch cluster

nodes_stats/1

nodes_stats(Destination::destination()) -> response()

Equivalent to nodes_stats(Destination, [], []).

nodes_stats/2

nodes_stats(Destination::destination(), NodeName::node_name()) -> response()

Equivalent to nodes_stats(Destination, [NodeName], []).

nodes_stats/3

nodes_stats(Destination::destination(), NodeNames::[node_name()], Params::params()) -> response()

Get the nodes_stats of the ElasticSearch cluster

open_index/2

open_index(Destination::destination(), Index::index()) -> response()

Open an index in the ElasticSearch cluster

optimize/1

optimize(Destination::destination()) -> response()

Equivalent to optimize(Destination, <<"_all">>).

Optimize all indices

optimize/2

optimize(Destination::destination(), Index::index() | [index()]) -> response()

Optimize one or more indices

put_mapping/4

put_mapping(Destination::destination(), Index::index() | [index()], Type::type(), Doc::doc()) -> response()

Insert a mapping into an ElasticSearch index

refresh/1

refresh(Destination::destination()) -> response()

Equivalent to refresh(Destination, <<"_all">>).

Refresh all indices

refresh/2

refresh(Destination::destination(), Index::index() | [index()]) -> response()

Refresh one or more indices

search/4

search(Destination::destination(), Index::index(), Type::type(), Doc::doc()) -> response()

Equivalent to search(Destination, Index, Type, Doc, []).

search/5

search(Destination::destination(), Index::index(), Type::type(), Doc::doc(), Params::params()) -> response()

Search for docs in the ElasticSearch cluster

segments/1

segments(Destination::destination()) -> response()

Equivalent to segments(Destination, <<"_all">>).

Optimize all indices

segments/2

segments(Destination::destination(), Index::index() | [index()]) -> response()

Optimize one or more indices

start/0

start() -> {ok, [atom()]}

Start the application and all its dependencies.

start/2

start(StartType::normal | {takeover, node()} | {failover, node()}, StartArgs::[term()]) -> {ok, pid()}

start_pool/1

start_pool(Name::pool_name()) -> supervisor:startchild_ret()

Start a poolboy instance

start_pool/2

start_pool(PoolName::pool_name(), Options::params()) -> supervisor:startchild_ret()

Start a poolboy instance

state/1

state(Destination::destination()) -> response()

Equivalent to state(Destination, []).

state/2

state(Destination::destination(), Params::params()) -> response()

Get the state of the ElasticSearch cluster

status/2

status(Destination::destination(), Index::index() | [index()]) -> response()

Get the status of an index/indices in the ElasticSearch cluster

stop/0

stop() -> ok

Stop the application and all its dependencies.

stop/1

stop(State::[]) -> ok

stop_pool/1

stop_pool(Name::pool_name()) -> ok | tirerl_worker:error()

Stop a worker pool instance

update_doc/5

update_doc(Destination::destination(), Index::index(), Type::type(), Id::id(), Doc::doc()) -> response()

Equivalent to update_doc(Destination, Index, Type, Id, Doc, []).

update_doc/6

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, May 31 2017, 07:59:53.