Module cqerl_protocol

Function Index

auth_frame/2Given frame options and authentication data, produce a 'AUTH_RESPONSE' request frame encoded in the protocol format.
batch_frame/2Given frame options and batch record (containing a set of queries), produce a 'BATCH' request frame encoded in the protocol format.
decode_prepared_metadata/1
decode_result_matrix/4
decode_result_metadata/1
decode_row/3
encode_query_values/2
encode_query_values/3
execute_frame/3Given frame options, query parameters and a query, produce a 'EXECUTE' request frame encoded in the protocol format.
options_frame/1Given frame options, produce a 'OPTIONS' request frame encoded in the protocol format.
prepare_frame/2Given frame options and a CQL query, produce a 'PREPARE' request frame encoded in the protocol format.
query_frame/3Given frame options, query parameters and a query, produce a 'QUERY' request frame encoded in the protocol format.
register_frame/2Given frame options and the list of events, produce a 'REGISTER' request frame encoded in the protocol format.
response_frame/2Decode a response frame coming from the server, expanding the response options and response term.
startup_frame/2Given frame and startup options, produce a 'STARTUP' request frame encoded in the protocol format.

Function Details

auth_frame/2

auth_frame(RequestFrame::#cqerl_frame{}, AuthData::binary()) -> {ok, binary()} | {error, badarg}

Given frame options and authentication data, produce a 'AUTH_RESPONSE' request frame encoded in the protocol format.

batch_frame/2

batch_frame(RequestFrame::#cqerl_frame{}, BatchParameters::#cql_query_batch{}) -> {ok, binary()} | {error, badarg}

Given frame options and batch record (containing a set of queries), produce a 'BATCH' request frame encoded in the protocol format.

decode_prepared_metadata/1

decode_prepared_metadata(X1) -> any()

decode_result_matrix/4

decode_result_matrix(RowCount, ColumnCount, Binary, Acc) -> any()

decode_result_metadata/1

decode_result_metadata(X1) -> any()

decode_row/3

decode_row(Row, ColumnSpecs, Opts) -> any()

encode_query_values/2

encode_query_values(Values, Query) -> any()

encode_query_values/3

encode_query_values(Values, Query, ColumnSpecs) -> any()

execute_frame/3

execute_frame(RequestFrame::#cqerl_frame{}, QueryParameters::#cqerl_query_parameters{}, Query::#cqerl_query{}) -> {ok, binary()} | {error, badarg}

Given frame options, query parameters and a query, produce a 'EXECUTE' request frame encoded in the protocol format.

options_frame/1

options_frame(RequestFrame::#cqerl_frame{}) -> {ok, binary()} | {error, badarg}

Given frame options, produce a 'OPTIONS' request frame encoded in the protocol format.

prepare_frame/2

prepare_frame(RequestFrame::#cqerl_frame{}, CQLStatement::binary()) -> {ok, binary()} | {error, badarg}

Given frame options and a CQL query, produce a 'PREPARE' request frame encoded in the protocol format.

query_frame/3

query_frame(RequestFrame::#cqerl_frame{}, QueryParameters::#cqerl_query_parameters{}, Query::#cqerl_query{}) -> {ok, binary()} | {error, badarg}

Given frame options, query parameters and a query, produce a 'QUERY' request frame encoded in the protocol format.

register_frame/2

register_frame(RequestFrame::#cqerl_frame{}, EventList::[atom() | {atom(), boolean()}]) -> {ok, binary()} | {error, badarg}

Given frame options and the list of events, produce a 'REGISTER' request frame encoded in the protocol format.

response_frame/2

response_frame(ResponseFrame::#cqerl_frame{}, Response::bitstring()) -> {ok, #cqerl_frame{}, any(), binary()} | {error, badarg}

Decode a response frame coming from the server, expanding the response options and response term.

startup_frame/2

startup_frame(RequestFrame::#cqerl_frame{}, StartupOptions::#cqerl_startup_options{}) -> {ok, binary()} | {error, badarg}

Given frame and startup options, produce a 'STARTUP' request frame encoded in the protocol format.


Generated by EDoc