| Overview |  |
riak_client, but for the "jiak"
pattern of access.
riak_client, but for the "jiak"
pattern of access. Functions defined here are equivalent
to the like-named functions in riak_client, but expect
jiak-style paramenters (like binary object keys) and
return jiak_objects.
default_timeout() = 15000
jiak_client() = term()
| delete/3 | Delete the object at Bucket/Key. |
| delete/4 | Delete the object at Bucket/Key. |
| get/3 | Fetch the object at Bucket/Key. |
| get/4 | Fetch the object at Bucket/Key. |
| get_bucket/1 | Get all properties for Bucket. |
| list_keys/1 | List the keys known to be present in Bucket. |
| mapred/2 | Equivalent to mapred(Inputs, Query, default_timeout()). |
| mapred/3 | Equivalent to riak_client:mapred(Inputs, Query, Timeout). |
| put/2 | Store RObj in the cluster. |
| put/3 | Store RObj in the cluster. |
| put/4 | Store RObj in the cluster. |
| reload_all/1 | Force all Riak nodes to reload Module. |
| riak_client/0 | Get the riak_client that this jiak_client is using. |
| set_bucket/2 | Set the given properties for Bucket. |
delete(Bucket::riak_object:bucket(), Key::jiak_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::niak_object:bucket(), Key::jiak_object:key(), RW::integer(), TimeoutMillisecs::integer()) -> ok | {error, too_many_fails} | {error, notfound} | {error, timeout} | {error, Err::term()}
Equivalent to riak_client:delete(Bucket, Key, RW, Timeout).
Delete the object at Bucket/Key. Return a value as soon as RW nodes have responded with a value or error, or TimeoutMillisecs passes.
get(Bucket::riak_object:bucket(), Key::jiak_object:key(), R::integer()) -> {ok, jiak_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:riak_object(), Key::jiak_object:key(), R::integer(), TimeoutMillisecs::integer()) -> {ok, jiak_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::riak_object:bucket()) -> [BucketProp::{atom(), term()}]
Equivalent to riak_client:get_bucket(BucketName).
Get all properties for Bucket.
list_keys(Bucket::riak_object:bucket()) -> {ok, [Key::riak_object:key()]} | {error, timeout} | {error, Err::term()}
Equivalent to riak_client:list_keys(Bucket).
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.
mapred(Inputs, Query) -> any()
Equivalent to mapred(Inputs, Query, default_timeout()).
See also: riak_object:mapred/2.
mapred(Inputs, Query, Timeout) -> any()
Equivalent to riak_client:mapred(Inputs, Query, Timeout).
See also: riak_object:mapred/3.
put(JiakObject::jiak_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(JiakObject::jiak_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(JiakObject::jiak_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::atom()) -> term()
Equivalent to riak_client:reload_all(Module).
Force all Riak nodes to reload Module. This is used when loading new modules for map/reduce functionality.
riak_client() -> riak_client()
Get the riak_client that this jiak_client is using.
set_bucket(BucketName::riak_object:bucket(), BucketProps::[BucketProp::{atom(), term()}]) -> ok
Equivalent to riak_client:set_bucket(BucketName, BucketProps).
Set the given properties for Bucket.
Generated by EDoc, Feb 2 2010, 10:56:59.