tablestore-ruby-sdk 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b784a1d0f57951fa5484ccb62cd715d87fdef19
+  data.tar.gz: 2ae0e59098a30d02ce793ad45bb93acd6c9c7dda
+SHA512:
+  metadata.gz: 6e1fbf83b244ccdcb443c6beda9523d4640b82c753ddd2303338fc826a38fece5ee44160d003d81dda7203ce79ffdbaa6d68437a943f4e117a2d234476ce675e
+  data.tar.gz: 4727b56252ca0a6f08ee4ad411d19d979e38305535448373fd77826131138344f11dbff5137a2d24028a5d848dfb10c26825055704d1e51ccf6ef5f9bcccacea

data/lib/consts.rb

@@ -0,0 +1,44 @@
+require 'os'
+
+HEADER = 0x75
+
+# tag type
+TAG_ROW_PK = 0x1
+TAG_ROW_DATA = 0x2
+TAG_CELL = 0x3
+TAG_CELL_NAME = 0x4
+TAG_CELL_VALUE = 0x5
+TAG_CELL_TYPE = 0x6
+TAG_CELL_TIMESTAMP = 0x7
+TAG_DELETE_ROW_MARKER = 0x8
+TAG_ROW_CHECKSUM = 0x9
+TAG_CELL_CHECKSUM = 0x0A
+
+# cell op type
+DELETE_ALL_VERSION = 0x1
+DELETE_ONE_VERSION = 0x3
+
+# variant 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
+
+# othber
+LITTLE_ENDIAN_32_SIZE = 4
+LITTLE_ENDIAN_64_SIZE = 8
+MAX_BUFFER_SIZE = 64 * 1024 * 1024
+
+SYS_BITS = OS.bits.to_i
+if SYS_BITS == 64
+  LITTLE_ENDIAN_SIZE = LITTLE_ENDIAN_64_SIZE
+else
+  LITTLE_ENDIAN_SIZE = LITTLE_ENDIAN_32_SIZE
+end
+
+

data/lib/protobuf/ots.proto

