Overview

Module riak_kv_pb

• Data Types
• Function Index
• Function Details

Data Types

'RpbBucketProps.RpbReplMode'()

'RpbBucketProps.RpbReplMode'() = 'FALSE' | 'REALTIME' | 'FULLSYNC' | 'TRUE'

'RpbIndexReq.IndexQueryType'()

'RpbIndexReq.IndexQueryType'() = eq | range

rpbauthreq()

rpbauthreq() = #rpbauthreq{user = binary(), password = binary()}

rpbbucketkeypreflistitem()

rpbbucketkeypreflistitem() = #rpbbucketkeypreflistitem{partition = integer(), node = binary(), primary = boolean() | 0 | 1}

rpbbucketprops()

rpbbucketprops() = #rpbbucketprops{n_val = non_neg_integer() | undefined, allow_mult = boolean() | 0 | 1 | undefined, last_write_wins = boolean() | 0 | 1 | undefined, precommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_precommit = boolean() | 0 | 1 | undefined, postcommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_postcommit = boolean() | 0 | 1 | undefined, chash_keyfun = #rpbmodfun{module = binary(), function = binary()} | undefined, linkfun = #rpbmodfun{module = binary(), function = binary()} | undefined, old_vclock = non_neg_integer() | undefined, young_vclock = non_neg_integer() | undefined, big_vclock = non_neg_integer() | undefined, small_vclock = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, r = non_neg_integer() | undefined, w = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, rw = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined, backend = binary() | undefined, search = boolean() | 0 | 1 | undefined, repl = 'FALSE' | 'REALTIME' | 'FULLSYNC' | 'TRUE' | integer() | undefined, search_index = binary() | undefined, datatype = binary() | undefined, consistent = boolean() | 0 | 1 | undefined, write_once = boolean() | 0 | 1 | undefined, hll_precision = non_neg_integer() | undefined, ttl = non_neg_integer() | undefined}

rpbcommithook()

rpbcommithook() = #rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}

rpbcontent()

rpbcontent() = #rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}

rpbcountergetreq()

rpbcountergetreq() = #rpbcountergetreq{bucket = binary(), key = binary(), r = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined}

rpbcountergetresp()

rpbcountergetresp() = #rpbcountergetresp{value = integer() | undefined}

rpbcounterupdatereq()

rpbcounterupdatereq() = #rpbcounterupdatereq{bucket = binary(), key = binary(), amount = integer(), w = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, returnvalue = boolean() | 0 | 1 | undefined}

rpbcounterupdateresp()

rpbcounterupdateresp() = #rpbcounterupdateresp{value = integer() | undefined}

rpbcoverageentry()

rpbcoverageentry() = #rpbcoverageentry{ip = binary(), port = non_neg_integer(), keyspace_desc = binary() | undefined, cover_context = binary()}

rpbcoveragereq()

rpbcoveragereq() = #rpbcoveragereq{type = binary() | undefined, bucket = binary(), min_partitions = non_neg_integer() | undefined, replace_cover = binary() | undefined, unavailable_cover = [binary()]}

rpbcoverageresp()

rpbcoverageresp() = #rpbcoverageresp{entries = [#rpbcoverageentry{ip = binary(), port = non_neg_integer(), keyspace_desc = binary() | undefined, cover_context = binary()}]}

rpbcsbucketreq()

rpbcsbucketreq() = #rpbcsbucketreq{bucket = binary(), start_key = binary(), end_key = binary() | undefined, start_incl = boolean() | 0 | 1 | undefined, end_incl = boolean() | 0 | 1 | undefined, continuation = binary() | undefined, max_results = non_neg_integer() | undefined, timeout = non_neg_integer() | undefined, type = binary() | undefined, cover_context = binary() | undefined}

rpbcsbucketresp()

rpbcsbucketresp() = #rpbcsbucketresp{objects = [#rpbindexobject{key = binary(), object = #rpbgetresp{content = [#rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}], vclock = binary() | undefined, unchanged = boolean() | 0 | 1 | undefined}}], continuation = binary() | undefined, done = boolean() | 0 | 1 | undefined}

rpbdelreq()

rpbdelreq() = #rpbdelreq{bucket = binary(), key = binary(), rw = non_neg_integer() | undefined, vclock = binary() | undefined, r = non_neg_integer() | undefined, w = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, timeout = non_neg_integer() | undefined, sloppy_quorum = boolean() | 0 | 1 | undefined, n_val = non_neg_integer() | undefined, type = binary() | undefined}

rpberrorresp()

rpberrorresp() = #rpberrorresp{errmsg = binary(), errcode = non_neg_integer()}

rpbgetbucketkeypreflistreq()

rpbgetbucketkeypreflistreq() = #rpbgetbucketkeypreflistreq{bucket = binary(), key = binary(), type = binary() | undefined}

