Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Bucket properties

Used in: RpbGetBucketResp, RpbSetBucketReq

• optional uint32 n_val = 1

  Declared in riak_core_app

• optional bool allow_mult = 2

• optional bool last_write_wins = 3

• repeated RpbCommitHook precommit = 4

• optional bool has_precommit = 5

• repeated RpbCommitHook postcommit = 6

• optional bool has_postcommit = 7

• optional RpbModFun chash_keyfun = 8

• optional RpbModFun linkfun = 9

  Declared in riak_kv_app

• optional uint32 old_vclock = 10

• optional uint32 young_vclock = 11

• optional uint32 big_vclock = 12

• optional uint32 small_vclock = 13

• optional uint32 pr = 14

• optional uint32 r = 15

• optional uint32 w = 16

• optional uint32 pw = 17

• optional uint32 dw = 18

• optional uint32 rw = 19

• optional bool basic_quorum = 20

• optional bool notfound_ok = 21

• optional bytes backend = 22

  Used by riak_kv_multi_backend

• optional bool search = 23

  Used by riak_search bucket fixup

• optional RpbBucketProps.RpbReplMode repl = 24

Used by riak_repl bucket fixup

Used in: RpbBucketProps

• FALSE = 0

• REALTIME = 1

• FULLSYNC = 2

• TRUE = 3

A commit hook, which may either be a modfun or a JavaScript named function

Used in: RpbBucketProps

• optional RpbModFun modfun = 1

• optional bytes name = 2

Content message included in get/put responses Holds the value and associated metadata

Used in: RpbGetResp, RpbPutReq, RpbPutResp

• required bytes value = 1

• optional bytes content_type = 2

  the media type/format

• optional bytes charset = 3

• optional bytes content_encoding = 4

• optional bytes vtag = 5

• repeated RpbLink links = 6

  links to other resources

• optional uint32 last_mod = 7

• optional uint32 last_mod_usecs = 8

• repeated RpbPair usermeta = 9

  user metadata stored with the object

• repeated RpbPair indexes = 10

  user metadata stored with the object

• optional bool deleted = 11

Delete request

• required bytes bucket = 1

• required bytes key = 2

• optional uint32 rw = 3

• optional bytes vclock = 4

• optional uint32 r = 5

• optional uint32 w = 6

• optional uint32 pr = 7

• optional uint32 pw = 8

• optional uint32 dw = 9

• optional uint32 timeout = 10

Error response - may be generated for any Req

• required bytes errmsg = 1

• required uint32 errcode = 2

Get bucket properties request

• required bytes bucket = 1

Get bucket properties response

• required RpbBucketProps props = 1

Get ClientId Request - no message defined, just send RpbGetClientIdReq message code

• required bytes client_id = 1

  Client id in use for this connection

Get Request - retrieve bucket/key

• required bytes bucket = 1

• required bytes key = 2

• optional uint32 r = 3

• optional uint32 pr = 4

• optional bool basic_quorum = 5

• optional bool notfound_ok = 6

• optional bytes if_modified = 7

  fail if the supplied vclock does not match

• optional bool head = 8

  return everything but the value

• optional bool deletedvclock = 9

  return the tombstone's vclock, if applicable

• optional uint32 timeout = 10

Get Response - if the record was not found there will be no content/vclock

• repeated RpbContent content = 1

• optional bytes vclock = 2

  the opaque vector clock for the object

• optional bool unchanged = 3

Get server info request - no message defined, just send RpbGetServerInfoReq message code

• optional bytes node = 1

• optional bytes server_version = 2

Secondary Index query request

• required bytes bucket = 1

• required bytes index = 2

• required RpbIndexReq.IndexQueryType qtype = 3

• optional bytes key = 4

• optional bytes range_min = 5

• optional bytes range_max = 6

Used in: RpbIndexReq

• eq = 0

• range = 1

Secondary Index query response

• repeated bytes keys = 1

Link metadata

Used in: RpbContent

• optional bytes bucket = 1

• optional bytes key = 2

• optional bytes tag = 3

List buckets response

• repeated bytes buckets = 1

List keys in bucket request

• required bytes bucket = 1

List keys in bucket response - one or more of these packets will be sent the last one will have done set true (and may not have any keys in it)

• repeated bytes keys = 1

• optional bool done = 2

Map/Reduce request

• required bytes request = 1

• required bytes content_type = 2

Map/Reduce response one or more of these packets will be sent the last one will have done set true (and may not have phase/data in it)

• optional uint32 phase = 1

• optional bytes response = 2

• optional bool done = 3

Module-Function pairs for commit hooks and other bucket properties that take functions

Used in: RpbBucketProps, RpbCommitHook

• required bytes module = 1

• required bytes function = 2

Key/value pair - used for user metadata, indexes, search doc fields

Used in: RpbContent, RpbSearchDoc

• required bytes key = 1

• optional bytes value = 2

Put request - if options.return_body is set then the updated metadata/data for the key will be returned.

• required bytes bucket = 1

• optional bytes key = 2

• optional bytes vclock = 3

• required RpbContent content = 4

• optional uint32 w = 5

• optional uint32 dw = 6

• optional bool return_body = 7

• optional uint32 pw = 8

• optional bool if_not_modified = 9

• optional bool if_none_match = 10

• optional bool return_head = 11

• optional uint32 timeout = 12

• optional bool asis = 13

Put response - same as get response with optional key if one was generated

• repeated RpbContent content = 1

• optional bytes vclock = 2

  the opaque vector clock for the object

• optional bytes key = 3

  the key generated, if any

Reset bucket properties request

• required bytes bucket = 1

Used in: RpbSearchQueryResp

• repeated RpbPair fields = 1

• required bytes q = 1

  Query string

• required bytes index = 2

  Index

• optional uint32 rows = 3

  Limit rows

• optional uint32 start = 4

  Starting offset

• optional bytes sort = 5

  Sort order

• optional bytes filter = 6

  Inline fields filtering query

• optional bytes df = 7

  Default field

• optional bytes op = 8

  Default op

• repeated bytes fl = 9

  Return fields limit (for ids only, generally)

• optional bytes presort = 10

  Presort (key / score)

• repeated RpbSearchDoc docs = 1

  Result documents

• optional float max_score = 2

  Maximum score

• optional uint32 num_found = 3

  Number of results

Set bucket properties request

• required bytes bucket = 1

• required RpbBucketProps props = 2

• required bytes client_id = 1

  Client id to use for this connection