@@ -0,0 +1,374 @@
+package com.aliyun.tablestore.protocol;
+
+syntax = "proto3";
+
+message Error {
+     string code = 1;
+     string message = 2;
+}
+
+enum PrimaryKeyType {
+    NULL = 0;
+    INTEGER = 1;
+    STRING = 2;
+    BINARY = 3;
+}
+
+enum PrimaryKeyOption {
+    DEFAULT = 0;
+    AUTO_INCREMENT = 1;
+}
+
+message PrimaryKeySchema {
+     string name = 1;
+     PrimaryKeyType type = 2;
+     PrimaryKeyOption option = 3; 
+}
+
+message PartitionRange {
+     bytes begin = 1; // encoded as SQLVariant
+     bytes end = 2; // encoded as SQLVariant
+}
+
+message TableOptions {
+     int32 time_to_live = 1; // 可以动态更改
+     int32 max_versions = 2; // 可以动态更改
+     int64 deviation_cell_version_in_sec = 5; // 可以动态修改
+}
+
+message TableMeta {
+     string table_name = 1;
+    repeated PrimaryKeySchema primary_key = 2;
+}
+
+enum RowExistenceExpectation {
+    IGNORE = 0;
+    EXPECT_EXIST = 1;
+    EXPECT_NOT_EXIST = 2;
+}
+
+message Condition {
+     RowExistenceExpectation row_existence = 1;
+     bytes column_condition      = 2;
+}
+
+message CapacityUnit {
+     int32 read = 1;
+     int32 write = 2;
+}
+
+message ReservedThroughputDetails {
+     CapacityUnit capacity_unit = 1; // 表当前的预留吞吐量的值。
+     int64 last_increase_time = 2; // 最后一次上调预留吞吐量的时间。
+     int64 last_decrease_time = 3; // 最后一次下调预留吞吐量的时间。
+}
+
+message ReservedThroughput {
+     CapacityUnit capacity_unit = 1;
+}
+
+message ConsumedCapacity {
+     CapacityUnit capacity_unit = 1;
+}
+
+/* #############################################  CreateTable  ############################################# */
+/**
+ * table_meta用于存储表中不可更改的schema属性，可以更改的ReservedThroughput和TableOptions独立出来，作为UpdateTable的参数。
+ * 加入GlobalIndex和LocalIndex之后，结构会变为：
+ * message CreateTableRequest {
+ *          TableMeta table_meta = 1;
+ *          ReservedThroughput reserved_throughput = 2;
+ *          TableOptions table_options = 3;
+ *         repeated LocalIndex local_indexes = 4; // LocalIndex不再单独包含ReservedThroughput和TableOptions，其与主表共享配置。
+ *         repeated GlobalIndex global_indexes = 5; // GlobalIndex内单独包含ReservedThroughput和TableOptions
+ * }
+ */
+message CreateTableRequest {
+     TableMeta table_meta = 1;
+     ReservedThroughput reserved_throughput = 2; // 未放在TableOptions内，原因是UpdateTableResponse中会返回ReservedThroughputDetails，而TableOptions没有类似的返回结构。
+     TableOptions table_options = 3;
+    repeated PartitionRange partitions = 4;
+}
+
+message CreateTableResponse {
+}
+
+/* ######################################################################################################### */
+
+
+/* #############################################  UpdateTable  ############################################# */
+message UpdateTableRequest {
+     string table_name = 1;
+     ReservedThroughput reserved_throughput = 2;
+     TableOptions table_options = 3;
+}
+
+message UpdateTableResponse {
+     ReservedThroughputDetails reserved_throughput_details = 1;
+     TableOptions table_options = 2;
+}
+/* ######################################################################################################### */
+
+/* #############################################  DescribeTable  ############################################# */
+message DescribeTableRequest {
+     string table_name = 1;
+}
+
+message DescribeTableResponse {
+     TableMeta table_meta = 1;
+     ReservedThroughputDetails reserved_throughput_details = 2;
+     TableOptions table_options = 3;
+    repeated bytes shard_splits = 6;
+}
+/* ########################################################################################################### */
+
+/* #############################################  ListTable  ############################################# */
+message ListTableRequest {
+}
+
+/**
+ * 当前只返回一个简单的名称列表，需要讨论是否有业务场景需要获取除了表名之外的其他信息。
+ * 其他信息可以包含预留吞吐量以及表的状态，这个信息只能是一个粗略的信息，表的详细信息还是需要通过DescribeTable来获取。
+ */
+message ListTableResponse {
+    repeated string table_names = 1;
+}
+/* ####################################################################################################### */
+
+/* #############################################  DeleteTable  ############################################# */
+message DeleteTableRequest {
+     string table_name = 1;
+}
+
+message DeleteTableResponse {
+}
+/* ######################################################################################################### */
+
+/* #############################################  LoadTable  ############################################# */
+message LoadTableRequest {
+     string table_name = 1;
+}
+
+message LoadTableResponse {
+}
+/* ######################################################################################################### */
+
+/* #############################################  UnloadTable  ############################################# */
+message UnloadTableRequest {
+     string table_name = 1;
+}
+
+message UnloadTableResponse {
+
+}
+/* ########################################################################################################## */
+
+/**
+ * 时间戳的取值最小值为0，最大值为INT64.MAX
+ * 1. 若要查询一个范围，则指定start_time和end_time
+ * 2. 若要查询一个特定时间戳，则指定specific_time
+ */
+message TimeRange {
+     int64 start_time = 1;
+     int64 end_time = 2;
+     int64 specific_time = 3;
+}
+
+/* #############################################  GetRow  ############################################# */
+
+enum ReturnType {
+    RT_NONE = 0;
+    RT_PK = 1;
+}
+
+message ReturnContent {
+     ReturnType return_type = 1;
+}
+
+/**
+ * 1. 支持用户指定版本时间戳范围或者特定的版本时间来读取指定版本的列
+ * 2. 目前暂不支持行内的断点
+ */
+message GetRowRequest {
+     string table_name = 1;
+     bytes primary_key = 2; // encoded as InplaceRowChangeSet, but only has primary key
+    repeated string columns_to_get = 3; // 不指定则读出所有的列
+     TimeRange time_range = 4;
+     int32 max_versions = 5;
+     bytes filter = 7;
+     string start_column = 8;
+     string end_column = 9;
+     bytes token = 10;
+}
+
+message GetRowResponse {
+     ConsumedCapacity consumed = 1;
+     bytes row = 2; // encoded as InplaceRowChangeSet
+     bytes next_token = 3;
+}
+/* #################################################################################################### */
+
+/* #############################################  UpdateRow  ############################################# */
+message UpdateRowRequest {
+     string table_name = 1;
+     bytes row_change = 2;
+     Condition condition = 3;
+     ReturnContent return_content = 4;
+}
+
+message UpdateRowResponse {
+     ConsumedCapacity consumed = 1;
+     bytes row = 2;
+}
+/* ####################################################################################################### */
+
+/* #############################################  PutRow  ############################################# */
+
+
+/**
+ * 这里允许用户为每列单独设置timestamp，而不是强制整行统一一个timestamp。
+ * 原因是列都是用统一的结构，该结构本身是带timestamp的，其次强制统一timestamp增强了规范性但是丧失了灵活性，且该规范性没有明显的好处，反而带来了结构的复杂。
+ */
+message PutRowRequest {
+     string table_name = 1;
+     bytes row = 2; // encoded as InplaceRowChangeSet
+     Condition condition = 3;
+     ReturnContent return_content = 4;
+}
+
+message PutRowResponse {
+     ConsumedCapacity consumed = 1;
+     bytes row = 2; // encoded as InplaceRowChangeSet
+}
+/* #################################################################################################### */
+
+/* #############################################  DeleteRow  ############################################# */
+/**
+ * OTS只支持删除该行的所有列所有版本，不支持：
+ *  1. 删除所有列的所有小于等于某个版本的所有版本
+ */
+message DeleteRowRequest {
+     string table_name = 1;
+     bytes primary_key = 2; // encoded as InplaceRowChangeSet, but only has primary key
+     Condition condition = 3;
+     ReturnContent return_content = 4;
+}
+
+message DeleteRowResponse {
+     ConsumedCapacity consumed = 1;
+     bytes row = 2;
+}
+/* ####################################################################################################### */
+
+/* #############################################  BatchGetRow  ############################################# */
+message TableInBatchGetRowRequest {
+     string table_name = 1;
+    repeated bytes primary_key = 2; // encoded as InplaceRowChangeSet, but only has primary key
+    repeated bytes token = 3;
+    repeated string columns_to_get = 4;  // 不指定则读出所有的列
+     TimeRange time_range = 5;
+     int32 max_versions = 6;
+     bytes filter = 8;
+     string start_column = 9;
+     string end_column = 10;
+}
+
+message BatchGetRowRequest {
+    repeated TableInBatchGetRowRequest tables = 1;
+}
+
+message RowInBatchGetRowResponse {
+     bool is_ok = 1;
+     Error error = 2;
+     ConsumedCapacity consumed = 3;
+     bytes row = 4; // encoded as InplaceRowChangeSet
+     bytes next_token = 5;
+}
+
+message TableInBatchGetRowResponse {
+     string table_name = 1;
+    repeated RowInBatchGetRowResponse rows = 2;
+}
+
+message BatchGetRowResponse {
+    repeated TableInBatchGetRowResponse tables = 1;
+}
+/* ######################################################################################################### */
+
+/* #############################################  BatchWriteRow  ############################################# */
+
+enum OperationType {
+    POST = 0;
+    PUT = 1;
+    UPDATE = 2;
+    DELETE = 3;
+}
+
+message RowInBatchWriteRowRequest {
+     OperationType type = 1;
+     bytes row_change = 2; // encoded as InplaceRowChangeSet
+     Condition condition = 3;
+     ReturnContent return_content = 4;
+}
+
+message TableInBatchWriteRowRequest {
+     string table_name = 1;
+    repeated RowInBatchWriteRowRequest rows = 2;
+}
+
+message BatchWriteRowRequest {
+    repeated TableInBatchWriteRowRequest tables = 1;
+}
+
+message RowInBatchWriteRowResponse {
+     bool is_ok = 1;
+     Error error = 2;
+     ConsumedCapacity consumed = 3;
+     bytes row = 4; // encoded as InplaceRowChangeSet
+}
+
+message TableInBatchWriteRowResponse {
+     string table_name = 1;
+    repeated RowInBatchWriteRowResponse rows = 2;
+}
+
+message BatchWriteRowResponse {
+    repeated TableInBatchWriteRowResponse tables = 1;
+}
+/* ########################################################################################################### */
+
+/* #############################################  GetRange  ############################################# */
+enum Direction {
+    FORWARD = 0;
+    BACKWARD = 1;
+}
+
+/**
+ * HBase支持以下参数：
+ *     1. TimeRange或指定time
+ *     2. Filter（根据列值或列名来过滤）
+ * 我们只支持给同版本的选择条件。
+ */
+message GetRangeRequest {
+     string table_name = 1;
+     Direction direction = 2;
+    repeated string columns_to_get = 3;  // 不指定则读出所有的列
+     TimeRange time_range = 4;
+     int32 max_versions = 5;
+     int32 limit = 6;
+     bytes inclusive_start_primary_key = 7; // encoded as InplaceRowChangeSet, but only has primary key
+     bytes exclusive_end_primary_key = 8; // encoded as InplaceRowChangeSet, but only has primary key
+     bytes filter = 10;
+     string start_column = 11;
+     string end_column = 12;
+     bytes token = 13;
+}
+
+message GetRangeResponse {
+     ConsumedCapacity consumed = 1;
+     bytes rows = 2; // encoded as InplaceRowChangeSet
+     bytes next_start_primary_key = 3; // 若为空，则代表数据全部读取完毕. encoded as InplaceRowChangeSet, but only has primary key
+     bytes next_token = 4;
+}
+/* ###################################################################################################### */
+

