Default package

Get desktop application:
View/edit binary Protocol Buffers messages

An operation to update a Counter, either on its own or inside a Map. The `increment` field can be positive or negative. When absent, the meaning is an increment by 1.

Used in: DtOp, MapUpdate

• optional sint64 increment = 1

The equivalent of KV's "RpbGetReq", results in a DtFetchResp. The request-time options are limited to ones that are relevant to structured data-types.

• required bytes bucket = 1

  The identifier: bucket, key and bucket-type

• required bytes key = 2

• required bytes type = 3

• optional uint32 r = 4

  Request options

• optional uint32 pr = 5

• optional bool basic_quorum = 6

• optional bool notfound_ok = 7

• optional uint32 timeout = 8

• optional bool sloppy_quorum = 9

  Experimental, may change/disappear

• optional uint32 n_val = 10

  Experimental, may change/disappear

• optional bool include_context = 11

  For read-only requests or context-free operations, you can set this to false to reduce the size of the response payload.

• optional uint32 node_confirms = 12

  Distinct phycical node quorum

The response to a "Fetch" request. If the `include_context` option is specified, an opaque "context" value will be returned along with the user-friendly data. When sending an "Update" request, the client should send this context as well, similar to how one would send a vclock for KV updates. The `type` field indicates which value type to expect. When the `value` field is missing from the message, the client should interpret it as a "not found".

• optional bytes context = 1

• required DtFetchResp.DataType type = 2

• optional DtValue value = 3

Used in: DtFetchResp

• COUNTER = 1

• SET = 2

• MAP = 3

• HLL = 4

• GSET = 5

A "union" type for update operations. The included operation depends on the datatype being updated.

Used in: DtUpdateReq

• optional CounterOp counter_op = 1

• optional SetOp set_op = 2

• optional MapOp map_op = 3

• optional HllOp hll_op = 4

  Adding values to a hyperloglog (set) is just like adding values to a set.

• optional GSetOp gset_op = 5

The equivalent of KV's "RpbPutReq", results in an empty response or "DtUpdateResp" if `return_body` is specified, or the key is assigned by the server. The request-time options are limited to ones that are relevant to structured data-types.

• required bytes bucket = 1

  The identifier

• optional bytes key = 2

  missing key results in server-assigned key, like KV

• required bytes type = 3

  bucket type, not data-type (but the data-type is constrained per bucket-type)

• optional bytes context = 4

  Opaque update-context

• required DtOp op = 5

  The operations

• optional uint32 w = 6

  Request options

• optional uint32 dw = 7

• optional uint32 pw = 8

• optional bool return_body = 9

• optional uint32 timeout = 10

• optional bool sloppy_quorum = 11

  Experimental, may change/disappear

• optional uint32 n_val = 12

  Experimental, may change/disappear

• optional bool include_context = 13

  When return_body is true, should the context be returned too?

• optional uint32 node_confirms = 14

  Distinct phycical node quorum

The equivalent of KV's "RpbPutResp", contains the assigned key if it was assigned by the server, and the resulting value and context if return_body was set.

• optional bytes key = 1

  The key, if assigned by the server

• optional bytes context = 2

  The opaque update context and value, if return_body was set.

• optional sint64 counter_value = 3

• repeated bytes set_value = 4

• repeated MapEntry map_value = 5

• optional uint64 hll_value = 6

• repeated bytes gset_value = 7

The value of the fetched data type. If present in the response, then empty values (sets, maps) should be treated as such.

Used in: DtFetchResp

• optional sint64 counter_value = 1

• repeated bytes set_value = 2

• repeated MapEntry map_value = 3

• optional uint64 hll_value = 4

  We return an estimated cardinality of the Hyperloglog set on fetch.

• repeated bytes gset_value = 5

An operation to update a GSet, on its own. GSet members are opaque binary values, you can only add them to a Set.

Used in: DtOp

• repeated bytes adds = 1

An operation to update a Hyperloglog Set, a top-level DT. You can only add to a HllSet.

Used in: DtOp

• repeated bytes adds = 1

An entry in a map is a pair of a field-name and value. The type defined in the field determines which value type is expected.

Used in: DtUpdateResp, DtValue

• required MapField field = 1

• optional sint64 counter_value = 2

