| Overview |  |
binary_index() = {binary_index_id(), [binary_index_value()]}
binary_index_id() = {binary_index, string()}
binary_index_value() = binary()
bucket() = binary() | {binary(), binary()}
A bucket name
content_type() = string()
The media type of a value
contents() = [{metadata(), value()}]
All metadata/value pairs in a riakc_obj.
integer_index() = {integer_index_id(), [integer_index_value()]}
integer_index_id() = {integer_index, string()}
integer_index_value() = integer()
key() = binary() | undefined
A key name
metadata() = dict:dict(metadata_key(), metadata_value())
metadata_entry() = {metadata_key(), metadata_value()}
metadata_key() = binary()
metadata_value() = binary()
riakc_obj() = #riakc_obj{bucket = undefined | bucket(), key = undefined | key(), vclock = undefined | vclock(), contents = undefined | contents(), updatemetadata = undefined | metadata(), updatevalue = undefined | value()}
The record/type containing the entire Riak object.
secondary_index() = binary_index() | integer_index()
secondary_index_id() = binary_index_id() | integer_index_id()
secondary_index_value() = integer_index_value() | binary_index_value()
tag() = binary()
value() = binary()
An opaque value
vclock() = binary()
An opaque vector clock
| add_link/2 | Add links for a specific tag. |
| add_secondary_index/2 | Add a secondary index. |
| bucket/1 | Return the containing bucket for this riakc_obj. |
| bucket_type/1 | |
| clear_links/1 | Clear all links. |
| clear_secondary_indexes/1 | Clear all secondary indexes. |
| clear_user_metadata_entries/1 | Clear all metadata entries. |
| delete_links/2 | Delete links for a specific tag. |
| delete_secondary_index/2 | Delete specific secondary index. |
| delete_user_metadata_entry/2 | Delete specific metadata entry. |
| get_all_links/1 | Get all links. |
| get_content_type/1 | Return the content type of the value if there are no siblings. |
| get_content_types/1 | Return a list of content types for all siblings. |
| get_contents/1 | Return the contents (a list of {metadata, value} tuples) for this riakc_obj. |
| get_links/2 | Get links for a specific tag. |
| get_metadata/1 | Assert that this riakc_obj has no siblings and return its associated metadata. |
| get_metadatas/1 | Return a list of the metadata values for this riakc_obj. |
| get_secondary_index/2 | Get value(s) for specific secondary index. |
| get_secondary_indexes/1 | Get all secondary indexes. |
| get_update_content_type/1 | Return the content type of the update value. |
| get_update_metadata/1 | Return the updated metadata of this riakc_obj. |
| get_update_value/1 | Return the updated value of this riakc_obj. |
| get_user_metadata_entries/1 | Get all metadata entries. |
| get_user_metadata_entry/2 | Get specific metadata entry. |
| get_value/1 | Assert that this riakc_obj has no siblings and return its associated value. |
| get_values/1 | Return a list of object values for this riakc_obj. |
| key/1 | Return the key for this riakc_obj. |
| md_ctype/1 | Return the content type from metadata. |
| new/2 | Constructor for new riak client objects. |
| new/3 | Constructor for new riak client objects with an update value. |
| new/4 | Constructor for new riak client objects with an update value and content type. |
| only_bucket/1 | Return the containing bucket for this riakc_obj. |
| select_sibling/2 | Select the sibling to use for update - starting from 1. |
| set_link/2 | Set links for a specific tag. |
| set_secondary_index/2 | Set a secondary index. |
| set_user_metadata_entry/2 | Set a metadata entry. |
| set_vclock/2 | Set the vector clock of an object. |
| update_content_type/2 | Set the updated content-type of an object to CT. |
| update_metadata/2 | Set the updated metadata of an object to M. |
| update_value/2 | Set the updated value of an object to V. |
| update_value/3 | Set the updated value of an object to V. |
| value_count/1 | Return the number of values (siblings) of this riakc_obj. |
| vclock/1 | Return the vector clock for this riakc_obj. |
add_link(MD::metadata(), Link::secondary_index() | [secondary_index()]) -> metadata()
Add links for a specific tag
add_secondary_index(MD::metadata(), Rest::secondary_index() | [secondary_index()]) -> metadata()
Add a secondary index
bucket(Object::riakc_obj()) -> bucket()
Return the containing bucket for this riakc_obj.
bucket_type(Object::riakc_obj()) -> bucket()
clear_links(MD::metadata()) -> metadata()
Clear all links
clear_secondary_indexes(MD::metadata()) -> metadata()
Clear all secondary indexes
clear_user_metadata_entries(MD::metadata()) -> metadata()
Clear all metadata entries
delete_links(MD::metadata(), Tag::tag()) -> metadata()
Delete links for a specific tag
delete_secondary_index(MD::metadata(), IndexId::secondary_index_id()) -> metadata()
Delete specific secondary index
delete_user_metadata_entry(MD::metadata(), Key::metadata_key()) -> metadata()
Delete specific metadata entry
get_all_links(MD::metadata()) -> [link()]
Get all links
get_content_type(Object::riakc_obj()) -> content_type()
throws siblings
Return the content type of the value if there are no siblings.
See also: get_metadata/1.
get_content_types(Object::riakc_obj()) -> [content_type()]
Return a list of content types for all siblings.
get_contents(Object::riakc_obj()) -> contents()
Return the contents (a list of {metadata, value} tuples) for this riakc_obj.
get_links(MD::metadata(), Tag::tag()) -> [id()] | notfound
Get links for a specific tag
get_metadata(Object::riakc_obj()) -> metadata()
throws siblings
Assert that this riakc_obj has no siblings and return its
associated metadata. This function will throw siblings if
the object has siblings (value_count() > 1).
get_metadatas(Object::riakc_obj()) -> [metadata()]
Return a list of the metadata values for this riakc_obj.
get_secondary_index(MD::metadata(), X2::secondary_index_id()) -> [secondary_index_value()] | notfound
Get value(s) for specific secondary index
get_secondary_indexes(MD::metadata()) -> [secondary_index()]
Get all secondary indexes
get_update_content_type(Object::riakc_obj()) -> content_type()
Return the content type of the update value
get_update_metadata(Object::riakc_obj()) -> metadata()
Return the updated metadata of this riakc_obj.
get_update_value(Object::riakc_obj()) -> value()
Return the updated value of this riakc_obj.
get_user_metadata_entries(MD::metadata()) -> [metadata_entry()]
Get all metadata entries
get_user_metadata_entry(MD::metadata(), Key::metadata_key()) -> metadata_value() | notfound
Get specific metadata entry
get_value(Object::riakc_obj()) -> value()
throws siblings | no_value
Assert that this riakc_obj has no siblings and return its
associated value. This function will throw siblings if the
object has siblings (value_count() > 1), or no_value if the
object has no value.
get_values(Object::riakc_obj()) -> [value()]
Return a list of object values for this riakc_obj.
key(Object::riakc_obj()) -> key()
Return the key for this riakc_obj.
md_ctype(MetaData::metadata()) -> undefined | content_type()
Return the content type from metadata
new(Bucket::bucket(), Key::key()) -> riakc_obj() | {error, atom()}
Constructor for new riak client objects.
new(Bucket::bucket(), Key::key(), Value::value()) -> riakc_obj() | {error, atom()}
Constructor for new riak client objects with an update value.
new(Bucket::bucket(), Key::key(), Value::value(), ContentType::content_type()) -> riakc_obj() | {error, atom()}
Constructor for new riak client objects with an update value and content type.
only_bucket(Object::riakc_obj()) -> binary()
Return the containing bucket for this riakc_obj.
select_sibling(Index::pos_integer(), Object::riakc_obj()) -> riakc_obj()
Select the sibling to use for update - starting from 1.
set_link(MD::metadata(), Link::link() | [link()]) -> metadata()
Set links for a specific tag
set_secondary_index(MD::metadata(), Rest::secondary_index() | [secondary_index()]) -> metadata()
Set a secondary index
set_user_metadata_entry(MD::metadata(), X2::metadata_entry()) -> metadata()
Set a metadata entry
set_vclock(Object::riakc_obj(), Vclock::vclock()) -> riakc_obj()
Set the vector clock of an object
update_content_type(Object::riakc_obj(), CT::content_type() | binary()) -> riakc_obj()
Set the updated content-type of an object to CT.
update_metadata(Object::riakc_obj(), M::metadata()) -> riakc_obj()
Set the updated metadata of an object to M.
update_value(Object::riakc_obj(), V::value()) -> riakc_obj()
Set the updated value of an object to V
update_value(Object::riakc_obj(), V::value(), CT::content_type()) -> riakc_obj()
Set the updated value of an object to V
value_count(Object::riakc_obj()) -> non_neg_integer()
Return the number of values (siblings) of this riakc_obj.
vclock(Object::riakc_obj()) -> vclock() | undefined
Return the vector clock for this riakc_obj.
Generated by EDoc, Dec 16 2016, 16:38:08.