marina (marina v0.4.3)

View Source

Summary

Types

batch_query/0
batch_type/0
consistency_level/0
error/0
query/0
query_opts/0
routing_key/0
statement_id/0
value/0
values/0

Functions

async_batch(Queries, QueryOpts)
async_query(Query, QueryOpts)
async_reusable_query(Query, QueryOpts)
batch(Queries, QueryOpts)
query(Query, QueryOpts)
receive_response(RequestId)
response(_)
reusable_query(Query, QueryOpts)

Types

batch_query/0

-type batch_query() :: {query, query(), values()} | {prepared, statement_id(), values()}.

batch_type/0

-type batch_type() :: logged | unlogged | counter.

consistency_level/0

-type consistency_level() :: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10.

error/0

-type error() :: {error, term()}.

query/0

-type query() :: binary().

query_opts/0

-type query_opts() ::
          #{batch_type => batch_type(),
            consistency_level => consistency_level(),
            page_size => pos_integer(),
            paging_state => binary(),
            pid => pid(),
            routing_key => routing_key(),
            skip_metadata => boolean(),
            timeout => pos_integer(),
            values => values()}.

routing_key/0

-type routing_key() :: integer() | binary().

statement_id/0

-type statement_id() :: binary().

value/0

-type value() :: binary().

values/0

-type values() :: [value()].

Functions

async_batch(Queries, QueryOpts)

-spec async_batch([batch_query()], query_opts()) -> {ok, shackle:request_id()} | error().

async_query(Query, QueryOpts)

-spec async_query(query(), query_opts()) -> {ok, shackle:request_id()} | error().

async_reusable_query(Query, QueryOpts)

-spec async_reusable_query(query(), query_opts()) -> {ok, shackle:request_id()} | error().

batch(Queries, QueryOpts)

-spec batch([batch_query()], query_opts()) -> {ok, term()} | error().

query(Query, QueryOpts)

-spec query(query(), query_opts()) -> {ok, term()} | error().

receive_response(RequestId)

-spec receive_response(term()) -> {ok, term()} | error().

response(_)

-spec response({ok, term()} | error()) -> {ok, term()} | error().

reusable_query(Query, QueryOpts)

-spec reusable_query(query(), query_opts()) -> {ok, term()} | error().