tablestore-ruby-sdk 0.0.0

data/lib/protobuf/ots_filiter_pb.rb

@@ -0,0 +1,55 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: ots_filiter.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "SingleColumnValueFilter" do
+    optional :comparator, :enum, 1, "ComparatorType"
+    optional :column_name, :string, 2
+    optional :column_value, :bytes, 3
+    optional :filter_if_missing, :bool, 4
+    optional :latest_version_only, :bool, 5
+  end
+  add_message "CompositeColumnValueFilter" do
+    optional :combinator, :enum, 1, "LogicalOperator"
+    repeated :sub_filters, :message, 2, "Filter"
+  end
+  add_message "ColumnPaginationFilter" do
+    optional :offset, :int32, 1
+    optional :limit, :int32, 2
+  end
+  add_message "Filter" do
+    optional :type, :enum, 1, "FilterType"
+    optional :filter, :bytes, 2
+  end
+  add_enum "FilterType" do
+    value :FT_DEFAULT, 0
+    value :FT_SINGLE_COLUMN_VALUE, 1
+    value :FT_COMPOSITE_COLUMN_VALUE, 2
+    value :FT_COLUMN_PAGINATION, 3
+  end
+  add_enum "ComparatorType" do
+    value :CT_DEFAULT, 0
+    value :CT_EQUAL, 1
+    value :CT_NOT_EQUAL, 2
+    value :CT_GREATER_THAN, 3
+    value :CT_GREATER_EQUAL, 4
+    value :CT_LESS_THAN, 5
+    value :CT_LESS_EQUAL, 6
+  end
+  add_enum "LogicalOperator" do
+    value :LO_DEFAULT, 0
+    value :LO_NOT, 1
+    value :LO_AND, 2
+    value :LO_OR, 3
+  end
+end
+
+SingleColumnValueFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("SingleColumnValueFilter").msgclass
+CompositeColumnValueFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("CompositeColumnValueFilter").msgclass
+ColumnPaginationFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("ColumnPaginationFilter").msgclass
+Filter = Google::Protobuf::DescriptorPool.generated_pool.lookup("Filter").msgclass
+FilterType = Google::Protobuf::DescriptorPool.generated_pool.lookup("FilterType").enummodule
+ComparatorType = Google::Protobuf::DescriptorPool.generated_pool.lookup("ComparatorType").enummodule
+LogicalOperator = Google::Protobuf::DescriptorPool.generated_pool.lookup("LogicalOperator").enummodule

data/lib/protobuf/ots_pb.rb

