@alicloud/ots2/spec/PlainBuffer.md

OTS(2015-12-31) client for Node.js(ES6)

因为 Protocol Buffer 序列化和解析小对象的性能很差，所以 OTS 自定义了 PlainBuffer 数据格式用来表示行数据。

## 格式定义

```
plainbuffer = tag_header row1  [row2]  [row3]
row = ( pk [attr] | [pk] attr | pk attr ) [tag_delete_marker] row_checksum;
pk = tag_pk cell_1 [cell_2] [cell_3]
attr  = tag_attr cell1 [cell_2] [cell_3]
cell = tag_cell cell_name [cell_value] [cell_op] [cell_ts] cell_checksum
cell_name = tag_cell_name  formated_value
cell_value = tag_cell_value formated_value
cell_op = tag_cell_op  cell_op_value
cell_ts = tag_cell_ts cell_ts_value
row_checksum = tag_row_checksum row_crc8
cell_checksum = tag_cell_checksum row_crc8
formated_value = value_type value_len value_data
value_type = int8
value_len = int32
cell_op_value = delete_all_version | delete_one_version
cell_ts_value = int64
delete_all_version = 0x01 (1byte)
delete_one_version = 0x03 (1byte)
```

## Tag取值

```
tag_header = 0x75 (4byte)
tag_pk = 0x01 (1byte)
tag_attr = 0x02 (1byte)
tag_cell = 0x03 (1byte)
tag_cell_name = 0x04 (1byte)
tag_cell_value = 0x05 (1byte)
tag_cell_op = 0x06 (1byte)
tag_cell_ts = 0x07 (1byte)
tag_delete_marker = 0x08 (1byte)
tag_row_checksum = 0x09 (1byte)
tag_cell_checksum = 0x0A (1byte)
```

## ValueType 取值

formated_value 中 value_type 的取值如下：

```
VT_INTEGER = 0x0
VT_DOUBLE = 0x1
VT_BOOLEAN = 0x2
VT_STRING = 0x3
VT_NULL = 0x6
VT_BLOB = 0x7
VT_INF_MIN = 0x9
VT_INF_MAX = 0xa
VT_AUTO_INCREMENT = 0xb
```

## 计算 Checksum

计算 checksum 的基本逻辑是：

针对每个 cell 的 name/value/type/timestamp 计算。
针对 row 里面的 delete 计算，其中有 delete mark 补单字节1；若没有，补单字节0。
因为对每个 cell 计算了 checksum,所以计算 row 的 checksum 的时候直接利用 cell 的checksum 来计算, 即 row 的 crc 只对 cell 的 checksum 做 crc, 不对数据做 crc。
C++实现：

```cpp
void GetChecksum(uint8_t* crc, const InplaceCell& cell)
{
    Crc8(crc, cell.GetName());
    Crc8(crc, cell.GetValue().GetInternalSlice());
    Crc8(crc, cell.GetTimestamp());
    Crc8(crc, cell.GetOpType());
}
void GetChecksum(uint8_t* crc, const InplaceRow& row)
{
    const std::deque<InplaceCell>& pk = row.GetPrimaryKey();
    for (size_t i = 0; i < pk.size(); i++) {
        uint8_t* cellcrc;
        *cellcrc = 0;
        GetChecksum(cellcrc, pk[i]);
        Crc8(crc, *cellcrc);
    }
    for (int i = 0; i < row.GetCellCount(); i++) {
        uint8_t* cellcrc;
        *cellcrc = 0;
        GetChecksum(cellcrc, row.GetCell(i));
        Crc8(crc, *cellcrc);
    }
    uint8_t del = 0;
    if (row.HasDeleteMarker()) {
        del = 1;
    }
    Crc8(crc, del);
}
```

## 举例

假设一行数据有两列主键，4 列数据。其中主键类型为 string 和 integer，3 列数据中分别是 string、integer 和 double，版本分别是 1001、1002 和 1003，还有一列是删除所有版本。

主键列：
[pk1:string:iampk]
[pk2:integer:100]
属性列：
[column1:string:bad:1001]
[column2:integer:128:1002]
[column3:double:34.2:1003]
[column4:del_all_versions]
编码：

```
    <Header开始>[0x75]
    <主键列开始>[0x1]
        <Cell1>[0x3][0x4][3][pk1][0x5][3][5][iampk]
        <Cell2>[0x3][0x4][3][pk2][0x5][0][100]
    <属性列开始>[0x2]
        <Cell1>[0x3][0x4][7][column1][0x5][0x3][3][bad][0x7][1001]
        <Cell2>[0x3][0x4][7][column2][0x5][0x0][128][0x7][1002]
        <Cell3>[0x3][0x4][7][column3][0x5][0x1][34.2][0x7][1003]
        <Cell4>[0x3][0x4][7][column4][0x5][0x6][1]
```