Module cloudi_service_db_riak

Riak CloudI Service

.

Copyright © 2014 Michael Truog

Version: 1.3.3 Sep 30 2014 14:15:49 ------------------------------------------------------------------------

Behaviours: cloudi_service.

Authors: Michael Truog (mjtruog [at] gmail (dot) com).

Description

Riak CloudI Service

Data Types

delete_options()

delete_options() = [{atom(), any()} | atom()]

dispatcher()

dispatcher() = cloudi_service:dispatcher() | cloudi:context()

get_index_eq_options()

get_index_eq_options() = [{atom(), any()}]

get_index_range_options()

get_index_range_options() = [{atom(), any()}]

get_options()

get_options() = [{object, boolean()} | {atom(), any()} | atom()]

index_id()

index_id() = {binary_index, string()} | {integer_index, string()}

indexes()

indexes() = [{{binary_index, string()}, [binary()]} | {{integer_index, string()}, [integer()]}]

new_options()

new_options() = [{content_type, string() | undefined} | {object, boolean()} | {indexes, indexes()} | {atom(), any()} | atom()]

put_options()

put_options() = [{content_type, string() | undefined} | {object, boolean()} | {indexes, indexes()} | {atom(), any()} | atom()]

riakc_obj()

riakc_obj() = riakc_obj:riakc_obj()

Function Index

cloudi_service_handle_info/3
cloudi_service_handle_request/11
cloudi_service_init/3
cloudi_service_terminate/2
delete/4

Delete a key/value pair in a bucket.

.
delete/5

Delete a key/value pair in a bucket with options.

.
get/4

Retrieve a key/value pair from a bucket.

.
get/5

Retrieve a key/value pair from a bucket with options.

.
get_index_eq/5

Get a secondary index equality query.

.
get_index_eq/6

Get a secondary index equality query with options.

.
get_index_range/6

Get a secondary index range query.

.
get_index_range/7

Get a secondary index range query with options.

.
list_buckets/4

List buckets.

Not for poduction use!
list_keys/4

List keys in a bucket.

Not for poduction use!
new/5

Create a new key/value pair in a bucket.

.
new/6

Create a new key/value pair with options in a bucket.

.
object_update/2

Update a riak object value.

.
object_value/1

Return the riak object value.

.
put/4

Store a key/value pair in a bucket.

.
put/5

Store a key/value pair in a bucket.

.
put/6

Store a key/value pair in a bucket with options.

.

Function Details

cloudi_service_handle_info/3

cloudi_service_handle_info(Request, State, Dispatcher) -> any()

cloudi_service_handle_request/11

cloudi_service_handle_request(Type, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()

cloudi_service_init/3

cloudi_service_init(Args, Prefix, Dispatcher) -> any()

cloudi_service_terminate/2

cloudi_service_terminate(X1, State) -> any()

delete/4

delete(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), KeyOrObject::binary() | riakc_obj(), Timeout::cloudi_service:timeout_milliseconds()) -> ok | {error, cloudi_service:error_reason_sync() | any()}

Delete a key/value pair in a bucket.

delete/5

delete(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), KeyOrObject::binary() | riakc_obj(), Options::delete_options(), Timeout::cloudi_service:timeout_milliseconds()) -> ok | {error, cloudi_service:error_reason_sync() | any()}

Delete a key/value pair in a bucket with options.

get/4

get(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), KeyOrObject::binary() | riakc_obj(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), Value::binary()} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Retrieve a key/value pair from a bucket.

get/5

get(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Key::binary(), Options::get_options(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), ValueOrObject::binary() | riakc_obj() | undefined} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Retrieve a key/value pair from a bucket with options.

get_index_eq/5

get_index_eq(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Index::index_id() | binary(), Key::binary() | integer(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Keys::[binary()], Terms::[{integer() | binary(), binary()}], Continuation::binary()} | {error, cloudi_service:error_reason_sync() | any()}

Get a secondary index equality query.

get_index_eq/6

get_index_eq(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Index::index_id() | binary(), Key::binary() | integer(), Options::get_index_eq_options(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Keys::[binary()], Terms::[{integer() | binary(), binary()}], Continuation::binary()} | {error, cloudi_service:error_reason_sync() | any()}

Get a secondary index equality query with options.

get_index_range/6

get_index_range(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Index::index_id() | binary(), KeyStart::binary() | integer() | list(), KeyEnd::binary() | integer() | list(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Keys::[binary()], Terms::[{integer() | binary(), binary()}], Continuation::binary()} | {error, cloudi_service:error_reason_sync() | any()}

Get a secondary index range query.

get_index_range/7

get_index_range(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Index::index_id() | binary(), KeyStart::binary() | integer() | list(), KeyEnd::binary() | integer() | list(), Options::get_index_range_options(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Keys::[binary()], Terms::[{integer() | binary(), binary()}], Continuation::binary()} | {error, cloudi_service:error_reason_sync() | any()}

Get a secondary index range query with options.

list_buckets/4

list_buckets(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Options::list(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, [binary()]} | {error, cloudi_service:error_reason_sync() | any()}

List buckets.

Not for poduction use!

list_keys/4

list_keys(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Options::list(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, [binary()]} | {error, cloudi_service:error_reason_sync() | any()}

List keys in a bucket.

Not for poduction use!

new/5

new(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Key::binary() | undefined, Value::binary(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), NewValue::binary()} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Create a new key/value pair in a bucket.

new/6

new(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Key::binary() | undefined, Value::binary(), Options::new_options(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), NewValueOrObject::binary() | riakc_obj()} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Create a new key/value pair with options in a bucket.

object_update/2

object_update(Object::riakc_obj(), Value::binary()) -> riakc_obj()

Update a riak object value.

object_value/1

object_value(Object::riakc_obj()) -> {ok, Key::binary(), Value::binary()} | {siblings, Key::binary(), Values::[binary()]} | {error, no_value}

Return the riak object value.

put/4

put(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Object::riakc_obj(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), Object::riakc_obj()} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Store a key/value pair in a bucket.

put/5

put(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Key::binary(), ValueOrObject::binary() | riakc_obj(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), Value::binary()} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Store a key/value pair in a bucket.

put/6

put(Dispatcher::dispatcher(), Name::cloudi_service:service_name(), Key::binary(), ValueOrObject::binary() | riakc_obj(), Options::put_options(), Timeout::cloudi_service:timeout_milliseconds()) -> {ok, Key::binary(), ValueOrObject::binary() | riakc_obj()} | {siblings, Key::binary(), Values::[binary()]} | {error, cloudi_service:error_reason_sync() | no_value | any()}

Store a key/value pair in a bucket with options.


Generated by EDoc, Sep 30 2014, 14:15:49.