rpbgetbucketkeypreflistresp()

rpbgetbucketkeypreflistresp() = #rpbgetbucketkeypreflistresp{preflist = [#rpbbucketkeypreflistitem{partition = integer(), node = binary(), primary = boolean() | 0 | 1}]}

rpbgetbucketreq()

rpbgetbucketreq() = #rpbgetbucketreq{bucket = binary(), type = binary() | undefined}

rpbgetbucketresp()

rpbgetbucketresp() = #rpbgetbucketresp{props = #rpbbucketprops{n_val = non_neg_integer() | undefined, allow_mult = boolean() | 0 | 1 | undefined, last_write_wins = boolean() | 0 | 1 | undefined, precommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_precommit = boolean() | 0 | 1 | undefined, postcommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_postcommit = boolean() | 0 | 1 | undefined, chash_keyfun = #rpbmodfun{module = binary(), function = binary()} | undefined, linkfun = #rpbmodfun{module = binary(), function = binary()} | undefined, old_vclock = non_neg_integer() | undefined, young_vclock = non_neg_integer() | undefined, big_vclock = non_neg_integer() | undefined, small_vclock = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, r = non_neg_integer() | undefined, w = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, rw = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined, backend = binary() | undefined, search = boolean() | 0 | 1 | undefined, repl = 'FALSE' | 'REALTIME' | 'FULLSYNC' | 'TRUE' | integer() | undefined, search_index = binary() | undefined, datatype = binary() | undefined, consistent = boolean() | 0 | 1 | undefined, write_once = boolean() | 0 | 1 | undefined, hll_precision = non_neg_integer() | undefined, ttl = non_neg_integer() | undefined}}

rpbgetbuckettypereq()

rpbgetbuckettypereq() = #rpbgetbuckettypereq{type = binary()}

rpbgetclientidresp()

rpbgetclientidresp() = #rpbgetclientidresp{client_id = binary()}

rpbgetreq()

rpbgetreq() = #rpbgetreq{bucket = binary(), key = binary(), r = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined, if_modified = binary() | undefined, head = boolean() | 0 | 1 | undefined, deletedvclock = boolean() | 0 | 1 | undefined, timeout = non_neg_integer() | undefined, sloppy_quorum = boolean() | 0 | 1 | undefined, n_val = non_neg_integer() | undefined, type = binary() | undefined}

rpbgetresp()

rpbgetresp() = #rpbgetresp{content = [#rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}], vclock = binary() | undefined, unchanged = boolean() | 0 | 1 | undefined}

rpbgetserverinforesp()

rpbgetserverinforesp() = #rpbgetserverinforesp{node = binary() | undefined, server_version = binary() | undefined}

rpbindexbodyresp()

rpbindexbodyresp() = #rpbindexbodyresp{objects = [#rpbindexobject{key = binary(), object = #rpbgetresp{content = [#rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}], vclock = binary() | undefined, unchanged = boolean() | 0 | 1 | undefined}}], continuation = binary() | undefined, done = boolean() | 0 | 1 | undefined}

rpbindexobject()

rpbindexobject() = #rpbindexobject{key = binary(), object = #rpbgetresp{content = [#rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}], vclock = binary() | undefined, unchanged = boolean() | 0 | 1 | undefined}}

rpbindexreq()

rpbindexreq() = #rpbindexreq{bucket = binary(), index = binary(), qtype = eq | range | integer(), key = binary() | undefined, range_min = binary() | undefined, range_max = binary() | undefined, return_terms = boolean() | 0 | 1 | undefined, stream = boolean() | 0 | 1 | undefined, max_results = non_neg_integer() | undefined, continuation = binary() | undefined, timeout = non_neg_integer() | undefined, type = binary() | undefined, term_regex = binary() | undefined, pagination_sort = boolean() | 0 | 1 | undefined, cover_context = binary() | undefined, return_body = boolean() | 0 | 1 | undefined}

rpbindexresp()

rpbindexresp() = #rpbindexresp{keys = [binary()], results = [#rpbpair{key = binary(), value = binary() | undefined}], continuation = binary() | undefined, done = boolean() | 0 | 1 | undefined}

rpblink()

rpblink() = #rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}

rpblistbucketsreq()

rpblistbucketsreq() = #rpblistbucketsreq{timeout = non_neg_integer() | undefined, stream = boolean() | 0 | 1 | undefined, type = binary() | undefined}

rpblistbucketsresp()

rpblistbucketsresp() = #rpblistbucketsresp{buckets = [binary()], done = boolean() | 0 | 1 | undefined}

rpblistkeysreq()

rpblistkeysreq() = #rpblistkeysreq{bucket = binary(), timeout = non_neg_integer() | undefined, type = binary() | undefined}

rpblistkeysresp()

