New feature: Global secondary index.

Author: zhouzf05

examples/search_index.py

@@ -211,7 +211,7 @@ def prepare_index(index_name, with_nested=False):
  fields.append(field_n)
  index_setting = IndexSetting(routing_fields=['PK1'])
  index_sort = Sort(sorters=[PrimaryKeySort(SortOrder.ASC)]) if not with_nested else None
- index_meta = IndexMeta(fields, index_setting=index_setting, index_sort=index_sort) # default with index sort
+ index_meta = SearchIndexMeta(fields, index_setting=index_setting, index_sort=index_sort) # default with index sort
  client.create_search_index(table_name, index_name, index_meta)
 
 def list_search_index():

examples/secondary_index_operations.py

@@ -0,0 +1,71 @@
+# -*- coding: utf8 -*-
+
+from example_config import *
+from tablestore import *
+import time
+import json
+
+table_name = 'SecondaryIndexOperationExample'
+
+def create_table(client):
+ print ('Begin CreateTable')
+ schema_of_primary_key = [('gid', 'INTEGER'), ('uid', 'STRING')]
+ defined_columns = [('i', 'INTEGER'), ('bool', 'BOOLEAN'), ('d', 'DOUBLE'), ('s', 'STRING'), ('b', 'BINARY')]
+ table_meta = TableMeta(table_name, schema_of_primary_key, defined_columns)
+ table_option = TableOptions(-1, 1)
+ reserved_throughput = ReservedThroughput(CapacityUnit(0, 0))
+ secondary_indexes = [
+ SecondaryIndexMeta('index1', ['i', 's'], ['gid', 'uid', 'bool', 'b', 'd']),
+ ]
+ client.create_table(table_meta, table_option, reserved_throughput, secondary_indexes)
+ print ('Table has been created.')
+
+def create_index(client):
+ print ('Begin CreateIndex')
+ index_meta = SecondaryIndexMeta('index2', ['i', 's'], ['gid', 'uid', 'bool', 'b', 'd'])
+ client.create_secondary_index(table_name, index_meta)
+ print ('Index has been created.')
+
+def describe_table(client):
+ print ('Begin DescribeTable')
+ describe_response = client.describe_table(table_name)
+ print ('TableName: %s' % describe_response.table_meta.table_name)
+ print ('PrimaryKey: %s' % describe_response.table_meta.schema_of_primary_key)
+ print ('Reserved read throughput: %s' % describe_response.reserved_throughput_details.capacity_unit.read)
+ print ('Reserved write throughput: %s' % describe_response.reserved_throughput_details.capacity_unit.write)
+ print ('Last increase throughput time: %s' % describe_response.reserved_throughput_details.last_increase_time)
+ print ('Last decrease throughput time: %s' % describe_response.reserved_throughput_details.last_decrease_time)
+ print ('table options\'s time to live: %s' % describe_response.table_options.time_to_live)
+ print ('table options\'s max version: %s' % describe_response.table_options.max_version)
+ print ('table options\'s max_time_deviation: %s' % describe_response.table_options.max_time_deviation)
+ print ('Secondary indexes:')
+ for secondary_index in describe_response.secondary_indexes:
+ print (json.dumps(secondary_index, default=lambda x:x.__dict__, indent=2))
+ print ('End DescribeTable')
+
+def delete_index(client):
+ print ('Begin DeleteIndex')
+ client.delete_secondary_index(table_name, 'index1')
+ print ('End delete index.')
+
+def delete_table(client):
+ print ('Begin DeleteTable')
+ client.delete_table(table_name)
+ print ('End DeleteTable')
+
+if __name__ == '__main__':
+ client = OTSClient(OTS_ENDPOINT, OTS_ID, OTS_SECRET, OTS_INSTANCE)
+ try:
+ delete_table(client)
+ print 'delete succeeded.'
+ except:
+ pass
+
+ create_table(client)
+
+ #time.sleep(3) # wait for table ready
+ create_index(client)
+ describe_table(client)
+ delete_index(client)
+ describe_table(client)
+

tablestore/__init__.py

