Packages
Erlang/Elixir Cloud Framework elasticsearch Service
Current section
Files
Jump to
Current section
Files
doc/cloudi_service_db_elasticsearch.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Module cloudi_service_db_elasticsearch</title><link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc"></head><body bgcolor="white"><div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div><hr><h1>Module cloudi_service_db_elasticsearch</h1><ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> <h3><a name="CloudI_ErlasticSearch_Data_Module">CloudI ErlasticSearch Data Module</a></h3>.<p>Copyright © 2013 Mahesh Paolini-Subramanya</p><p><b>Version:</b> 1.3.0 Sep 30 2014 14:10:19 ------------------------------------------------------------------------</p><p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</p><p><b>Authors:</b> Mahesh Paolini-Subramanya (<a href="mailto:mahesh@dieswaytoofast.com"><tt>mahesh@dieswaytoofast.com</tt></a>).</p><h2><a name="description">Description</a></h2> <h3><a name="CloudI_ErlasticSearch_Data_Module">CloudI ErlasticSearch Data Module</a></h3><h2><a name="types">Data Types</a></h2><h3 class="typedecl"><a name="type-dispatcher">dispatcher()</a></h3><p><tt>dispatcher() = <a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a></tt></p><h3 class="typedecl"><a name="type-doc">doc()</a></h3><p><tt>doc() = binary()</tt></p><h3 class="typedecl"><a name="type-error">error()</a></h3><p><tt>error() = {error, Reason::term()}</tt></p><h3 class="typedecl"><a name="type-id">id()</a></h3><p><tt>id() = binary() | undefined</tt></p><h3 class="typedecl"><a name="type-index">index()</a></h3><p><tt>index() = binary()</tt></p><h3 class="typedecl"><a name="type-name">name()</a></h3><p><tt>name() = <a href="deps/cloudi_core/doc/cloudi_service.html#type-service_name">cloudi_service:service_name()</a></tt></p><h3 class="typedecl"><a name="type-node_name">node_name()</a></h3><p><tt>node_name() = binary()</tt></p><h3 class="typedecl"><a name="type-params">params()</a></h3><p><tt>params() = [tuple()]</tt></p><h3 class="typedecl"><a name="type-response">response()</a></h3><p><tt>response() = [tuple()] | <a href="#type-error">error()</a></tt></p><h3 class="typedecl"><a name="type-type">type()</a></h3><p><tt>type() = binary()</tt></p><h2><a name="index">Function Index</a></h2><table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#aliases-3">aliases/3</a></td><td>Operate on aliases (as compared to 'alias').</td></tr><tr><td valign="top"><a href="#clear_cache-2">clear_cache/2</a></td><td>Clear all the caches.</td></tr><tr><td valign="top"><a href="#clear_cache-3">clear_cache/3</a></td><td></td></tr><tr><td valign="top"><a href="#clear_cache-4">clear_cache/4</a></td><td></td></tr><tr><td valign="top"><a href="#close_index-3">close_index/3</a></td><td>Close an index in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_init-3">cloudi_service_init/3</a></td><td></td></tr><tr><td valign="top"><a href="#cloudi_service_terminate-2">cloudi_service_terminate/2</a></td><td></td></tr><tr><td valign="top"><a href="#count-3">count/3</a></td><td></td></tr><tr><td valign="top"><a href="#count-4">count/4</a></td><td></td></tr><tr><td valign="top"><a href="#count-5">count/5</a></td><td></td></tr><tr><td valign="top"><a href="#count-6">count/6</a></td><td>Get the number of matches for a query.</td></tr><tr><td valign="top"><a href="#create_index-3">create_index/3</a></td><td></td></tr><tr><td valign="top"><a href="#create_index-4">create_index/4</a></td><td>Create an index in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#delete_alias-4">delete_alias/4</a></td><td>Delete an alias (as compared to 'aliases').</td></tr><tr><td valign="top"><a href="#delete_by_query-3">delete_by_query/3</a></td><td></td></tr><tr><td valign="top"><a href="#delete_by_query-4">delete_by_query/4</a></td><td></td></tr><tr><td valign="top"><a href="#delete_by_query-5">delete_by_query/5</a></td><td></td></tr><tr><td valign="top"><a href="#delete_by_query-6">delete_by_query/6</a></td><td>Get the number of matches for a query.</td></tr><tr><td valign="top"><a href="#delete_doc-5">delete_doc/5</a></td><td></td></tr><tr><td valign="top"><a href="#delete_doc-6">delete_doc/6</a></td><td>Delete a doc from the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#delete_index-2">delete_index/2</a></td><td>Delete all the indices in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#delete_index-3">delete_index/3</a></td><td>Delete an index(es) in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#delete_mapping-4">delete_mapping/4</a></td><td>Delete a mapping from an ElasticSearch index.</td></tr><tr><td valign="top"><a href="#flush-2">flush/2</a></td><td>Flush all indices _equiv flush(Dispatcher, Name, ?ALL).</td></tr><tr><td valign="top"><a href="#flush-3">flush/3</a></td><td>Flush one or more indices.</td></tr><tr><td valign="top"><a href="#get_alias-4">get_alias/4</a></td><td>Gets an alias(or more, based on the string).</td></tr><tr><td valign="top"><a href="#get_doc-5">get_doc/5</a></td><td></td></tr><tr><td valign="top"><a href="#get_doc-6">get_doc/6</a></td><td>Get a doc from the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#get_mapping-4">get_mapping/4</a></td><td>Get a mapping from an ElasticSearch index.</td></tr><tr><td valign="top"><a href="#health-2">health/2</a></td><td>Get the health the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#insert_alias-4">insert_alias/4</a></td><td>Insert an alias (as compared to 'aliases').</td></tr><tr><td valign="top"><a href="#insert_alias-5">insert_alias/5</a></td><td>Insert an alias with options(as compared to 'aliases').</td></tr><tr><td valign="top"><a href="#insert_doc-6">insert_doc/6</a></td><td></td></tr><tr><td valign="top"><a href="#insert_doc-7">insert_doc/7</a></td><td>Insert a doc into the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#is_alias-4">is_alias/4</a></td><td>Checks if an alias exists (Alias can be a string with a wildcard).</td></tr><tr><td valign="top"><a href="#is_doc-5">is_doc/5</a></td><td>Checks to see if the doc exists.</td></tr><tr><td valign="top"><a href="#is_index-3">is_index/3</a></td><td>Check if an index/indices exists in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#is_type-4">is_type/4</a></td><td>Check if a type exists in an index/indices in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#mget_doc-3">mget_doc/3</a></td><td></td></tr><tr><td valign="top"><a href="#mget_doc-4">mget_doc/4</a></td><td></td></tr><tr><td valign="top"><a href="#mget_doc-5">mget_doc/5</a></td><td>Get a doc from the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#nodes_info-2">nodes_info/2</a></td><td></td></tr><tr><td valign="top"><a href="#nodes_info-3">nodes_info/3</a></td><td></td></tr><tr><td valign="top"><a href="#nodes_info-4">nodes_info/4</a></td><td>Get the nodes_info of the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#nodes_stats-2">nodes_stats/2</a></td><td></td></tr><tr><td valign="top"><a href="#nodes_stats-3">nodes_stats/3</a></td><td></td></tr><tr><td valign="top"><a href="#nodes_stats-4">nodes_stats/4</a></td><td>Get the nodes_stats of the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#open_index-3">open_index/3</a></td><td>Open an index in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#optimize-2">optimize/2</a></td><td>Optimize all indices.</td></tr><tr><td valign="top"><a href="#optimize-3">optimize/3</a></td><td>Optimize one or more indices.</td></tr><tr><td valign="top"><a href="#put_mapping-5">put_mapping/5</a></td><td>Insert a mapping into an ElasticSearch index.</td></tr><tr><td valign="top"><a href="#refresh-2">refresh/2</a></td><td>Refresh all indices.</td></tr><tr><td valign="top"><a href="#refresh-3">refresh/3</a></td><td>Refresh one or more indices.</td></tr><tr><td valign="top"><a href="#search-5">search/5</a></td><td></td></tr><tr><td valign="top"><a href="#search-6">search/6</a></td><td>Search for docs in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#segments-2">segments/2</a></td><td>Optimize all indices.</td></tr><tr><td valign="top"><a href="#segments-3">segments/3</a></td><td>Optimize one or more indices.</td></tr><tr><td valign="top"><a href="#state-2">state/2</a></td><td></td></tr><tr><td valign="top"><a href="#state-3">state/3</a></td><td>Get the state of the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#status-3">status/3</a></td><td>Get the status of an index/indices in the ElasticSearch cluster.</td></tr><tr><td valign="top"><a href="#update_doc-6">update_doc/6</a></td><td></td></tr><tr><td valign="top"><a href="#update_doc-7">update_doc/7</a></td><td>Insert a doc into the ElasticSearch cluster.</td></tr></table><h2><a name="functions">Function Details</a></h2><h3 class="function"><a name="aliases-3">aliases/3</a></h3><div class="spec"><p><tt>aliases(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Operate on aliases (as compared to 'alias')</p><h3 class="function"><a name="clear_cache-2">clear_cache/2</a></h3><div class="spec"><p><tt>clear_cache(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Clear all the caches</p><h3 class="function"><a name="clear_cache-3">clear_cache/3</a></h3><div class="spec"><p><tt>clear_cache(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="clear_cache-4">clear_cache/4</a></h3><div class="spec"><p><tt>clear_cache(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="close_index-3">close_index/3</a></h3><div class="spec"><p><tt>close_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Close an index in the ElasticSearch cluster</p><h3 class="function"><a name="cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></h3><div class="spec"><p><tt>cloudi_service_handle_info(Request, State, X3) -> any()</tt></p></div><h3 class="function"><a name="cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></h3><div class="spec"><p><tt>cloudi_service_handle_request(Type, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()</tt></p></div><h3 class="function"><a name="cloudi_service_init-3">cloudi_service_init/3</a></h3><div class="spec"><p><tt>cloudi_service_init(Args, Prefix, Dispatcher) -> any()</tt></p></div><h3 class="function"><a name="cloudi_service_terminate-2">cloudi_service_terminate/2</a></h3><div class="spec"><p><tt>cloudi_service_terminate(X1, State) -> any()</tt></p></div><h3 class="function"><a name="count-3">count/3</a></h3><div class="spec"><p><tt>count(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="count-4">count/4</a></h3><div class="spec"><p><tt>count(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="count-5">count/5</a></h3><div class="spec"><p><tt>count(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="count-6">count/6</a></h3><div class="spec"><p><tt>count(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a> | [<a href="#type-type">type()</a>], Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><p>Get the number of matches for a query</p><h3 class="function"><a name="create_index-3">create_index/3</a></h3><div class="spec"><p><tt>create_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="create_index-4">create_index/4</a></h3><div class="spec"><p><tt>create_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Create an index in the ElasticSearch cluster</p><h3 class="function"><a name="delete_alias-4">delete_alias/4</a></h3><div class="spec"><p><tt>delete_alias(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Alias::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Delete an alias (as compared to 'aliases')</p><h3 class="function"><a name="delete_by_query-3">delete_by_query/3</a></h3><div class="spec"><p><tt>delete_by_query(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="delete_by_query-4">delete_by_query/4</a></h3><div class="spec"><p><tt>delete_by_query(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="delete_by_query-5">delete_by_query/5</a></h3><div class="spec"><p><tt>delete_by_query(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><h3 class="function"><a name="delete_by_query-6">delete_by_query/6</a></h3><div class="spec"><p><tt>delete_by_query(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a> | [<a href="#type-type">type()</a>], Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, boolean()} | {error, any()}</tt><br></p></div><p>Get the number of matches for a query</p><h3 class="function"><a name="delete_doc-5">delete_doc/5</a></h3><div class="spec"><p><tt>delete_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="delete_doc-6">delete_doc/6</a></h3><div class="spec"><p><tt>delete_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Delete a doc from the ElasticSearch cluster</p><h3 class="function"><a name="delete_index-2">delete_index/2</a></h3><div class="spec"><p><tt>delete_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Delete all the indices in the ElasticSearch cluster</p><h3 class="function"><a name="delete_index-3">delete_index/3</a></h3><div class="spec"><p><tt>delete_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Delete an index(es) in the ElasticSearch cluster</p><h3 class="function"><a name="delete_mapping-4">delete_mapping/4</a></h3><div class="spec"><p><tt>delete_mapping(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Delete a mapping from an ElasticSearch index</p><h3 class="function"><a name="flush-2">flush/2</a></h3><div class="spec"><p><tt>flush(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Flush all indices _equiv flush(Dispatcher, Name, ?ALL).</p><h3 class="function"><a name="flush-3">flush/3</a></h3><div class="spec"><p><tt>flush(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Flush one or more indices</p><h3 class="function"><a name="get_alias-4">get_alias/4</a></h3><div class="spec"><p><tt>get_alias(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Alias::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Gets an alias(or more, based on the string)</p><h3 class="function"><a name="get_doc-5">get_doc/5</a></h3><div class="spec"><p><tt>get_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="get_doc-6">get_doc/6</a></h3><div class="spec"><p><tt>get_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get a doc from the ElasticSearch cluster</p><h3 class="function"><a name="get_mapping-4">get_mapping/4</a></h3><div class="spec"><p><tt>get_mapping(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get a mapping from an ElasticSearch index</p><h3 class="function"><a name="health-2">health/2</a></h3><div class="spec"><p><tt>health(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get the health the ElasticSearch cluster</p><h3 class="function"><a name="insert_alias-4">insert_alias/4</a></h3><div class="spec"><p><tt>insert_alias(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Alias::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Insert an alias (as compared to 'aliases')</p><h3 class="function"><a name="insert_alias-5">insert_alias/5</a></h3><div class="spec"><p><tt>insert_alias(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Alias::<a href="#type-index">index()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Insert an alias with options(as compared to 'aliases')</p><h3 class="function"><a name="insert_doc-6">insert_doc/6</a></h3><div class="spec"><p><tt>insert_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="insert_doc-7">insert_doc/7</a></h3><div class="spec"><p><tt>insert_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Insert a doc into the ElasticSearch cluster</p><h3 class="function"><a name="is_alias-4">is_alias/4</a></h3><div class="spec"><p><tt>is_alias(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Alias::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Checks if an alias exists (Alias can be a string with a wildcard)</p><h3 class="function"><a name="is_doc-5">is_doc/5</a></h3><div class="spec"><p><tt>is_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Checks to see if the doc exists</p><h3 class="function"><a name="is_index-3">is_index/3</a></h3><div class="spec"><p><tt>is_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, boolean()} | {error, any()}</tt><br></p></div><p>Check if an index/indices exists in the ElasticSearch cluster</p><h3 class="function"><a name="is_type-4">is_type/4</a></h3><div class="spec"><p><tt>is_type(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a> | [<a href="#type-type">type()</a>]) -> {ok, boolean()} | {error, any()}</tt><br></p></div><p>Check if a type exists in an index/indices in the ElasticSearch cluster</p><h3 class="function"><a name="mget_doc-3">mget_doc/3</a></h3><div class="spec"><p><tt>mget_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="mget_doc-4">mget_doc/4</a></h3><div class="spec"><p><tt>mget_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="mget_doc-5">mget_doc/5</a></h3><div class="spec"><p><tt>mget_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get a doc from the ElasticSearch cluster</p><h3 class="function"><a name="nodes_info-2">nodes_info/2</a></h3><div class="spec"><p><tt>nodes_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="nodes_info-3">nodes_info/3</a></h3><div class="spec"><p><tt>nodes_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, NodeName::<a href="#type-node_name">node_name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="nodes_info-4">nodes_info/4</a></h3><div class="spec"><p><tt>nodes_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, NodeNames::[<a href="#type-node_name">node_name()</a>], Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get the nodes_info of the ElasticSearch cluster</p><h3 class="function"><a name="nodes_stats-2">nodes_stats/2</a></h3><div class="spec"><p><tt>nodes_stats(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="nodes_stats-3">nodes_stats/3</a></h3><div class="spec"><p><tt>nodes_stats(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, NodeName::<a href="#type-node_name">node_name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="nodes_stats-4">nodes_stats/4</a></h3><div class="spec"><p><tt>nodes_stats(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, NodeNames::[<a href="#type-node_name">node_name()</a>], Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get the nodes_stats of the ElasticSearch cluster</p><h3 class="function"><a name="open_index-3">open_index/3</a></h3><div class="spec"><p><tt>open_index(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Open an index in the ElasticSearch cluster</p><h3 class="function"><a name="optimize-2">optimize/2</a></h3><div class="spec"><p><tt>optimize(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Optimize all indices</p><h3 class="function"><a name="optimize-3">optimize/3</a></h3><div class="spec"><p><tt>optimize(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Optimize one or more indices</p><h3 class="function"><a name="put_mapping-5">put_mapping/5</a></h3><div class="spec"><p><tt>put_mapping(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>], Type::<a href="#type-type">type()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Insert a mapping into an ElasticSearch index</p><h3 class="function"><a name="refresh-2">refresh/2</a></h3><div class="spec"><p><tt>refresh(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Refresh all indices</p><h3 class="function"><a name="refresh-3">refresh/3</a></h3><div class="spec"><p><tt>refresh(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Refresh one or more indices</p><h3 class="function"><a name="search-5">search/5</a></h3><div class="spec"><p><tt>search(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="search-6">search/6</a></h3><div class="spec"><p><tt>search(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Search for docs in the ElasticSearch cluster</p><h3 class="function"><a name="segments-2">segments/2</a></h3><div class="spec"><p><tt>segments(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Optimize all indices</p><h3 class="function"><a name="segments-3">segments/3</a></h3><div class="spec"><p><tt>segments(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Optimize one or more indices</p><h3 class="function"><a name="state-2">state/2</a></h3><div class="spec"><p><tt>state(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="state-3">state/3</a></h3><div class="spec"><p><tt>state(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get the state of the ElasticSearch cluster</p><h3 class="function"><a name="status-3">status/3</a></h3><div class="spec"><p><tt>status(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a> | [<a href="#type-index">index()</a>]) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Get the status of an index/indices in the ElasticSearch cluster</p><h3 class="function"><a name="update_doc-6">update_doc/6</a></h3><div class="spec"><p><tt>update_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Doc::<a href="#type-doc">doc()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><h3 class="function"><a name="update_doc-7">update_doc/7</a></h3><div class="spec"><p><tt>update_doc(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::<a href="#type-name">name()</a>, Index::<a href="#type-index">index()</a>, Type::<a href="#type-type">type()</a>, Id::<a href="#type-id">id()</a>, Doc::<a href="#type-doc">doc()</a>, Params::<a href="#type-params">params()</a>) -> {ok, <a href="#type-response">response()</a>} | {error, any()}</tt><br></p></div><p>Insert a doc into the ElasticSearch cluster</p><hr><div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div><p><i>Generated by EDoc, Sep 30 2014, 14:10:19.</i></p></body></html>