src/proto/voldemort-client.proto

   1 // Please use protoc version 2.3.0 to recompile:
   2 //   https://code.google.com/p/protobuf/downloads/detail?name=protobuf-2.3.0.tar.gz&can=2&q=
   3 // Use commmand like the below to recompile:
   4 // $ protoc -I=src/proto --java_out=src/java src/proto/voldemort-client.proto
   5
   6 package voldemort;
   7
   8 option java_package = "voldemort.client.protocol.pb";
   9 option java_outer_classname = "VProto";
  10 option optimize_for = SPEED;
  11
  12 message ClockEntry {
  13   required int32 node_id = 1;
  14   required int64 version = 2;
  15 }
  16
  17 message VectorClock {
  18   repeated ClockEntry entries = 1;
  19   optional int64 timestamp = 2;
  20 }
  21
  22 message Versioned {
  23   required bytes value = 1;
  24   required VectorClock version = 2;
  25 }
  26
  27 message Error {
  28   required int32 error_code = 1;
  29   required string error_message = 2;
  30 }
  31
  32 message KeyedVersions {
  33   required bytes key = 1;
  34   repeated Versioned versions = 2;
  35 }
  36
  37 message GetRequest {
  38   optional bytes key = 1;
  39   optional bytes transforms = 2;
  40 }
  41
  42 message GetResponse {
  43   repeated Versioned versioned = 1;
  44   optional Error error = 2;
  45 }
  46
  47 message GetVersionResponse {
  48   repeated VectorClock versions = 1;
  49   optional Error error = 2;
  50 }
  51
  52 message GetAllRequest {
  53   repeated bytes keys = 1;
  54
  55   message GetAllTransform {
  56     required bytes key = 1;
  57     required bytes transform = 2;
  58   }
  59   repeated GetAllTransform transforms = 2;
  60 }
  61
  62 message GetAllResponse {
  63   repeated KeyedVersions values = 1;
  64   optional Error error = 2;
  65 }
  66
  67 message PutRequest {
  68   required bytes key = 1;
  69   required Versioned versioned = 2;
  70   optional bytes transforms = 3;
  71 }
  72
  73 message PutResponse {
  74   optional Error error = 1;
  75 }
  76
  77 message DeleteRequest {
  78   required bytes key = 1;
  79   required VectorClock version = 2;
  80 }
  81
  82 message DeleteResponse {
  83   required bool success = 1;
  84   optional Error error = 2;
  85 }
  86
  87 enum RequestType {
  88   GET = 0;
  89   GET_ALL = 1;
  90   PUT = 2;
  91   DELETE = 3;
  92   GET_VERSION = 4;
  93 }
  94
  95
  96 message VoldemortRequest {
  97   required RequestType type = 1;
  98   required bool should_route = 2 [default = false];
  99   required string store = 3;
 100   optional GetRequest get = 4;
 101   optional GetAllRequest getAll = 5;
 102   optional PutRequest put = 6;
 103   optional DeleteRequest delete = 7;
 104   optional int32 requestRouteType = 8;
 105 }