data/lib/protobuf/ots_filiter.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+enum FilterType {
+    FT_DEFAULT = 0;
+    FT_SINGLE_COLUMN_VALUE = 1;
+    FT_COMPOSITE_COLUMN_VALUE = 2;
+    FT_COLUMN_PAGINATION = 3;
+}
+
+enum ComparatorType {
+    CT_DEFAULT                  = 0;
+    CT_EQUAL                    = 1;
+    CT_NOT_EQUAL                = 2;
+    CT_GREATER_THAN             = 3;
+    CT_GREATER_EQUAL            = 4;
+    CT_LESS_THAN                = 5;
+    CT_LESS_EQUAL               = 6;
+}
+
+message SingleColumnValueFilter {
+     ComparatorType comparator     = 1;
+     string column_name        = 2;
+     bytes column_value        = 3; // Serialized SQLVariant
+     bool filter_if_missing        = 4;
+     bool latest_version_only      = 5;
+}
+
+enum LogicalOperator {
+    LO_DEFAULT                  = 0;
+    LO_NOT                      = 1;
+    LO_AND                      = 2;
+    LO_OR                       = 3;
+}
+
+message CompositeColumnValueFilter {
+    LogicalOperator combinator    = 1;
+    repeated Filter sub_filters            = 2;
+}
+
+message ColumnPaginationFilter {
+     int32 offset = 1;
+     int32 limit = 2;
+}
+
+message Filter {
+     FilterType type    = 1;
+     bytes filter       = 2;  // Serialized string of filter of the type
+}