Packages

cloudi_service_db_cassandra_cql

1.5.0
1.5.1 1.5.0 1.4.0 1.4.0-rc.4 1.3.3

Erlang/Elixir Cloud Framework Cassandra CQL Service

Current section

Files

Jump to
Readme
5 Versions
1 Dependency
0 Dependants
Files
Activity
cloudi_service_db_cassandra_cql doc cloudi_service_db_cassandra_cql.html
Raw

doc/cloudi_service_db_cassandra_cql.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_cassandra_cql</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_cassandra_cql</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_DB_Cassandra_CQL_Module">CloudI DB Cassandra CQL Module</a></h3>.

<p>Copyright © 2014 Irina Guberman</p>



<p><b>Version:</b> 1.5.0 Apr 12 2015 21:06:46

  ------------------------------------------------------------------------</p>

<p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</p>

<p><b>Authors:</b> Irina Guberman (<a href="mailto:irina.guberman@gmail.com"><tt>irina.guberman@gmail.com</tt></a>).</p>



<h2><a name="description">Description</a></h2>

   <h3><a name="CloudI_DB_Cassandra_CQL_Module">CloudI DB Cassandra CQL Module</a></h3>

  

       <p>CloudI layer on top of erlcql from           

https://github.com/rpt/erlcql.git</p>

  

       <p>NOTE: set service config count_process to desired pool size</p>

  

       <p>erlcql_client results will be wrapped in cloudi:send_sync result:       

{ok, ErlcqlClientResult}</p>

  

       <p>As a result all successful responses from erlcql_client will be of the form           

{ok, {ok, Response}}       

All failures from erlcql_client will be of the form           

{ok, {error, Reason}}</p>

  

       send_sync errors will be standard 'CloudI' errors

  

<h2><a name="types">Data Types</a></h2>



<h3 class="typedecl"><a name="type-agent">agent()</a></h3>

<p><tt>agent() = <a href="deps/cloudi_core/doc/cloudi.html#type-agent">cloudi:agent()</a></tt></p>





<h3 class="typedecl"><a name="type-args">args()</a></h3>

<p><tt>args() = [{service_name, ServiceName::<a href="#type-service_name">service_name()</a>} | {connection_options, ConnectionOptions::<a href="#type-connection_options">connection_options()</a>} | {consistency, Consistency::<a href="#type-consistency">consistency()</a>}]</tt></p>





<h3 class="typedecl"><a name="type-connection_options">connection_options()</a></h3>

<p><tt>connection_options() = {connection_options, [{host, Host::string()} | {port, Port::integer()} | {username, Username::binary()} | {password, Password::binary()} | {use, Keyspace::binary()} | {prepare, [<a href="#type-query_definition">query_definition()</a>]} | {keepalive, Value::boolean()} | {auto_reconnect, Value::boolean()} | {reconnect_start, Value::integer()} | {reconnect_max, Value::integer()} | {cql_version, CqlVersion::binary()} | {event_fun, EventFun::pid() | function()} | {events, Events::[<a href="#type-event">event()</a>]} | {compression, Compression::<a href="#type-compression">compression()</a>} | {tracing, Tracing::boolean()} | {parent, Parent::pid()}]}</tt></p>





<h3 class="typedecl"><a name="type-cql_name">cql_name()</a></h3>

<p><tt>cql_name() = atom()</tt></p>





<h3 class="typedecl"><a name="type-external_response">external_response()</a></h3>

<p><tt>external_response() = {<a href="#type-response">response()</a>, NewAgent::<a href="#type-agent">agent()</a>} | {{error, Reason::<a href="deps/cloudi_core/doc/cloudi.html#type-error_reason_sync">cloudi:error_reason_sync()</a>}, NewAgent::<a href="#type-agent">agent()</a>}</tt></p>





<h3 class="typedecl"><a name="type-query">query()</a></h3>

<p><tt>query() = binary() | string()</tt></p>





<h3 class="typedecl"><a name="type-query_definition">query_definition()</a></h3>

<p><tt>query_definition() = {QueryName::<a href="#type-cql_name">cql_name()</a>, Query::<a href="#type-query">query()</a>}</tt></p>





<h3 class="typedecl"><a name="type-service_name">service_name()</a></h3>

<p><tt>service_name() = <a href="deps/cloudi_core/doc/cloudi.html#type-service_name">cloudi:service_name()</a></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="#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-4">cloudi_service_init/4</a></td><td></td></tr>

<tr><td valign="top"><a href="#cloudi_service_terminate-3">cloudi_service_terminate/3</a></td><td></td></tr>

<tr><td valign="top"><a href="#execute_prepared_query-4">execute_prepared_query/4</a></td><td></td></tr>

<tr><td valign="top"><a href="#execute_prepared_query-5">execute_prepared_query/5</a></td><td></td></tr>

<tr><td valign="top"><a href="#execute_query-3">execute_query/3</a></td><td></td></tr>

<tr><td valign="top"><a href="#execute_query-4">execute_query/4</a></td><td></td></tr>

</table>



<h2><a name="functions">Function Details</a></h2>



<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, Dispatcher) -&gt; 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) -&gt; any()</tt></p>

</div>



<h3 class="function"><a name="cloudi_service_init-4">cloudi_service_init/4</a></h3>

<div class="spec">

<p><tt>cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -&gt; any()</tt></p>

</div>



<h3 class="function"><a name="cloudi_service_terminate-3">cloudi_service_terminate/3</a></h3>

<div class="spec">

<p><tt>cloudi_service_terminate(Reason, Timeout, State) -&gt; any()</tt></p>

</div>



<h3 class="function"><a name="execute_prepared_query-4">execute_prepared_query/4</a></h3>

<div class="spec">

<p><tt>execute_prepared_query(Agent::<a href="#type-agent">agent()</a>, Name::<a href="#type-service_name">service_name()</a>, QueryName::<a href="#type-cql_name">cql_name()</a>, Values::<a href="#type-values">values()</a>) -&gt; <a href="#type-external_response">external_response()</a></tt><br></p>

</div>



<h3 class="function"><a name="execute_prepared_query-5">execute_prepared_query/5</a></h3>

<div class="spec">

<p><tt>execute_prepared_query(Agent::<a href="#type-agent">agent()</a>, Name::<a href="#type-service_name">service_name()</a>, QueryName::<a href="#type-cql_name">cql_name()</a>, Values::<a href="#type-values">values()</a>, Consistency::<a href="#type-consistency">consistency()</a>) -&gt; <a href="#type-external_response">external_response()</a></tt><br></p>

</div>



<h3 class="function"><a name="execute_query-3">execute_query/3</a></h3>

<div class="spec">

<p><tt>execute_query(Agent::<a href="#type-agent">agent()</a>, Name::<a href="#type-service_name">service_name()</a>, Query::<a href="#type-query">query()</a>) -&gt; <a href="#type-external_response">external_response()</a></tt><br></p>

</div>



<h3 class="function"><a name="execute_query-4">execute_query/4</a></h3>

<div class="spec">

<p><tt>execute_query(Agent::<a href="#type-agent">agent()</a>, Name::<a href="#type-service_name">service_name()</a>, Query::<a href="#type-query">query()</a>, Consistency::<a href="#type-consistency">consistency()</a>) -&gt; <a href="#type-external_response">external_response()</a></tt><br></p>

</div>

<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, Apr 12 2015, 21:06:46.</i></p>

</body>

</html>