@@ -0,0 +1,307 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: ots.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "Error" do
+    optional :code, :string, 1
+    optional :message, :string, 2
+  end
+  add_message "PrimaryKeySchema" do
+    optional :name, :string, 1
+    optional :type, :enum, 2, "PrimaryKeyType"
+    optional :option, :enum, 3, "PrimaryKeyOption"
+  end
+  add_message "PartitionRange" do
+    optional :begin, :bytes, 1
+    optional :end, :bytes, 2
+  end
+  add_message "TableOptions" do
+    optional :time_to_live, :int32, 1
+    optional :max_versions, :int32, 2
+    optional :deviation_cell_version_in_sec, :int64, 5
+  end
+  add_message "TableMeta" do
+    optional :table_name, :string, 1
+    repeated :primary_key, :message, 2, "PrimaryKeySchema"
+  end
+  add_message "Condition" do
+    optional :row_existence, :enum, 1, "RowExistenceExpectation"
+    optional :column_condition, :bytes, 2
+  end
+  add_message "CapacityUnit" do
+    optional :read, :int32, 1
+    optional :write, :int32, 2
+  end
+  add_message "ReservedThroughputDetails" do
+    optional :capacity_unit, :message, 1, "CapacityUnit"
+    optional :last_increase_time, :int64, 2
+    optional :last_decrease_time, :int64, 3
+  end
+  add_message "ReservedThroughput" do
+    optional :capacity_unit, :message, 1, "CapacityUnit"
+  end
+  add_message "ConsumedCapacity" do
+    optional :capacity_unit, :message, 1, "CapacityUnit"
+  end
+  add_message "CreateTableRequest" do
+    optional :table_meta, :message, 1, "TableMeta"
+    optional :reserved_throughput, :message, 2, "ReservedThroughput"
+    optional :table_options, :message, 3, "TableOptions"
+    repeated :partitions, :message, 4, "PartitionRange"
+  end
+  add_message "CreateTableResponse" do
+  end
+  add_message "UpdateTableRequest" do
+    optional :table_name, :string, 1
+    optional :reserved_throughput, :message, 2, "ReservedThroughput"
+    optional :table_options, :message, 3, "TableOptions"
+  end
+  add_message "UpdateTableResponse" do
+    optional :reserved_throughput_details, :message, 1, "ReservedThroughputDetails"
+    optional :table_options, :message, 2, "TableOptions"
+  end
+  add_message "DescribeTableRequest" do
+    optional :table_name, :string, 1
+  end
+  add_message "DescribeTableResponse" do
+    optional :table_meta, :message, 1, "TableMeta"
+    optional :reserved_throughput_details, :message, 2, "ReservedThroughputDetails"
+    optional :table_options, :message, 3, "TableOptions"
+    optional :shard_splits, :bytes, 6
+  end
+  add_message "ListTableRequest" do
+  end
+  add_message "ListTableResponse" do
+    repeated :table_names, :string, 1
+  end
+  add_message "DeleteTableRequest" do
+    optional :table_name, :string, 1
+  end
+  add_message "DeleteTableResponse" do
+  end
+  add_message "LoadTableRequest" do
+    optional :table_name, :string, 1
+  end
+  add_message "LoadTableResponse" do
+  end
+  add_message "UnloadTableRequest" do
+    optional :table_name, :string, 1
+  end
+  add_message "UnloadTableResponse" do
+  end
+  add_message "TimeRange" do
+    optional :start_time, :int64, 1
+    optional :end_time, :int64, 2
+    optional :specific_time, :int64, 3
+  end
+  add_message "ReturnContent" do
+    optional :return_type, :enum, 1, "ReturnType"
+  end
+  add_message "GetRowRequest" do
+    optional :table_name, :string, 1
+    optional :primary_key, :bytes, 2
+    repeated :columns_to_get, :string, 3
+    optional :time_range, :message, 4, "TimeRange"
+    optional :max_versions, :int32, 5
+    optional :filter, :bytes, 7
+    optional :start_column, :string, 8
+    optional :end_column, :string, 9
+    optional :token, :bytes, 10
+  end
+  add_message "GetRowResponse" do
+    optional :consumed, :message, 1, "ConsumedCapacity"
+    optional :row, :bytes, 2
+    optional :next_token, :bytes, 3
+  end
+  add_message "UpdateRowRequest" do
+    optional :table_name, :string, 1
+    optional :row_change, :bytes, 2
+    optional :condition, :message, 3, "Condition"
+    optional :return_content, :message, 4, "ReturnContent"
+  end
+  add_message "UpdateRowResponse" do
+    optional :consumed, :message, 1, "ConsumedCapacity"
+    optional :row, :bytes, 2
+  end
+  add_message "PutRowRequest" do
+    optional :table_name, :string, 1
+    optional :row, :bytes, 2
+    optional :condition, :message, 3, "Condition"
+    optional :return_content, :message, 4, "ReturnContent"
+  end
+  add_message "PutRowResponse" do
+    optional :consumed, :message, 1, "ConsumedCapacity"
+    optional :row, :bytes, 2
+  end
+  add_message "DeleteRowRequest" do
+    optional :table_name, :string, 1
+    optional :primary_key, :bytes, 2
+    optional :condition, :message, 3, "Condition"
+    optional :return_content, :message, 4, "ReturnContent"
+  end
+  add_message "DeleteRowResponse" do
+    optional :consumed, :message, 1, "ConsumedCapacity"
+    optional :row, :bytes, 2
+  end
+  add_message "TableInBatchGetRowRequest" do
+    optional :table_name, :string, 1
+    repeated :primary_key, :bytes, 2
+    repeated :token, :bytes, 3
+    repeated :columns_to_get, :string, 4
+    optional :time_range, :message, 5, "TimeRange"
+    optional :max_versions, :int32, 6
+    optional :filter, :bytes, 8
+    optional :start_column, :string, 9
+    optional :end_column, :string, 10
+  end
+  add_message "BatchGetRowRequest" do
+    repeated :tables, :message, 1, "TableInBatchGetRowRequest"
+  end
+  add_message "RowInBatchGetRowResponse" do
+    optional :is_ok, :bool, 1
+    optional :error, :message, 2, "Error"
+    optional :consumed, :message, 3, "ConsumedCapacity"
+    optional :row, :bytes, 4
+    optional :next_token, :bytes, 5
+  end
+  add_message "TableInBatchGetRowResponse" do
+    optional :table_name, :string, 1
+    repeated :rows, :message, 2, "RowInBatchGetRowResponse"
+  end
+  add_message "BatchGetRowResponse" do
+    repeated :tables, :message, 1, "TableInBatchGetRowResponse"
+  end
+  add_message "RowInBatchWriteRowRequest" do
+    optional :type, :enum, 1, "OperationType"
+    optional :row_change, :bytes, 2
+    optional :condition, :message, 3, "Condition"
+    optional :return_content, :message, 4, "ReturnContent"
+  end
+  add_message "TableInBatchWriteRowRequest" do
+    optional :table_name, :string, 1
+    repeated :rows, :message, 2, "RowInBatchWriteRowRequest"
+  end
+  add_message "BatchWriteRowRequest" do
+    repeated :tables, :message, 1, "TableInBatchWriteRowRequest"
+  end
+  add_message "RowInBatchWriteRowResponse" do
+    optional :is_ok, :bool, 1
+    optional :error, :message, 2, "Error"
+    optional :consumed, :message, 3, "ConsumedCapacity"
+    optional :row, :bytes, 4
+  end
+  add_message "TableInBatchWriteRowResponse" do
+    optional :table_name, :string, 1
+    repeated :rows, :message, 2, "RowInBatchWriteRowResponse"
+  end
+  add_message "BatchWriteRowResponse" do
+    repeated :tables, :message, 1, "TableInBatchWriteRowResponse"
+  end
+  add_message "GetRangeRequest" do
+    optional :table_name, :string, 1
+    optional :direction, :enum, 2, "Direction"
+    repeated :columns_to_get, :string, 3
+    optional :time_range, :message, 4, "TimeRange"
+    optional :max_versions, :int32, 5
+    optional :limit, :int32, 6
+    optional :inclusive_start_primary_key, :bytes, 7
+    optional :exclusive_end_primary_key, :bytes, 8
+    optional :filter, :bytes, 10
+    optional :start_column, :string, 11
+    optional :end_column, :string, 12
+    optional :token, :bytes, 13
+  end
+  add_message "GetRangeResponse" do
+    optional :consumed, :message, 1, "ConsumedCapacity"
+    optional :rows, :bytes, 2
+    optional :next_start_primary_key, :bytes, 3
+    optional :next_token, :bytes, 4
+  end
+  add_enum "PrimaryKeyType" do
+    value :BOOLEAN, 0
+    value :INTEGER, 1
+    value :STRING, 2
+    value :BINARY, 3
+  end
+  add_enum "PrimaryKeyOption" do
+    value :DEFAULT, 0
+    value :AUTO_INCREMENT, 1
+  end
+  add_enum "RowExistenceExpectation" do
+    value :DEFAULT, 0
+    value :EXPECT_EXIST, 1
+    value :EXPECT_NOT_EXIST, 2
+    value :IGNORE, 3
+  end
+  add_enum "ReturnType" do
+    value :RT_NONE, 0
+    value :RT_PK, 1
+  end
+  add_enum "OperationType" do
+    value :POST, 0
+    value :PUT, 1
+    value :UPDATE, 2
+    value :DELETE, 3
+  end
+  add_enum "Direction" do
+    value :DEFAULT, 0
+    value :BACKWARD, 1
+    value :FORWARD, 2
+  end
+end
+
+Error = Google::Protobuf::DescriptorPool.generated_pool.lookup("Error").msgclass
+PrimaryKeySchema = Google::Protobuf::DescriptorPool.generated_pool.lookup("PrimaryKeySchema").msgclass
+PartitionRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("PartitionRange").msgclass
+TableOptions = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableOptions").msgclass
+TableMeta = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableMeta").msgclass
+Condition = Google::Protobuf::DescriptorPool.generated_pool.lookup("Condition").msgclass
+CapacityUnit = Google::Protobuf::DescriptorPool.generated_pool.lookup("CapacityUnit").msgclass
+ReservedThroughputDetails = Google::Protobuf::DescriptorPool.generated_pool.lookup("ReservedThroughputDetails").msgclass
+ReservedThroughput = Google::Protobuf::DescriptorPool.generated_pool.lookup("ReservedThroughput").msgclass
+ConsumedCapacity = Google::Protobuf::DescriptorPool.generated_pool.lookup("ConsumedCapacity").msgclass
+CreateTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("CreateTableRequest").msgclass
+CreateTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("CreateTableResponse").msgclass
+UpdateTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("UpdateTableRequest").msgclass
+UpdateTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("UpdateTableResponse").msgclass
+DescribeTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("DescribeTableRequest").msgclass
+DescribeTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("DescribeTableResponse").msgclass
+ListTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("ListTableRequest").msgclass
+ListTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("ListTableResponse").msgclass
+DeleteTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("DeleteTableRequest").msgclass
+DeleteTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("DeleteTableResponse").msgclass
+LoadTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("LoadTableRequest").msgclass
+LoadTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("LoadTableResponse").msgclass
+UnloadTableRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("UnloadTableRequest").msgclass
+UnloadTableResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("UnloadTableResponse").msgclass
+TimeRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("TimeRange").msgclass
+ReturnContent = Google::Protobuf::DescriptorPool.generated_pool.lookup("ReturnContent").msgclass
+GetRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("GetRowRequest").msgclass
+GetRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("GetRowResponse").msgclass
+UpdateRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("UpdateRowRequest").msgclass
+UpdateRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("UpdateRowResponse").msgclass
+PutRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("PutRowRequest").msgclass
+PutRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("PutRowResponse").msgclass
+DeleteRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("DeleteRowRequest").msgclass
+DeleteRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("DeleteRowResponse").msgclass
+TableInBatchGetRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableInBatchGetRowRequest").msgclass
+BatchGetRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("BatchGetRowRequest").msgclass
+RowInBatchGetRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("RowInBatchGetRowResponse").msgclass
+TableInBatchGetRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableInBatchGetRowResponse").msgclass
+BatchGetRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("BatchGetRowResponse").msgclass
+RowInBatchWriteRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("RowInBatchWriteRowRequest").msgclass
+TableInBatchWriteRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableInBatchWriteRowRequest").msgclass
+BatchWriteRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("BatchWriteRowRequest").msgclass
+RowInBatchWriteRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("RowInBatchWriteRowResponse").msgclass
+TableInBatchWriteRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("TableInBatchWriteRowResponse").msgclass
+BatchWriteRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("BatchWriteRowResponse").msgclass
+GetRangeRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("GetRangeRequest").msgclass
+GetRangeResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("GetRangeResponse").msgclass
+PrimaryKeyType = Google::Protobuf::DescriptorPool.generated_pool.lookup("PrimaryKeyType").enummodule
+PrimaryKeyOption = Google::Protobuf::DescriptorPool.generated_pool.lookup("PrimaryKeyOption").enummodule
+RowExistenceExpectation = Google::Protobuf::DescriptorPool.generated_pool.lookup("RowExistenceExpectation").enummodule
+ReturnType = Google::Protobuf::DescriptorPool.generated_pool.lookup("ReturnType").enummodule
+OperationType = Google::Protobuf::DescriptorPool.generated_pool.lookup("OperationType").enummodule
+Direction = Google::Protobuf::DescriptorPool.generated_pool.lookup("Direction").enummodule

