Overview

Module riak_core_metadata

• Data Types
• Function Index
• Function Details

Data Types

delete_opts()

delete_opts() = []

fold_opts()

fold_opts() = it_opts()

get_opt()

get_opt() = get_opt_default_val() | get_opt_resolver() | get_opt_allow_put()

get_opt_allow_put()

get_opt_allow_put() = {allow_put, boolean()}

get_opt_default_val()

get_opt_default_val() = {default, metadata_value()}

get_opt_resolver()

get_opt_resolver() = {resolver, metadata_resolver()}

get_opts()

get_opts() = [get_opt()]

it_opt()

it_opt() = it_opt_resolver() | it_opt_default() | it_opt_keymatch()

it_opt_default()

it_opt_default() = {default, metadata_value() | it_opt_default_fun()}

it_opt_default_fun()

it_opt_default_fun() = fun((metadata_key()) -> metadata_value())

it_opt_keymatch()

it_opt_keymatch() = {match, term()}

it_opt_resolver()

it_opt_resolver() = {resolver, metadata_resolver() | lww}

it_opts()

it_opts() = [it_opt()]

iterator()

iterator() = {riak_core_metadata_manager:metadata_iterator(), it_opts()}

metadata_key()

metadata_key() = any()

metadata_modifier()

metadata_modifier() = fun(([metadata_value() | metadata_tombstone()] | undefined) -> metadata_value())

metadata_prefix()

metadata_prefix() = {binary() | atom(), binary() | atom()}

metadata_resolver()

metadata_resolver() = fun((metadata_value() | metadata_tombstone(), metadata_value() | metadata_tombstone()) -> metadata_value())

metadata_tombstone()

metadata_tombstone() = '$deleted'

metadata_value()

metadata_value() = any()

put_opts()

put_opts() = []

Function Index

Function Details

delete/2

same as delete(FullPrefix, Key, [])

delete/3

Removes the value associated with the given prefix and key locally and then triggers a broradcast to notify other nodes in the cluster. Currently there are no delete options

fold/3

same as fold(Fun, Acc0, FullPrefix, []).

fold/4

Fold over all keys and values stored under a given prefix/subprefix. Available options are the same as those provided to iterator/2. To return early, throw {break, Result} in your fold function.

get/2

same as get(FullPrefix, Key, [])

get/3

Retrieves the local value stored at the given prefix and key.

get/3 can take the following options: * default: value to return if no value is found, undefined if not given. * resolver: A function that resolves conflicts if they are encountered. If not given last-write-wins is used to resolve the conflicts * allow_put: whether or not to write and broadcast a resolved value. defaults to true.

iterator/1

same as iterator(FullPrefix, []).

iterator/2

Return an iterator pointing to the first key stored under a prefix

itr_close/1

Closes the iterator

itr_default/1

Returns the value returned when an iterator points to a tombstone. If the default used when creating the given iterator is a function it will be applied to the current key the iterator points at. If no default was provided the tombstone value was returned. This function should only be called after checking itr_done/1.

itr_done/1

Returns true if there is nothing more to iterate over

itr_key/1

Return the key pointed at by the iterator. Before calling this function, check the iterator is not complete w/ itr_done/1. No conflict resolution will be performed as a result of calling this function.

itr_key_values/1

Return the key and value(s) pointed at by the iterator. Before calling this function, check the iterator is not complete w/ itr_done/1. If a resolver was passed to iterator/0 when creating the given iterator, siblings will be resolved using the given function or last-write-wins (if lww is passed as the resolver). If no resolver was used then no conflict resolution will take place. If conflicts are resolved, the resolved value is written to local metadata and a broadcast is submitted to update other nodes in the cluster if allow_put is true. If allow_put is false the values are resolved but are not written or broadcast. A single value is returned as the second element of the tuple in the case values are resolved. If no resolution takes place then a list of values will be returned as the second element (even if there is only a single sibling).

itr_next/1

Advances the iterator

itr_value/1

Return a single value pointed at by the iterator. If there are conflicts and a resolver was specified in the options when creating this iterator, they will be resolved. Otherwise, and error is returned. If conflicts are resolved, the resolved value is written locally and a broadcast is performed to update other nodes in the cluster if allow_put is true (the default value). If allow_put is false, values are resolved but not written or broadcast.

itr_values/1

Return all sibling values pointed at by the iterator. Before calling this function, check the iterator is not complete w/ itr_done/1. No conflict resolution will be performed as a result of calling this function.

prefix_hash/1

Return the local hash associated with a full-prefix or prefix. The hash value is updated periodically and does not always reflect the most recent value. This function can be used to determine when keys stored under a full-prefix or prefix have changed. If the tree has not yet been updated or there are no keys stored the given (full-)prefix. undefined is returned.

put/3

same as put(FullPrefix, Key, Value, [])

put/4

Stores or updates the value at the given prefix and key locally and then triggers a broadcast to notify other nodes in the cluster. Currently, there are no put options

to_list/1

same as to_list(FullPrefix, [])

to_list/2

Return a list of all keys and values stored under a given prefix/subprefix. Available options are the same as those provided to iterator/2.

Overview

Generated by EDoc