• repeated bytes set_value = 3

• optional bytes register_value = 4

• optional bool flag_value = 5

• repeated MapEntry map_value = 6

Field names in maps are composed of a binary identifier and a type. This is so that two clients can create fields with the same name but different types, and they converge independently.

Used in: MapEntry, MapOp, MapUpdate

• required bytes name = 1

• required MapField.MapFieldType type = 2

The types that can be stored in a map are limited to counters, sets, registers, flags, and maps.

Used in: MapField

• COUNTER = 1

• SET = 2

• REGISTER = 3

• FLAG = 4

• MAP = 5

An operation to update a Map. All operations apply to individual fields in the Map.

Used in: DtOp, MapUpdate

• repeated MapField removes = 1

  REMOVE removes a field and value from the Map. UPDATE applies type-specific operations to the values stored in the Map.

• repeated MapUpdate updates = 2

An operation to be applied to a value stored in a Map -- the contents of an UPDATE operation. The operation field that is present depends on the type of the field to which it is applied.

Used in: MapOp

• required MapField field = 1

• optional CounterOp counter_op = 2

• optional SetOp set_op = 3

• optional bytes register_op = 4

  There is only one operation on a register, which is to set its value, therefore the "operation" is the new value.

• optional MapUpdate.FlagOp flag_op = 5

• optional MapOp map_op = 6

Flags only exist inside Maps and can only be enabled or disabled, and there are no arguments to the operations.

Used in: MapUpdate

• ENABLE = 1

• DISABLE = 2

Used in: RpbAaeFoldListBucketsResp

• optional bytes type = 1

• required bytes bucket = 2

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool segment_filter = 30

• repeated uint32 id_filter = 31

• optional RpbAaeFoldEraseKeysReq.RpbTreeSize filter_tree_size = 32

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• required RpbAaeFoldEraseKeysReq.ChangeMethod change_method = 50

• optional uint32 job_id = 51

Used in: RpbAaeFoldEraseKeysReq

• job = 0

• local = 1

• count = 2

Used in: RpbAaeFoldEraseKeysReq

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

• required uint32 n_val = 1

• repeated uint32 id_filter = 2

• optional bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool segment_filter = 30

• repeated uint32 id_filter = 31

• optional RpbAaeFoldFetchClocksRangeReq.RpbTreeSize filter_tree_size = 32

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

Used in: RpbAaeFoldFetchClocksRangeReq

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• required RpbAaeFoldFindKeysReq.FindType finder = 50

• required uint32 find_limit = 51

Used in: RpbAaeFoldFindKeysReq

• sibling_count = 0

• object_size = 1

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool segment_filter = 30

• repeated uint32 id_filter = 31

• optional RpbAaeFoldFindTombsReq.RpbTreeSize filter_tree_size = 32

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

Used in: RpbAaeFoldFindTombsReq

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

• required bytes response_type = 1

• repeated RpbKeysCount keys_count = 2

• required bytes response_type = 1

• repeated RpbKeysValue keys_value = 2

• optional uint32 n_val = 1

• repeated RpbAaeFoldBucket bucket_list = 1

• required uint32 n_val = 1

• repeated uint32 id_filter = 2

AAE Fold requests

• required uint32 n_val = 1

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required RpbAaeFoldMergeTreesRangeReq.RpbTreeSize tree_size = 20

• required bool segment_filter = 30

• repeated uint32 id_filter = 31

• optional RpbAaeFoldMergeTreesRangeReq.RpbTreeSize filter_tree_size = 32

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• required bool use_prehash = 50

• optional uint32 init_vector = 51

Used in: RpbAaeFoldMergeTreesRangeReq

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool segment_filter = 30

• repeated uint32 id_filter = 31

• optional RpbAaeFoldReapTombsReq.RpbTreeSize filter_tree_size = 32

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• required RpbAaeFoldReapTombsReq.ChangeMethod change_method = 50

• optional uint32 job_id = 51

Used in: RpbAaeFoldReapTombsReq

• job = 0

• local = 1

• count = 2

Used in: RpbAaeFoldReapTombsReq

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• optional bytes type = 1

• required bytes bucket = 2

• required bool key_range = 10

• optional bytes start_key = 11

• optional bytes end_key = 12

• required bool modified_range = 40

