tablestore-ruby-sdk 0.0.0 → 0.0.1

data/lib/protobuf/{ots.proto → table_store.proto}

@@ -1,43 +1,37 @@
-package com.aliyun.tablestore.protocol;
-
-syntax = "proto3";
-
 message Error {
-     string code = 1;
-     string message = 2;
+    required string code = 1;
+    optional 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; 
+    required string name = 1;
+    required PrimaryKeyType type = 2;
+    optional PrimaryKeyOption option = 3;
 }
 
 message PartitionRange {
-     bytes begin = 1; // encoded as SQLVariant
-     bytes end = 2; // encoded as SQLVariant
+    required bytes begin = 1; // encoded as SQLVariant
+    required bytes end = 2; // encoded as SQLVariant
 }
 
 message TableOptions {
-     int32 time_to_live = 1; // 可以动态更改
-     int32 max_versions = 2; // 可以动态更改
-     int64 deviation_cell_version_in_sec = 5; // 可以动态修改
+    optional int32 time_to_live = 1; // 可以动态更改
+    optional int32 max_versions = 2; // 可以动态更改
+    optional int64 deviation_cell_version_in_sec = 5; // 可以动态修改
 }
 
 message TableMeta {
-     string table_name = 1;
+    required string table_name = 1;
     repeated PrimaryKeySchema primary_key = 2;
 }
 
@@ -48,27 +42,27 @@ enum RowExistenceExpectation {
 }
 
 message Condition {
-     RowExistenceExpectation row_existence = 1;
-     bytes column_condition      = 2;
+    required RowExistenceExpectation row_existence = 1;
+    optional bytes column_condition      = 2;
 }
 
 message CapacityUnit {
-     int32 read = 1;
-     int32 write = 2;
+    optional int32 read = 1;
+    optional int32 write = 2;
 }
 
 message ReservedThroughputDetails {
-     CapacityUnit capacity_unit = 1; // 表当前的预留吞吐量的值。
-     int64 last_increase_time = 2; // 最后一次上调预留吞吐量的时间。
-     int64 last_decrease_time = 3; // 最后一次下调预留吞吐量的时间。
+    required CapacityUnit capacity_unit = 1; // 表当前的预留吞吐量的值。
+    required int64 last_increase_time = 2; // 最后一次上调预留吞吐量的时间。
+    optional int64 last_decrease_time = 3; // 最后一次下调预留吞吐量的时间。
 }
 
 message ReservedThroughput {
-     CapacityUnit capacity_unit = 1;
+    required CapacityUnit capacity_unit = 1;
 }
 
 message ConsumedCapacity {
-     CapacityUnit capacity_unit = 1;
+    required CapacityUnit capacity_unit = 1;
 }
 
 /* #############################################  CreateTable  ############################################# */
