Module riak_core_apl

Data Types

chashbin()

chashbin() = term()

docidx()

docidx() = chash:index()

index()

index() = chash:index_as_int()

n_val()

n_val() = non_neg_integer()

preflist()

preflist() = [{index(), node()}]

preflist_ann()

preflist_ann() = [{{index(), node()}, primary | fallback}]

preflist_with_pnum_ann()

preflist_with_pnum_ann() = [{{riak_core_ring:partition_id(), node()}, primary | fallback}]

ring()

ring() = riak_core_ring:riak_core_ring()

Function Index

active_owners/1Return preflist of all active primary nodes (with no substituion of fallbacks).
active_owners/2
first_up/2Return the first entry that is up in the preflist for DocIdx.
get_apl/3Get the active preflist taking account of which nodes are up.
get_apl/4Get the active preflist taking account of which nodes are up for a given ring/upnodes list.
get_apl_ann/2Get the active preflist for a given {bucket, key} and list of nodes and annotate each node with type of primary/fallback.
get_apl_ann/3Get the active preflist taking account of which nodes are up for a given chash/upnodes list and annotate each node with type of primary/fallback.
get_apl_ann/4Get the active preflist taking account of which nodes are up for a given ring/upnodes list and annotate each node with type of primary/fallback.
get_apl_ann_with_pnum/1Get the active preflist taking account of which nodes are up for a given {bucket, key} and annotate each node with type of primary/fallback.
get_primary_apl/3Same as get_apl, but returns only the primaries.
get_primary_apl/4Same as get_apl, but returns only the primaries.
get_primary_apl_chbin/4Same as get_apl, but returns only the primaries.
offline_owners/1
offline_owners/2

Function Details

active_owners/1

active_owners(Service::atom()) -> preflist_ann()

Return preflist of all active primary nodes (with no substituion of fallbacks). Used to simulate a preflist with N=ring_size.

active_owners/2

active_owners(Ring::ring(), UpNodes::[node()]) -> preflist_ann()

first_up/2

first_up(DocIdx, Service) -> any()

Return the first entry that is up in the preflist for DocIdx. This will crash if all owning nodes are offline.

get_apl/3

get_apl(DocIdx::docidx(), N::n_val(), Service::atom()) -> preflist()

Get the active preflist taking account of which nodes are up.

get_apl/4

get_apl(DocIdx::docidx(), N::n_val(), Ring::ring(), UpNodes::[node()]) -> preflist()

Get the active preflist taking account of which nodes are up for a given ring/upnodes list.

get_apl_ann/2

get_apl_ann(X1::riak_core_bucket:bucket(), UpNodes::[node()]) -> preflist_ann()

Get the active preflist for a given {bucket, key} and list of nodes and annotate each node with type of primary/fallback.

get_apl_ann/3

get_apl_ann(DocIdx, N, UpNodes) -> any()

Get the active preflist taking account of which nodes are up for a given chash/upnodes list and annotate each node with type of primary/fallback.

get_apl_ann/4

get_apl_ann(DocIdx::binary(), N::n_val(), Ring::ring(), UpNodes::[node()]) -> preflist_ann()

Get the active preflist taking account of which nodes are up for a given ring/upnodes list and annotate each node with type of primary/fallback.

get_apl_ann_with_pnum/1

get_apl_ann_with_pnum(BKey::riak_core_bucket:bucket()) -> preflist_with_pnum_ann()

Get the active preflist taking account of which nodes are up for a given {bucket, key} and annotate each node with type of primary/fallback

get_primary_apl/3

get_primary_apl(DocIdx::binary(), N::n_val(), Service::atom()) -> preflist_ann()

Same as get_apl, but returns only the primaries.

get_primary_apl/4

get_primary_apl(DocIdx::binary(), N::n_val(), Ring::ring(), UpNodes::[node()]) -> preflist_ann()

Same as get_apl, but returns only the primaries.

get_primary_apl_chbin/4

get_primary_apl_chbin(DocIdx::binary(), N::n_val(), CHBin::chashbin(), UpNodes::[node()]) -> preflist_ann()

Same as get_apl, but returns only the primaries.

offline_owners/1

offline_owners(Service) -> any()

offline_owners/2

offline_owners(Service, CHBin) -> any()


Generated by EDoc