• optional uint32 last_mod_start = 41

• optional uint32 last_mod_end = 42

• required bytes queuename = 50

• required RpbAaeFoldTreeResp.RpbTreeSize size = 1

• optional bytes level_one = 2

• repeated bytes level_two = 3

Used in: RpbAaeFoldTreeResp

• xxsmall = 0

• xsmall = 1

• small = 2

• medium = 3

• large = 4

• xlarge = 5

Authentication request

• required bytes user = 1

• required bytes password = 2

Preflist item

Used in: RpbGetBucketKeyPreflistResp

• required int64 partition = 1

• required bytes node = 2

• required bool primary = 3

Bucket properties

Used in: RpbGetBucketResp, RpbSetBucketReq, RpbSetBucketTypeReq

• 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

• optional bytes search_index = 25

  Search index

• optional bytes datatype = 26

  KV Datatypes

• optional bool consistent = 27

  KV strong consistency

• optional bool write_once = 28

  KV fast path

• optional uint32 hll_precision = 29

  Hyperlolog DT Precision

Used by riak_repl bucket fixup

Used in: RpbBucketProps

• FALSE = 0

• REALTIME = 1

• FULLSYNC = 2

• TRUE = 3

added solely for riak_cs currently for folding over a bucket and returning objects.

• required bytes bucket = 1

• required bytes start_key = 2

• optional bytes end_key = 3

• optional bool start_incl = 4

• optional bool end_incl = 5

• optional bytes continuation = 6

• optional uint32 max_results = 7

• optional uint32 timeout = 8

• optional bytes type = 9

  Bucket type, if not set we assume the 'default' type

• optional bytes cover_context = 10

  parallel extraction extension

  chopped up coverage plan per-req

return for CS bucket fold

• repeated RpbIndexObject objects = 1

• optional bytes continuation = 2

• optional bool done = 3

An IP Port representing the API address of a cluster member

Used in: RpbMembershipResp

• required bytes ip = 1

• required uint32 port = 2

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

counter value

• 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 uint32 node_confirms = 7

  Distinct phycical node quorum

Counter value response

• optional sint64 value = 1

Counter update request

• required bytes bucket = 1

• required bytes key = 2

• required sint64 amount = 3

• optional uint32 w = 4

• optional uint32 dw = 5

• optional uint32 pw = 6

• optional bool returnvalue = 7

• optional uint32 node_confirms = 8

  Distinct phycical node quorum

Counter update response? No message | error response

• optional sint64 value = 1

Segment of a coverage plan

Used in: RpbCoverageResp

• required bytes ip = 1

• required uint32 port = 2

• optional bytes keyspace_desc = 3

  Some human readable description of the keyspace covered

• required bytes cover_context = 4

  Opaque context to pass into 2I query.

Request a segmented coverage plan for the specified bucket

• optional bytes type = 1

  Bucket type, if not set we assume the 'default' type

• required bytes bucket = 2

• optional uint32 min_partitions = 3

  If undefined, we build a normal coverage plan. If <ring_size, we build a coverage plan with exactly ring_size entries, anything larger will have a power of 2 entries covering keyspaces smaller than a partition

• optional bytes replace_cover = 4

  For failure recovery

• repeated bytes unavailable_cover = 5

  Other coverage contexts that have failed to assist Riak in deciding what nodes to avoid

Segmented coverage plan response

• repeated RpbCoverageEntry entries = 1

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

• optional bool sloppy_quorum = 11

  Experimental, may change/disappear

• optional uint32 n_val = 12

  Experimental, may change/disappear

• optional bytes type = 13

  Bucket type, if not set we assume the 'default' type

Error response - may be generated for any Req

• required bytes errmsg = 1

• required uint32 errcode = 2

Fetch request - retrieve an object by a queue name.

• required bytes queuename = 1

• optional bytes encoding = 2

Fetch response - may be an empty queue, an object, a deleted tombstone If it is a deleted tombstone, it will return both an encoded_object and a deleted vclock. If the response is an object, just an encoded_object will be returned

• required bool queue_empty = 1

• optional bool deleted = 2

  Present only if queue_empty is false, true if object a tombstone

• optional uint32 crc_check = 3

  CRC check of encoded object

• optional bytes replencoded_object = 4

  Special repl encoding using for object