@@ -44,7 +44,7 @@
  'CompositeColumnCondition',
  'SingleColumnCondition',
  'RowExistenceExpectation',
- 'IndexMeta',
+ 'SearchIndexMeta',
  'FieldSchema',
  'FieldType',
  'IndexSetting',
@@ -79,7 +79,10 @@
  'ColumnReturnType',
  'FieldValueFactor',
  'GeoDistanceType',
- 'NestedFilter'
+ 'NestedFilter',
+ 'DefinedColumnSchema',
+ 'SecondaryIndexMeta',
+ 'SecondaryIndexType',
 ]
 
 

tablestore/client.py

@@ -164,7 +164,7 @@ def _request_helper(self, api_name, *args, **kwargs):
 
  return self.protocol.parse_response(api_name, status, resheaders, resbody)
 
- def create_table(self, table_meta, table_options, reserved_throughput):
+ def create_table(self, table_meta, table_options, reserved_throughput, secondary_indexes=[]):
  """
  说明：根据表信息创建表。
 
@@ -174,6 +174,7 @@ def create_table(self, table_meta, table_options, reserved_throughput):
  ``table_options``是``tablestore.metadata.TableOptions``类的示例，它包含time_to_live，max_version和
  max_time_deviation三个参数。
  ``reserved_throughput``是``tablestore.metadata.ReservedThroughput``类的实例，表示预留读写吞吐量。
+ ``secondary_indexes``是一个数组，可以包含一个或多个``tablestore.metadata.SecondaryIndexMeta``类的实例，表示要创建的二级索引。
 
  返回：无。
 
@@ -186,7 +187,7 @@ def create_table(self, table_meta, table_options, reserved_throughput):
  client.create_table(table_meta, table_options, reserved_throughput)
  """
 
- self._request_helper('CreateTable', table_meta, table_options, reserved_throughput)
+ self._request_helper('CreateTable', table_meta, table_options, reserved_throughput, secondary_indexes)
 
  def delete_table(self, table_name):
  """
@@ -645,7 +646,7 @@ def create_search_index(self, table_name, index_name, index_meta):
  :type index_name: str
  :param index_name: The name of index.
 
- :type index_meta: tablestore.metadata.IndexMeta
+ :type index_meta: tablestore.metadata.SearchIndexMeta
  :param index_meta: The definition of index, includes fields' schema, index setting and index pre-sorting configuration.
 
  Example usage:
@@ -661,7 +662,7 @@ def create_search_index(self, table_name, index_name, index_meta):
  ])
  fields = [field_a, field_b, field_c, field_d, nested_field]
 
- index_meta = IndexMeta(fields, index_setting=None, index_sort=None)
+ index_meta = SearchIndexMeta(fields, index_setting=None, index_sort=None)
  client.create_search_index('table_1', 'index_1', index_meta)
  """
 
@@ -713,3 +714,35 @@ def search(self, table_name, index_name, search_query, columns_to_get=None, rout
 
  return self._request_helper('Search', table_name, index_name, search_query, columns_to_get, routing_keys)
 
+ def create_secondary_index(self, table_name, index_meta):
+ """
+ Create a new secondary index. 
+
+ :type table_name: str
+ :param table_name: The name of table.
+
+ :type index_meta: tablestore.metadata.SecondaryIndexMeta 
+ :param index_meta: The definition of index.
+
+ Example usage:
+ index_meta = SecondaryIndexMeta('index1', ['i', 's'], ['gid', 'uid', 'bool', 'b', 'd'])
+ client.create_secondary_index(table_name, index_meta)
+ """
+
+ return self._request_helper('CreateIndex', table_name, index_meta) 
+
+ def delete_secondary_index(self, table_name, index_name):
+ """
+ Delete the secondary index. 
+
+ :type table_name: str
+ :param table_name: The name of table.
+
+ :type index_name: str
+ :param index_name: The name of index.
+
+ Example usage:
+ client.delete_secondary_index(table_name, index_name)
+ """
+
+ return self._request_helper('DropIndex', table_name, index_name)