rpblistkeysresp() = #rpblistkeysresp{keys = [binary()], done = boolean() | 0 | 1 | undefined}

rpbmapredreq()

rpbmapredreq() = #rpbmapredreq{request = binary(), content_type = binary()}

rpbmapredresp()

rpbmapredresp() = #rpbmapredresp{phase = non_neg_integer() | undefined, response = binary() | undefined, done = boolean() | 0 | 1 | undefined}

rpbmodfun()

rpbmodfun() = #rpbmodfun{module = binary(), function = binary()}

rpbpair()

rpbpair() = #rpbpair{key = binary(), value = binary() | undefined}

rpbputreq()

rpbputreq() = #rpbputreq{bucket = binary(), key = binary() | undefined, vclock = binary() | undefined, content = #rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}, w = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, return_body = boolean() | 0 | 1 | undefined, pw = non_neg_integer() | undefined, if_not_modified = boolean() | 0 | 1 | undefined, if_none_match = boolean() | 0 | 1 | undefined, return_head = boolean() | 0 | 1 | undefined, timeout = non_neg_integer() | undefined, asis = boolean() | 0 | 1 | undefined, sloppy_quorum = boolean() | 0 | 1 | undefined, n_val = non_neg_integer() | undefined, type = binary() | undefined}

rpbputresp()

rpbputresp() = #rpbputresp{content = [#rpbcontent{value = binary(), content_type = binary() | undefined, charset = binary() | undefined, content_encoding = binary() | undefined, vtag = binary() | undefined, links = [#rpblink{bucket = binary() | undefined, key = binary() | undefined, tag = binary() | undefined}], last_mod = non_neg_integer() | undefined, last_mod_usecs = non_neg_integer() | undefined, usermeta = [#rpbpair{key = binary(), value = binary() | undefined}], indexes = [#rpbpair{key = binary(), value = binary() | undefined}], deleted = boolean() | 0 | 1 | undefined, ttl = non_neg_integer() | undefined}], vclock = binary() | undefined, key = binary() | undefined}

rpbresetbucketreq()

rpbresetbucketreq() = #rpbresetbucketreq{bucket = binary(), type = binary() | undefined}

rpbsetbucketreq()

rpbsetbucketreq() = #rpbsetbucketreq{bucket = binary(), props = #rpbbucketprops{n_val = non_neg_integer() | undefined, allow_mult = boolean() | 0 | 1 | undefined, last_write_wins = boolean() | 0 | 1 | undefined, precommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_precommit = boolean() | 0 | 1 | undefined, postcommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_postcommit = boolean() | 0 | 1 | undefined, chash_keyfun = #rpbmodfun{module = binary(), function = binary()} | undefined, linkfun = #rpbmodfun{module = binary(), function = binary()} | undefined, old_vclock = non_neg_integer() | undefined, young_vclock = non_neg_integer() | undefined, big_vclock = non_neg_integer() | undefined, small_vclock = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, r = non_neg_integer() | undefined, w = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, rw = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined, backend = binary() | undefined, search = boolean() | 0 | 1 | undefined, repl = 'FALSE' | 'REALTIME' | 'FULLSYNC' | 'TRUE' | integer() | undefined, search_index = binary() | undefined, datatype = binary() | undefined, consistent = boolean() | 0 | 1 | undefined, write_once = boolean() | 0 | 1 | undefined, hll_precision = non_neg_integer() | undefined, ttl = non_neg_integer() | undefined}, type = binary() | undefined}

rpbsetbuckettypereq()

rpbsetbuckettypereq() = #rpbsetbuckettypereq{type = binary(), props = #rpbbucketprops{n_val = non_neg_integer() | undefined, allow_mult = boolean() | 0 | 1 | undefined, last_write_wins = boolean() | 0 | 1 | undefined, precommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_precommit = boolean() | 0 | 1 | undefined, postcommit = [#rpbcommithook{modfun = #rpbmodfun{module = binary(), function = binary()} | undefined, name = binary() | undefined}], has_postcommit = boolean() | 0 | 1 | undefined, chash_keyfun = #rpbmodfun{module = binary(), function = binary()} | undefined, linkfun = #rpbmodfun{module = binary(), function = binary()} | undefined, old_vclock = non_neg_integer() | undefined, young_vclock = non_neg_integer() | undefined, big_vclock = non_neg_integer() | undefined, small_vclock = non_neg_integer() | undefined, pr = non_neg_integer() | undefined, r = non_neg_integer() | undefined, w = non_neg_integer() | undefined, pw = non_neg_integer() | undefined, dw = non_neg_integer() | undefined, rw = non_neg_integer() | undefined, basic_quorum = boolean() | 0 | 1 | undefined, notfound_ok = boolean() | 0 | 1 | undefined, backend = binary() | undefined, search = boolean() | 0 | 1 | undefined, repl = 'FALSE' | 'REALTIME' | 'FULLSYNC' | 'TRUE' | integer() | undefined, search_index = binary() | undefined, datatype = binary() | undefined, consistent = boolean() | 0 | 1 | undefined, write_once = boolean() | 0 | 1 | undefined, hll_precision = non_neg_integer() | undefined, ttl = non_neg_integer() | undefined}}

