marina_request (marina v0.4.3)

View Source

Summary

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.

frame_flag/0

-type frame_flag() :: 0..1.

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().

stream/0

-type stream() :: 0..32768.

value/0

-type value() :: binary().

values/0

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

Functions

auth_response(FrameFlags, Username, Password)

-spec auth_response(frame_flag(), binary(), binary()) -> iolist().

batch(Stream, FrameFlags, Queries, QueryOpts)

-spec batch(stream(), frame_flag(), [batch_query()], query_opts()) -> iolist().

execute(Stream, FrameFlags, StatementId, QueryOpts)

-spec execute(stream(), frame_flag(), statement_id(), query_opts()) -> iolist().

prepare(Stream, FrameFlags, Query)

-spec prepare(stream(), frame_flag(), query()) -> iolist().

query(Stream, FrameFlags, Query, QueryOpts)

-spec query(stream(), frame_flag(), query(), query_opts()) -> iolist().

register(Stream, FrameFlags, EventTypes)

-spec register(stream(), frame_flag(), [binary()]) -> iolist().

startup(FrameFlags)

-spec startup(frame_flag()) -> iolist().