Riak Protocol Buffers Messages
This repository contains the message definitions for the Protocol Buffers-based interface to Riak and various Erlang-specific utility modules for the message types.
This is distributed separately from the Riak server and clients,
allowing it to serve as an independent representation of the supported
messages. Additionally, the
.proto descriptions are broken out by
riak.protocontains "global" messages like the error message and the "server info" calls.
riak_kv.protocontains messages related to Riak KV.
Other specifications may arise as more features are exposed via the PB interface.
The Riak PBC protocol encodes requests and responses as Protocol Buffers messages. Each request message results in one or more response messages. As message type and length are not encoded by PB, they are sent on the wire as:
<length:32> <msg_code:8> <pbmsg>
lengthis the length of
msg_code(1 byte) plus the message length in bytes encoded in network order (big endian).
msg_codeindicates what is encoded as
pbmsgis the encoded protocol buffer message
On connect, the client can make requests and will receive responses. For each request message there is a corresponding response message, or the server will respond with an error message if something has gone wrong.
The client should be prepared to handle messages without any
length == 1) for requests where the response is simply an
In some cases, a client may receive multiple response messages for a
single request. The response message will typically include a boolean
done field that signifies the last message in a sequence.
Registered Message Codes
Generally, you should not need to modify this repository unless you
are adding new client-facing features to Riak or fixing a
bug. Nevertheless, we encourage contributions to
riak_pb from the
- Fork the
riak_pbrepository on Github.
Clone your fork or add the remote if you already have a clone of the repository.
git clone firstname.lastname@example.org:yourusername/riak_pb.git # or git remote add mine email@example.com:yourusername/riak_pb.git
Create a topic branch for your change.
git checkout -b some-topic-branch
Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed.
Push to your fork of the repository and then send a pull-request through Github.
git push mine some-topic-branch
A Basho engineer or community maintainer will review your patch and merge it into the main repository or send you feedback.