| Overview |  |
riak_client() = term()
| add_event_handler/2 | Equivalent to add_event_handler(Pid, Desc, {'_', '_', '_', '_'}, []). |
| add_event_handler/3 | Equivalent to add_event_handler(Pid, Desc, MatchHead, []). |
| add_event_handler/4 | Register a process that will receive Riak events generated by the cluster in the form of Erlang messages. |
| delete/3 | Delete the object at Bucket/Key. |
| delete/4 | Delete the object at Bucket/Key. |
| filter_keys/2 | List the keys known to be present in Bucket, filtered at the vnode according to Fun, via lists:filter. |
| filter_keys/3 | List the keys known to be present in Bucket, filtered at the vnode according to Fun, via lists:filter. |
| get/3 | Fetch the object at Bucket/Key. |
| get/4 | Fetch the object at Bucket/Key. |
| get_bucket/1 | |
| get_stats/1 | |
| list_buckets/0 | List buckets known to have keys. |
| list_buckets/1 | List buckets known to have keys. |
| list_keys/1 | List the keys known to be present in Bucket. |
| list_keys/2 | List the keys known to be present in Bucket. |
| list_keys/3 | |
| mapred/2 | Perform a map/reduce job across the cluster. |
| mapred/3 | Perform a map/reduce job across the cluster. |
| mapred_bucket/2 | |
| mapred_bucket/3 | |
| mapred_bucket/4 | |
| mapred_bucket_stream/3 | |
| mapred_bucket_stream/4 | |
| mapred_bucket_stream/5 | |
| mapred_stream/2 | Perform a streaming map/reduce job across the cluster. |
| mapred_stream/3 | Perform a streaming map/reduce job across the cluster. |
| put/2 | Store RObj in the cluster. |
| put/3 | Store RObj in the cluster. |
| put/4 | Store RObj in the cluster. |
| reload_all/1 | |
| remove_event_handler/3 |
Remove an event handler added by add_event_handler/4, if it exists. |
| remove_from_cluster/1 | Cause all partitions owned by ExitingNode to be taken over by other nodes. |
| send_event/2 | Send a client-generated event to the Riak eventer. |
| set_bucket/2 | Set the given properties for Bucket. |
| stream_list_keys/1 | |
| stream_list_keys/2 | |
| stream_list_keys/3 | |
| stream_list_keys/4 | |
| stream_list_keys/5 | List the keys known to be present in Bucket. |
add_event_handler(Pid, Desc) -> any()
Equivalent to add_event_handler(Pid, Desc, {'_', '_', '_', '_'}, []).
add_event_handler(Pid, Desc, MatchHead) -> any()
Equivalent to add_event_handler(Pid, Desc, MatchHead, []).
add_event_handler(Pid, Desc, MatchHead, MatchGuard) -> any()
Register a process that will receive Riak events
generated by the cluster in the form of Erlang messages.
See riak_eventer:add_handler/4 for more information.
delete(Bucket::riak_object:bucket(), Key::riak_object:key(), RW::integer()) -> ok | {error, too_many_fails} | {error, notfound} | {error, timeout} | {error, Err::term()}
Equivalent to delete(Bucket, Key, RW, default_timeout()).
Delete the object at Bucket/Key. Return a value as soon as RW nodes have responded with a value or error.
delete(Bucket::riak_object:bucket(), Key::riak_object:key(), RW::integer(), TimeoutMillisecs::integer()) -> ok | {error, too_many_fails} | {error, notfound} | {error, timeout} | {error, Err::term()}
Delete the object at Bucket/Key. Return a value as soon as RW nodes have responded with a value or error, or TimeoutMillisecs passes.
filter_keys(Bucket::riak_object:bucket(), Fun::function()) -> {ok, [Key::riak_object:key()]} | {error, timeout} | {error, Err::term()}
Equivalent to filter_keys(Bucket, Fun, default_timeout() * 8).
List the keys known to be present in Bucket, filtered at the vnode according to Fun, via lists:filter. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after a put or delete.
filter_keys(Bucket::riak_object:bucket(), Fun::function(), TimeoutMillisecs::integer()) -> {ok, [Key::riak_object:key()]} | {error, timeout} | {error, Err::term()}
List the keys known to be present in Bucket, filtered at the vnode according to Fun, via lists:filter. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after a put or delete.
get(Bucket::riak_object:bucket(), Key::riak_object:key(), R::integer()) -> {ok, riak_object:riak_object()} | {error, notfound} | {error, timeout} | {error, Err::term()}
Equivalent to get(Bucket, Key, R, default_timeout()).
Fetch the object at Bucket/Key. Return a value as soon as R nodes have responded with a value or error.
get(Bucket::riak_object:bucket(), Key::riak_object:key(), R::integer(), TimeoutMillisecs::integer()) -> {ok, riak_object:riak_object()} | {error, notfound} | {error, timeout} | {error, Err::term()}
Fetch the object at Bucket/Key. Return a value as soon as R nodes have responded with a value or error, or TimeoutMillisecs passes.
get_bucket(BucketName) -> any()
get_stats(X1) -> any()
list_buckets() -> {ok, [Bucket::riak_object:bucket()]} | {error, timeout} | {error, Err::term()}
Equivalent to list_buckets(default_timeout() * 8).
List buckets known to have keys. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after any operation that either adds the first key or removes the last remaining key from a bucket.
list_buckets(TimeoutMillisecs::integer()) -> {ok, [Bucket::riak_object:bucket()]} | {error, timeout} | {error, Err::term()}
List buckets known to have keys. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after any operation that either adds the first key or removes the last remaining key from a bucket.
list_keys(Bucket::riak_object:bucket()) -> {ok, [Key::riak_object:key()]} | {error, timeout} | {error, Err::term()}
Equivalent to list_keys(Bucket, default_timeout() * 8).
List the keys known to be present in Bucket. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after a put or delete.
list_keys(Bucket::riak_object:bucket(), TimeoutMillisecs::integer()) -> {ok, [Key::riak_object:key()]} | {error, timeout} | {error, Err::term()}
List the keys known to be present in Bucket. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after a put or delete.
list_keys(Bucket, Timeout, ErrorTolerance) -> any()
mapred(Inputs::list(), Query::[riak_mapred_query:mapred_queryterm()]) -> {ok, riak_mapred_query:mapred_result()} | {error, {bad_qterm, riak_mapred_query:mapred_queryterm()}} | {error, timeout} | {error, Err::term()}
Equivalent to mapred(Inputs, Query, default_timeout()).
Perform a map/reduce job across the cluster. See the map/reduce documentation for explanation of behavior.
mapred(Inputs::list(), Query::[riak_mapred_query:mapred_queryterm()], TimeoutMillisecs::integer() | infinity) -> {ok, riak_mapred_query:mapred_result()} | {error, {bad_qterm, riak_mapred_query:mapred_queryterm()}} | {error, timeout} | {error, Err::term()}
Perform a map/reduce job across the cluster. See the map/reduce documentation for explanation of behavior.
mapred_bucket(Bucket, Query) -> any()
mapred_bucket(Bucket, Query, Timeout) -> any()
mapred_bucket(Bucket, Query, Timeout, ErrorTolerance) -> any()
mapred_bucket_stream(Bucket, Query, ClientPid) -> any()
mapred_bucket_stream(Bucket, Query, ClientPid, Timeout) -> any()
mapred_bucket_stream(Bucket, Query, ClientPid, Timeout, ErrorTolerance) -> any()
mapred_stream(Query::[riak_mapred_query:mapred_queryterm()], ClientPid::pid()) -> {ok, {ReqId::term(), MR_FSM_PID::pid()}} | {error, {bad_qterm, riak_mapred_query:mapred_queryterm()}} | {error, Err::term()}
Perform a streaming map/reduce job across the cluster. See the map/reduce documentation for explanation of behavior.
mapred_stream(Query::[riak_mapred_query:mapred_queryterm()], ClientPid::pid(), TimeoutMillisecs::integer() | infinity) -> {ok, {ReqId::term(), MR_FSM_PID::pid()}} | {error, {bad_qterm, riak_mapred_query:mapred_queryterm()}} | {error, Err::term()}
Perform a streaming map/reduce job across the cluster. See the map/reduce documentation for explanation of behavior.
put(RObj::riak_object:riak_object(), W::integer()) -> ok | {error, too_many_fails} | {error, timeout}
Equivalent to put(RObj, W, W, default_timeout()).
Store RObj in the cluster. Return as soon as at least W nodes have received the request.
put(RObj::riak_object:riak_object(), W::integer(), RW::integer()) -> ok | {error, too_many_fails} | {error, timeout}
Equivalent to put(Robj, W, DW, default_timeout()).
Store RObj in the cluster. Return as soon as at least W nodes have received the request, and at least DW nodes have stored it in their storage backend.
put(RObj::riak_object:riak_object(), W::integer(), RW::integer(), TimeoutMillisecs::integer()) -> ok | {error, too_many_fails} | {error, timeout}
Store RObj in the cluster. Return as soon as at least W nodes have received the request, and at least DW nodes have stored it in their storage backend, or TimeoutMillisecs passes.
reload_all(Module) -> any()
remove_event_handler(Pid, MatchHead, MatchGuard) -> any()
Remove an event handler added by add_event_handler/4, if it exists.
See riak_eventer:remove_handler/3 for more information.
remove_from_cluster(ExitingNode::atom()) -> term()
Cause all partitions owned by ExitingNode to be taken over by other nodes.
send_event(EventName::atom(), EventDetail::term()) -> ok
Send a client-generated event to the Riak eventer.
set_bucket(BucketName::riak_object:bucket(), BucketProps::[BucketProp::{atom(), term()}]) -> ok
Set the given properties for Bucket. This is generally best if done at application start time, to ensure expected per-bucket behavior. See riak_bucket for expected useful properties.
stream_list_keys(Bucket) -> any()
stream_list_keys(Bucket, Timeout) -> any()
stream_list_keys(Bucket, Timeout, ErrorTolerance) -> any()
stream_list_keys(Bucket, Timeout, ErrorTolerance, Client) -> any()
stream_list_keys(Bucket::riak_object:bucket(), TimeoutMillisecs::integer(), ErrorTolerance::float(), Client::pid(), ClientType::atom()) -> {ok, ReqId::term()}
List the keys known to be present in Bucket. Key lists are updated asynchronously, so this may be slightly out of date if called immediately after a put or delete. The list will not be returned directly, but will be sent to Client in a sequence of {ReqId, {keys,Keys}} messages and a final {ReqId, done} message. None of the Keys lists will be larger than the number of keys in Bucket on any single vnode. If ClientType is set to 'mapred' instead of 'plain', then the messages will be sent in the form of a MR input stream.
Generated by EDoc, Mar 10 2010, 09:21:17.