• optional bytes deleted_vclock = 5

• optional uint32 segment_id = 6

• optional uint32 segment_hash = 7

Get bucket-key preflist request

• required bytes bucket = 1

• required bytes key = 2

• optional bytes type = 3

Get bucket-key preflist response

• repeated RpbBucketKeyPreflistItem preflist = 1

Get bucket properties request

• required bytes bucket = 1

• optional bytes type = 2

Get bucket properties response

• required RpbBucketProps props = 1

Get bucket properties request

• required bytes type = 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

• optional bool sloppy_quorum = 11

  Experimental, may change/disappear

• optional uint32 n_val = 12

  Experimental, may change/disappear

• optional bytes type = 13

  Bucket type, if not set we assume the 'default' type

• optional uint32 node_confirms = 14

  Distinct phycical node quorum

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

Used in: RpbIndexObject

• 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

Stolen from CS bucket response, to be used when return_body=true

• repeated RpbIndexObject objects = 1

• optional bytes continuation = 2

• optional bool done = 3

Used in: RpbCSBucketResp, RpbIndexBodyResp

• required bytes key = 1

• required RpbGetResp object = 2

Secondary Index query request

• required bytes bucket = 1

• required bytes index = 2

• required RpbIndexReq.IndexQueryType qtype = 3

• optional bytes key = 4

  key here means equals value for index?

• optional bytes range_min = 5

• optional bytes range_max = 6

• optional bool return_terms = 7

• optional bool stream = 8

• optional uint32 max_results = 9

• optional bytes continuation = 10

• optional uint32 timeout = 11

• optional bytes type = 12

  Bucket type, if not set we assume the 'default' type

• optional bytes term_regex = 13

• optional bool pagination_sort = 14

  Whether to use pagination sort for non-paginated queries

• optional bytes cover_context = 15

  parallel extraction extension

  chopped up coverage plan per-req

• optional bool return_body = 16

  Return values with keys, only works with $bucket/$key index queries

Used in: RpbIndexReq

• eq = 0

• range = 1

Secondary Index query response

• repeated bytes keys = 1

• repeated RpbPair results = 2

• optional bytes continuation = 3

• optional bool done = 4

Used in: RpbAaeFoldKeyCountResp

• required bytes tag = 1

• optional uint32 order = 2

• required uint32 count = 3

Used in: RpbAaeFoldKeyValueResp, RpbPushReq

• optional bytes type = 1

• required bytes bucket = 2

• required bytes key = 3

• required bytes value = 4

Link metadata

Used in: RpbContent

• optional bytes bucket = 1

• optional bytes key = 2

• optional bytes tag = 3

List buckets request

• optional uint32 timeout = 1

• optional bool stream = 2

• optional bytes type = 3

  Bucket type, if not set we assume the 'default' type

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

• repeated bytes buckets = 1

• optional bool done = 2

List keys in bucket request

• required bytes bucket = 1

• optional uint32 timeout = 2

• optional bytes type = 3

  Bucket type, if not set we assume the 'default' type

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

Request a member of a cluster return the API addresses of other members

• optional bytes queuename = 1

• repeated RpbClusterMemberEntry up_nodes = 1

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, RpbIndexResp, RpbSearchDoc, TsInterpolation

• required bytes key = 1

• optional bytes value = 2

Push request - queue a list of keys for replication if at a given clock.

• required bytes queuename = 1

• repeated RpbKeysValue keys_value = 2

• optional bytes queuename = 1

• required bool queue_exists = 2

• optional uint32 foldq_length = 10

• optional uint32 fsync_length = 11

• optional uint32 realt_length = 12

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

• optional bool sloppy_quorum = 14

  Experimental, may change/disappear

• optional uint32 n_val = 15

  Experimental, may change/disappear

• optional bytes type = 16

  Bucket type, if not set we assume the 'default' type

• optional uint32 node_confirms = 17

  Distinct phycical node quorum

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

RT Enqueue Request - retrieve bucket/key and pop it on the RTQ NOTE: this is just a GET request minus some meaningless (in this context) options

• 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 uint32 timeout = 10

• optional bool sloppy_quorum = 11

  Experimental, may change/disappear

• optional uint32 n_val = 12

  Experimental, may change/disappear

