hbase-protocol-shaded/src/main/protobuf/Cell.proto

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 syntax = "proto2";
  19 // Cell and KeyValue protos
  20 package hbase.pb;
  21
  22 option java_package = "org.apache.hadoop.hbase.shaded.protobuf.generated";
  23 option java_outer_classname = "CellProtos";
  24 option java_generate_equals_and_hash = true;
  25 option optimize_for = SPEED;
  26
  27 /**
  28  * The type of the key in a Cell
  29  */
  30 enum CellType {
  31     MINIMUM = 0;
  32     PUT = 4;
  33
  34     DELETE = 8;
  35     DELETE_FAMILY_VERSION = 10;
  36     DELETE_COLUMN = 12;
  37     DELETE_FAMILY = 14;
  38
  39     // MAXIMUM is used when searching; you look from maximum on down.
  40     MAXIMUM = 255;
  41 }
  42
  43 /**
  44  * Protocol buffer version of Cell.
  45  */
  46 message Cell {
  47   optional bytes row = 1;
  48   optional bytes family = 2;
  49   optional bytes qualifier = 3;
  50   optional uint64 timestamp = 4;
  51   optional CellType cell_type = 5;
  52   optional bytes value = 6;
  53   optional bytes tags = 7;
  54 }
  55
  56 /**
  57  * Protocol buffer version of KeyValue.
  58  * It doesn't have those transient parameters
  59  */
  60 message KeyValue {
  61   required bytes row = 1;
  62   required bytes family = 2;
  63   required bytes qualifier = 3;
  64   optional uint64 timestamp = 4;
  65   optional CellType key_type = 5;
  66   optional bytes value = 6;
  67   optional bytes tags = 7;
  68 }