data/lib/tablestore-ruby-sdk.rb

@@ -0,0 +1,99 @@
+require 'rest-client'
+require 'openssl'
+require 'base64'
+require 'tablestore/error'
+require 'tablestore/ots'
+require 'tablestore/metadata'
+
+class TableStore
+  DEFAULT_ENCODING = 'utf8'
+  DEFAULT_SOCKET_TIMEOUT = 50
+  DEFAULT_MAX_CONNECTION = 50
+  DEFAULT_LOGGER_NAME = 'tablestore-client'
+
+
+  def initialize(end_point, access_key_id, access_key_secret, instance_name, **kwargs)
+    # 初始化OTSClient实例。
+    # end_point是OTS服务的地址（例如 'http://instance.cn-hangzhou.ots.aliyun.com'），必须以'http://'或'https://'开头。
+    # access_key_id是访问OTS服务的accessid，通过官方网站申请或通过管理员获取。
+    # access_key_secret是访问OTS服务的accesskey，通过官方网站申请或通过管理员获取。
+    # instance_name是要访问的实例名，通过官方网站控制台创建或通过管理员获取。
+    # sts_token是访问OTS服务的STS token，从STS服务获取，具有有效期，过期后需要重新获取。
+    # encoding请求参数的字符串编码类型，默认是utf8。
+    # socket_timeout是连接池中每个连接的Socket超时，单位为秒，可以为int或float。默认值为50。
+    # max_connection是连接池的最大连接数。默认为50，
+    # logger_name用来在请求中打DEBUG日志，或者在出错时打ERROR日志。
+    # retry_policy定义了重试策略，默认的重试策略为 DefaultRetryPolicy。你可以继承 RetryPolicy 来实现自己的重试策略，请参考 DefaultRetryPolicy 的代码。
+
+    #self.validate_parameter(end_point, access_key_id, access_key_secret, instance_name)
+    #sts_token = kwargs.get('sts_token')
+
+    #示例：创建一个OTSClient实例
+    # from tablestore.client import OTSClient
+    # client = OTSClient('your_instance_endpoint', 'your_user_id', 'your_user_key', 'your_instance_name')
+  end
+
+  def _get_range(request)
+    api_name = 'GetRange'
+    body = OTS.new.encode_get_range_request(request)
+    response = post_request(body, api_name)
+    OTS.new.decode_get_range_request(api_name, response.headers, response.body)
+  end
+
+  def _put_row(table_name, row, condition)
+    api_name = 'PutRow'
+    body = OTS.new.encode_put_row(table_name, row, condition)
+    response = post_request(body, api_name)
+    if response.code == 200
+      'write succeed!'
+    end
+  end
+
+  def _get_row(table_name, primary_key, columns_to_get=nil, column_filter=nil, max_version=1)
+    api_name = 'GetRow'
+    body = OTS.new.encode_get_row(table_name, primary_key, columns_to_get, column_filter, max_version)
+    response = post_request(body, api_name)
+    OTS.new.decode_get_row(response.body)
+  end
+
+  def _batch_get_row(request)
+    api_name = 'BatchGetRow'
+    body = OTS.new.make_batch_get_row(request)
+    response = post_request(body, api_name)
+    OTS.new.decode_batch_get_row(response.body)
+  end
+
+  def _batch_write_row(request)
+    api_name = 'BatchWriteRow'
+    body = OTS.new.make_batch_write_row(request)
+    response = post_request(body, api_name)
+    if response.code == 200
+      'write succeed!'
+    end
+  end
+
+  private
+  def post_request(body, api_name)
+    md5 = Base64.encode64(Digest::MD5.new.digest(body)).gsub(/\n/, '')
+    headers = get_headers(md5, api_name)
+    url = BaseUrl+ '/' + api_name
+    RestClient.post(url, body, headers)
+  end
+
+  def get_headers(md5, api_name)
+    headers = {
+        "x-ots-date": Time.now.getutc.strftime('%Y-%m-%dT%H:%M:%S.000Z'),
+        "x-ots-apiversion": '2015-12-31',
+        "x-ots-accesskeyid": UserID,
+        "x-ots-contentmd5": md5,
+        "x-ots-instancename": InstanceName,
+    }
+    signature_string = "/#{api_name}\nPOST\n\n"
+    headers_string = headers.map{|k,v| "#{k.downcase}:#{v.strip}"}.sort.join("\n")
+    signature_string += headers_string + "\n"
+    salt1 = OpenSSL::HMAC.digest('sha1', UserSecret, signature_string)
+    signature = Base64.encode64(salt1).gsub(/\n/, '')
+    headers.merge!({'User-Agent': 'aliyun-tablestore-sdk-ruby', 'x-ots-signature': signature})
+    headers
+  end
+end