rpbsetclientidreq()

rpbsetclientidreq() = #rpbsetclientidreq{client_id = binary()}

Function Index

Function Details

'enum_symbol_by_value_RpbBucketProps.RpbReplMode'/1

'enum_symbol_by_value_RpbIndexReq.IndexQueryType'/1

'enum_value_by_symbol_RpbBucketProps.RpbReplMode'/1

'enum_value_by_symbol_RpbIndexReq.IndexQueryType'/1

decode/2

decode_msg/2

decode_msg/3

decode_rpbauthreq/1

decode_rpbbucketkeypreflistitem/1

decode_rpbbucketprops/1

decode_rpbcommithook/1

decode_rpbcontent/1

decode_rpbcountergetreq/1

decode_rpbcountergetresp/1

decode_rpbcounterupdatereq/1

decode_rpbcounterupdateresp/1

decode_rpbcoverageentry/1

decode_rpbcoveragereq/1

decode_rpbcoverageresp/1

decode_rpbcsbucketreq/1

decode_rpbcsbucketresp/1

decode_rpbdelreq/1

decode_rpberrorresp/1

decode_rpbgetbucketkeypreflistreq/1

decode_rpbgetbucketkeypreflistresp/1

decode_rpbgetbucketreq/1

decode_rpbgetbucketresp/1

decode_rpbgetbuckettypereq/1

decode_rpbgetclientidresp/1

decode_rpbgetreq/1

decode_rpbgetresp/1

decode_rpbgetserverinforesp/1

decode_rpbindexbodyresp/1

decode_rpbindexobject/1

decode_rpbindexreq/1

decode_rpbindexresp/1

decode_rpblink/1

decode_rpblistbucketsreq/1

decode_rpblistbucketsresp/1

decode_rpblistkeysreq/1

decode_rpblistkeysresp/1

decode_rpbmapredreq/1

decode_rpbmapredresp/1

decode_rpbmodfun/1

decode_rpbpair/1

decode_rpbputreq/1

decode_rpbputresp/1

decode_rpbresetbucketreq/1

decode_rpbsetbucketreq/1

decode_rpbsetbuckettypereq/1

decode_rpbsetclientidreq/1

encode/1

encode_msg/1

encode_msg/2

encode_rpbauthreq/1

encode_rpbbucketkeypreflistitem/1

encode_rpbbucketprops/1

encode_rpbcommithook/1

encode_rpbcontent/1

encode_rpbcountergetreq/1

encode_rpbcountergetresp/1

encode_rpbcounterupdatereq/1

encode_rpbcounterupdateresp/1

encode_rpbcoverageentry/1

encode_rpbcoveragereq/1

encode_rpbcoverageresp/1

encode_rpbcsbucketreq/1

encode_rpbcsbucketresp/1

encode_rpbdelreq/1

encode_rpberrorresp/1

encode_rpbgetbucketkeypreflistreq/1

encode_rpbgetbucketkeypreflistresp/1

encode_rpbgetbucketreq/1

encode_rpbgetbucketresp/1

encode_rpbgetbuckettypereq/1

encode_rpbgetclientidresp/1

encode_rpbgetreq/1

encode_rpbgetresp/1

encode_rpbgetserverinforesp/1

encode_rpbindexbodyresp/1

encode_rpbindexobject/1

encode_rpbindexreq/1

encode_rpbindexresp/1

encode_rpblink/1

encode_rpblistbucketsreq/1

encode_rpblistbucketsresp/1

encode_rpblistkeysreq/1

encode_rpblistkeysresp/1

encode_rpbmapredreq/1

encode_rpbmapredresp/1

encode_rpbmodfun/1

encode_rpbpair/1

encode_rpbputreq/1

encode_rpbputresp/1

encode_rpbresetbucketreq/1

encode_rpbsetbucketreq/1

encode_rpbsetbuckettypereq/1

encode_rpbsetclientidreq/1

enum_symbol_by_value/2

enum_value_by_symbol/2

fetch_enum_def/1

fetch_msg_def/1

fetch_rpc_def/2

find_enum_def/1

find_msg_def/1

find_rpc_def/2

get_enum_names/0

get_msg_defs/0

get_msg_names/0

get_package_name/0

get_rpc_names/1

get_service_def/1

get_service_names/0

gpb_version_as_list/0

gpb_version_as_string/0

merge_msgs/2

merge_msgs/3

verify_msg/1

verify_msg/2

Overview

Generated by EDoc