| Overview |  |
req_id() = non_neg_integer()
table_name() = string() | binary()
ts_columnname() = riak_pb_ts_codec:tscolumnname()
ts_value() = riak_pb_ts_codec:ldbvalue()
| delete/4 | Delete a record, if there is one, having the fields constituting the primary key in the Table equal to the composite Key (given as a list), using client Pid. |
| get/4 | Get a record, if there is one, having the fields constituting the primary key in the Table equal to the composite Key (supplied as a list), using client Pid. |
| get_coverage/3 | Generate a parallel coverage plan for the specified 'query'. |
| put/3 | Equivalent to put / 4. |
| put/4 | Make data records from Data and insert them, individually, into a time-series Table, using client Pid. |
| query/2 | Equivalent to query / 5. |
| query/3 | Equivalent to query / 5. |
| query/4 | Equivalent to query / 5. |
| query/5 | Execute a Query with client. |
| replace_coverage/4 | Replace a component of a parallel coverage plan. |
| replace_coverage/5 | |
| stream_list_keys/2 | Streaming lists keys in Table, using client Pid, with no timeout. |
| stream_list_keys/3 | Streaming lists keys in Table, using client Pid. |
delete(Pid::pid(), Table::table_name(), Key::[ts_value()], Options::proplists:proplist()) -> ok | {error, Reason::term()}
Delete a record, if there is one, having the fields constituting the primary key in the Table equal to the composite Key (given as a list), using client Pid. Options is a proplist which can include values for 'vclock' and 'timeout'. Unless vclock is supplied, a get (@see get/4) is called in order to obtain one.
get(Pid::pid(), Table::table_name(), Key::[ts_value()], Options::proplists:proplist()) -> {ok, {Columns::[binary()], Record::[ts_value()]}} | {error, {ErrCode::integer(), ErrMsg::binary()}}
Get a record, if there is one, having the fields constituting the primary key in the Table equal to the composite Key (supplied as a list), using client Pid. Options is a proplist which can include a value for 'timeout'. Returns {ok, {Columns, Record}} where Columns has column names, and Record is the record found as a list of values, further as a single element in enclosing list. If no record is found, the return value is {ok, {[], []}}. On error, the function returns {error, {ErrCode, ErrMsg}}.
get_coverage(Pid::pid(), Table::table_name(), QueryText::iolist()) -> {ok, Entries::[term()]} | {error, term()}
Generate a parallel coverage plan for the specified 'query'
put(Pid::pid(), Table::table_name(), Measurements::[[ts_value()]]) -> ok | {error, Reason::term()}
Equivalent to put / 4.
put(Pid::pid(), Table::table_name(), Measurements::[[ts_value()]], Options::proplists:proplist()) -> ok | {error, Reason::term()}
Make data records from Data and insert them, individually, into a time-series Table, using client Pid. Each record is a list of values of appropriate types for the complete set of table column names, in the order in which they appear in table's DDL. On success, 'ok' is returned, else an {error, Reason} tuple.
As of 2015-11-05, ColumnNames parameter is ignored, the function expects the full set of fields in each element of Data.query(Pid::pid(), Query::string() | binary()) -> {ok, {ColumnNames::[ts_columnname()], Rows::[tuple()]}} | {error, Reason::term()}
Equivalent to query / 5.
query(Pid::pid(), Query::string() | binary(), Interpolations::[{binary(), binary()}]) -> {ok, {ColumnNames::[binary()], Rows::[tuple()]}} | {error, term()}
Equivalent to query / 5.
query(Pid::pid(), Query::string() | binary(), Interpolations::[{binary(), binary()}], Cover::term()) -> {ok, {ColumnNames::[binary()], Rows::[tuple()]}} | {error, term()}
Equivalent to query / 5.
query(Pid::pid(), Query::string() | binary(), Interpolations::[{binary(), binary()}], Cover::term(), Options::proplists:proplist()) -> {ok, {ColumnNames::[binary()], Rows::[tuple()]}} | {error, term()}
Execute a Query with client. The result returned is a tuple containing a list of columns as binaries in the first element, and a list of records, each represented as a list of values, in the second element, or an {error, Reason} tuple.
replace_coverage(Pid::pid(), Table::table_name(), QueryText::iolist(), Cover::binary()) -> {ok, Entries::[term()]} | {error, term()}
Replace a component of a parallel coverage plan
replace_coverage(Pid::pid(), Table::table_name(), QueryText::iolist(), Cover::binary(), OtherCover::[binary()]) -> {ok, Entries::[term()]} | {error, term()}
stream_list_keys(Pid::pid(), Table::table_name()) -> {ok, req_id()} | {error, term()}
Streaming lists keys in Table, using client Pid, with no timeout. Returns {ok, ReqId} or {error, Reason}.
stream_list_keys(Pid::pid(), Table::table_name(), Timeout::proplists:proplist() | infinity) -> {ok, req_id()} | {error, term()}
Streaming lists keys in Table, using client Pid. Parameter Options is a proplist that can include a value for 'timeout'. Returns {ok, ReqId} or {error, Reason}.
Generated by EDoc, Dec 16 2016, 16:38:08.