• optional bytes type = 13

  Bucket type, if not set we assume the 'default' type

Reset bucket properties request

• required bytes bucket = 1

• optional bytes type = 2

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

• optional bytes type = 3

Set bucket properties request

• required bytes type = 1

• required RpbBucketProps props = 2

• required bytes client_id = 1

  Client id to use for this connection

Used in: RpbYokozunaIndexGetResp, RpbYokozunaIndexPutReq

• required bytes name = 1

  Index name

• optional bytes schema = 2

  Schema name

• optional uint32 n_val = 3

  N value

DELETE request - Remove an index

• required bytes name = 1

  Index name

GET request - If a name is given, return matching index, else return all

• optional bytes name = 1

  Index name

• repeated RpbYokozunaIndex index = 1

PUT request - Create a new index

• required RpbYokozunaIndex index = 1

• optional uint32 timeout = 2

  Timeout value

Used in: RpbYokozunaSchemaGetResp, RpbYokozunaSchemaPutReq

• required bytes name = 1

  Index name

• optional bytes content = 2

  Schema data

GET request - Return matching schema by name

• required bytes name = 1

  Schema name

• required RpbYokozunaSchema schema = 1

PUT request - create or potentially update a new schema

• required RpbYokozunaSchema schema = 1

An operation to update a Set, either on its own or inside a Map. Set members are opaque binary values, you can only add or remove them from a Set.

Used in: DtOp, MapUpdate

• repeated bytes adds = 1

• repeated bytes removes = 2

Used in: TsDelReq, TsGetReq, TsRow

• optional bytes varchar_value = 1

• optional sint64 sint64_value = 2

• optional sint64 timestamp_value = 3

• optional bool boolean_value = 4

• optional double double_value = 5

Used in: TsGetResp, TsPutReq, TsQueryResp

• required bytes name = 1

• optional TsColumnType type = 2

Used in: TsColumnDescription

• VARCHAR = 0

• SINT64 = 1

• DOUBLE = 2

• TIMESTAMP = 3

• BOOLEAN = 4

Segment of a TS coverage plan

Used in: TsCoverageResp

• required bytes ip = 1

• required uint32 port = 2

• required bytes cover_context = 3

  Opaque context to pass into follow-up request

• optional TsRange range = 4

  Might be other types of coverage queries/responses

Request a segmented coverage plan for this query

• optional TsInterpolation query = 1

  left optional to support parameterized queries in the future

• required bytes table = 2

• optional bytes replace_cover = 3

  For failure recovery

• repeated bytes unavailable_cover = 4

  Other coverage contexts that have failed to assist Riak in deciding what nodes to avoid

Segmented TS coverage plan response

• repeated TsCoverageEntry entries = 1

• required bytes table = 1

• repeated TsCell key = 2

• optional bytes vclock = 3

• optional uint32 timeout = 4

(message has no fields)

• required bytes table = 1

• repeated TsCell key = 2

• optional uint32 timeout = 3

• repeated TsColumnDescription columns = 1

• repeated TsRow rows = 2

  0 or 1 rows

Used in: TsCoverageReq, TsQueryReq

• required bytes base = 1

• repeated RpbPair interpolations = 2

• required bytes table = 1

• optional uint32 timeout = 2

• repeated TsRow keys = 1

• optional bool done = 2

• required bytes table = 1

• repeated TsColumnDescription columns = 2

  optional: omitting it should use table order

• repeated TsRow rows = 3

(message has no fields)

Dispatch a query to Riak

• optional TsInterpolation query = 1

  left optional to support parameterized queries in the future

• optional bool stream = 2

• optional bytes cover_context = 3

  chopped up coverage plan per-req

• repeated TsColumnDescription columns = 1

• repeated TsRow rows = 2

  0 to n rows

• optional bool done = 3

Each prospective subquery has a range of valid time values

Used in: TsCoverageEntry

• required bytes field_name = 1

• required sint64 lower_bound = 2

• required bool lower_bound_inclusive = 3

• required sint64 upper_bound = 4

• required bool upper_bound_inclusive = 5

• required bytes desc = 6

  Some human readable description of the time range

Used in: TsGetResp, TsListKeysResp, TsPutReq, TsQueryResp

• repeated TsCell cells = 1