@@ -76,17 +70,17 @@ message ConsumedCapacity {
  * table_meta用于存储表中不可更改的schema属性，可以更改的ReservedThroughput和TableOptions独立出来，作为UpdateTable的参数。
  * 加入GlobalIndex和LocalIndex之后，结构会变为：
  * message CreateTableRequest {
- *          TableMeta table_meta = 1;
- *          ReservedThroughput reserved_throughput = 2;
- *          TableOptions table_options = 3;
+ *         required TableMeta table_meta = 1;
+ *         required ReservedThroughput reserved_throughput = 2;
+ *         required 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;
+    required TableMeta table_meta = 1;
+    required ReservedThroughput reserved_throughput = 2; // 未放在TableOptions内，原因是UpdateTableResponse中会返回ReservedThroughputDetails，而TableOptions没有类似的返回结构。
+    optional TableOptions table_options = 3;
     repeated PartitionRange partitions = 4;
 }
 
@@ -98,26 +92,26 @@ message CreateTableResponse {
 
 /* #############################################  UpdateTable  ############################################# */
 message UpdateTableRequest {
-     string table_name = 1;
-     ReservedThroughput reserved_throughput = 2;
-     TableOptions table_options = 3;
+    required string table_name = 1;
+    optional ReservedThroughput reserved_throughput = 2;
+    optional TableOptions table_options = 3;
 }
 
 message UpdateTableResponse {
-     ReservedThroughputDetails reserved_throughput_details = 1;
-     TableOptions table_options = 2;
+    required ReservedThroughputDetails reserved_throughput_details = 1;
+    required TableOptions table_options = 2;
 }
 /* ######################################################################################################### */
 
 /* #############################################  DescribeTable  ############################################# */
 message DescribeTableRequest {
-     string table_name = 1;
+    required string table_name = 1;
 }
 
 message DescribeTableResponse {
-     TableMeta table_meta = 1;
-     ReservedThroughputDetails reserved_throughput_details = 2;
-     TableOptions table_options = 3;
+    required TableMeta table_meta = 1;
+    required ReservedThroughputDetails reserved_throughput_details = 2;
+    required TableOptions table_options = 3;
     repeated bytes shard_splits = 6;
 }
 /* ########################################################################################################### */
@@ -137,7 +131,7 @@ message ListTableResponse {
 
 /* #############################################  DeleteTable  ############################################# */
 message DeleteTableRequest {
-     string table_name = 1;
+    required string table_name = 1;
 }
 
 message DeleteTableResponse {
@@ -146,7 +140,7 @@ message DeleteTableResponse {
 
 /* #############################################  LoadTable  ############################################# */
 message LoadTableRequest {
-     string table_name = 1;
+    required string table_name = 1;
 }
 
 message LoadTableResponse {
@@ -155,7 +149,7 @@ message LoadTableResponse {
 
 /* #############################################  UnloadTable  ############################################# */
 message UnloadTableRequest {
-     string table_name = 1;
+    required string table_name = 1;
 }
 
 message UnloadTableResponse {
@@ -169,9 +163,9 @@ message UnloadTableResponse {
  * 2. 若要查询一个特定时间戳，则指定specific_time
  */
 message TimeRange {
-     int64 start_time = 1;
-     int64 end_time = 2;
-     int64 specific_time = 3;
+    optional int64 start_time = 1;
+    optional int64 end_time = 2;
+    optional int64 specific_time = 3;
 }
 
 /* #############################################  GetRow  ############################################# */
@@ -182,7 +176,7 @@ enum ReturnType {
 }
 
 message ReturnContent {
-     ReturnType return_type = 1;
+    optional ReturnType return_type = 1;
 }
 
 /**
@@ -190,35 +184,35 @@ message ReturnContent {
  * 2. 目前暂不支持行内的断点
  */
 message GetRowRequest {
-     string table_name = 1;
-     bytes primary_key = 2; // encoded as InplaceRowChangeSet, but only has primary key
+    required string table_name = 1;
+    required 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;
+    optional TimeRange time_range = 4;
+    optional int32 max_versions = 5;
+    optional bytes filter = 7;
+    optional string start_column = 8;
+    optional string end_column = 9;
+    optional bytes token = 10;
 }
 
 message GetRowResponse {
-     ConsumedCapacity consumed = 1;
-     bytes row = 2; // encoded as InplaceRowChangeSet
-     bytes next_token = 3;
+    required ConsumedCapacity consumed = 1;
+    required bytes row = 2; // encoded as InplaceRowChangeSet
+    optional bytes next_token = 3;
 }
 /* #################################################################################################### */
 
 /* #############################################  UpdateRow  ############################################# */
 message UpdateRowRequest {
-     string table_name = 1;
-     bytes row_change = 2;
-     Condition condition = 3;
-     ReturnContent return_content = 4;
+    required string table_name = 1;
+    required bytes row_change = 2;
+    required Condition condition = 3;
+    optional ReturnContent return_content = 4;
 }
 
 message UpdateRowResponse {
-     ConsumedCapacity consumed = 1;
-     bytes row = 2;
+    required ConsumedCapacity consumed = 1;
+    optional bytes row = 2;
 }
 /* ####################################################################################################### */
 
@@ -230,15 +224,15 @@ message UpdateRowResponse {
  * 原因是列都是用统一的结构，该结构本身是带timestamp的，其次强制统一timestamp增强了规范性但是丧失了灵活性，且该规范性没有明显的好处，反而带来了结构的复杂。
  */
 message PutRowRequest {
-     string table_name = 1;
-     bytes row = 2; // encoded as InplaceRowChangeSet
-     Condition condition = 3;
-     ReturnContent return_content = 4;
+    required string table_name = 1;
+    required bytes row = 2; // encoded as InplaceRowChangeSet
+    required Condition condition = 3;
+    optional ReturnContent return_content = 4;
 }
 
 message PutRowResponse {
-     ConsumedCapacity consumed = 1;
-     bytes row = 2; // encoded as InplaceRowChangeSet
+    required ConsumedCapacity consumed = 1;
+    optional bytes row = 2; // encoded as InplaceRowChangeSet
 }
 /* #################################################################################################### */
 
@@ -248,29 +242,29 @@ message PutRowResponse {
  *  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;
+    required string table_name = 1;
+    required bytes primary_key = 2; // encoded as InplaceRowChangeSet, but only has primary key
+    required Condition condition = 3;
+    optional ReturnContent return_content = 4;
 }
 
 message DeleteRowResponse {
-     ConsumedCapacity consumed = 1;
-     bytes row = 2;
+    required ConsumedCapacity consumed = 1;
+    optional bytes row = 2;
 }
 /* ####################################################################################################### */
 
 /* #############################################  BatchGetRow  ############################################# */
 message TableInBatchGetRowRequest {
-     string table_name = 1;
+    required 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;
+    optional TimeRange time_range = 5;
+    optional int32 max_versions = 6;
+    optional bytes filter = 8;
+    optional string start_column = 9;
+    optional string end_column = 10;
 }
 
 message BatchGetRowRequest {
@@ -278,15 +272,15 @@ message BatchGetRowRequest {
 }
 
 message RowInBatchGetRowResponse {
-     bool is_ok = 1;
-     Error error = 2;
-     ConsumedCapacity consumed = 3;
-     bytes row = 4; // encoded as InplaceRowChangeSet
-     bytes next_token = 5;
+    required bool is_ok = 1;
+    optional Error error = 2;
+    optional ConsumedCapacity consumed = 3;
+    optional bytes row = 4; // encoded as InplaceRowChangeSet
+    optional bytes next_token = 5;
 }
 
 message TableInBatchGetRowResponse {
-     string table_name = 1;
+    required string table_name = 1;
     repeated RowInBatchGetRowResponse rows = 2;
 }
 
@@ -298,21 +292,20 @@ message BatchGetRowResponse {
 /* #############################################  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;
+    required OperationType type = 1;
+    required bytes row_change = 2; // encoded as InplaceRowChangeSet
+    required Condition condition = 3;
+    optional ReturnContent return_content = 4;
 }
 
 message TableInBatchWriteRowRequest {
-     string table_name = 1;
+    required string table_name = 1;
     repeated RowInBatchWriteRowRequest rows = 2;
 }
 
@@ -321,14 +314,14 @@ message BatchWriteRowRequest {
 }
 
 message RowInBatchWriteRowResponse {
-     bool is_ok = 1;
-     Error error = 2;
-     ConsumedCapacity consumed = 3;
-     bytes row = 4; // encoded as InplaceRowChangeSet
+    required bool is_ok = 1;
+    optional Error error = 2;
+    optional ConsumedCapacity consumed = 3;
+    optional bytes row = 4; // encoded as InplaceRowChangeSet
 }
 
 message TableInBatchWriteRowResponse {
-     string table_name = 1;
+    required string table_name = 1;
     repeated RowInBatchWriteRowResponse rows = 2;
 }
 
@@ -350,25 +343,25 @@ enum Direction {
  * 我们只支持给同版本的选择条件。
  */
 message GetRangeRequest {
-     string table_name = 1;
-     Direction direction = 2;
+    required string table_name = 1;
+    required 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;
+    optional TimeRange time_range = 4;
+    optional int32 max_versions = 5;
+    optional int32 limit = 6;
+    required bytes inclusive_start_primary_key = 7; // encoded as InplaceRowChangeSet, but only has primary key
+    required bytes exclusive_end_primary_key = 8; // encoded as InplaceRowChangeSet, but only has primary key
+    optional bytes filter = 10;
+    optional string start_column = 11;
+    optional string end_column = 12;
+    optional 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;
+    required ConsumedCapacity consumed = 1;
+    required bytes rows = 2; // encoded as InplaceRowChangeSet
+    optional bytes next_start_primary_key = 3; // 若为空，则代表数据全部读取完毕. encoded as InplaceRowChangeSet, but only has primary key
+    optional bytes next_token = 4;
 }
 /* ###################################################################################################### */
 

data/lib/protobuf/table_store_filiter.pb.rb

@@ -0,0 +1,96 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: table_store_filiter.proto>
+# 
+# enum FilterType {
+#     FT_SINGLE_COLUMN_VALUE = 1;
+#     FT_COMPOSITE_COLUMN_VALUE = 2;
+#     FT_COLUMN_PAGINATION = 3;
+# }
+# 
+# enum ComparatorType {
+#     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 {
+#     required ComparatorType comparator     = 1;
+#     required string column_name        = 2;
+#     required bytes column_value        = 3; // Serialized SQLVariant
+#     required bool filter_if_missing        = 4;
+#     required bool latest_version_only      = 5;
+# }
+# 
+# enum LogicalOperator {
+#     LO_NOT                      = 1;
+#     LO_AND                      = 2;
+#     LO_OR                       = 3;
+# }
+# 
+# message CompositeColumnValueFilter {
+#     required LogicalOperator combinator    = 1;
+#     repeated Filter sub_filters            = 2;
+# }
+# 
+# message ColumnPaginationFilter {
+#     required int32 offset = 1;
+#     required int32 limit = 2;
+# }
+# 
+# message Filter {
+#     required FilterType type    = 1;
+#     required bytes filter       = 2;  // Serialized string of filter of the type
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class FilterType < ::Protobuf::Enum
+  defined_in __FILE__
+  FT_SINGLE_COLUMN_VALUE = value(:FT_SINGLE_COLUMN_VALUE, 1)
+  FT_COMPOSITE_COLUMN_VALUE = value(:FT_COMPOSITE_COLUMN_VALUE, 2)
+  FT_COLUMN_PAGINATION = value(:FT_COLUMN_PAGINATION, 3)
+end
+class ComparatorType < ::Protobuf::Enum
+  defined_in __FILE__
+  CT_EQUAL = value(:CT_EQUAL, 1)
+  CT_NOT_EQUAL = value(:CT_NOT_EQUAL, 2)
+  CT_GREATER_THAN = value(:CT_GREATER_THAN, 3)
+  CT_GREATER_EQUAL = value(:CT_GREATER_EQUAL, 4)
+  CT_LESS_THAN = value(:CT_LESS_THAN, 5)
+  CT_LESS_EQUAL = value(:CT_LESS_EQUAL, 6)
+end
+class SingleColumnValueFilter < ::Protobuf::Message
+  defined_in __FILE__
+  required :ComparatorType, :comparator, 1
+  required :string, :column_name, 2
+  required :bytes, :column_value, 3
+  required :bool, :filter_if_missing, 4
+  required :bool, :latest_version_only, 5
+end
+class LogicalOperator < ::Protobuf::Enum
+  defined_in __FILE__
+  LO_NOT = value(:LO_NOT, 1)
+  LO_AND = value(:LO_AND, 2)
+  LO_OR = value(:LO_OR, 3)
+end
+class CompositeColumnValueFilter < ::Protobuf::Message
+  defined_in __FILE__
+  required :LogicalOperator, :combinator, 1
+  repeated :Filter, :sub_filters, 2
+end
+class ColumnPaginationFilter < ::Protobuf::Message
+  defined_in __FILE__
+  required :int32, :offset, 1
+  required :int32, :limit, 2
+end
+class Filter < ::Protobuf::Message
+  defined_in __FILE__
+  required :FilterType, :type, 1
+  required :bytes, :filter, 2
+end