文档

主键列自增

更新时间:

设置非分区键的主键列为自增列后,在写入数据时,无需为自增列设置具体值,表格存储会自动生成自增列的值。该值在分区键级别唯一且严格递增。

前提条件

已初始化Client。具体操作,请参见初始化OTSClient

使用方法

  1. 创建表时,将非分区键的主键列设置为自增列。

    只有整型的主键列才能设置为自增列,系统自动生成的自增列值为64位的有符号长整型。

  2. 写入数据时,无需为自增列设置具体值,只需将自增列的值设置为占位符。

    如果需要获取写入数据后系统自动生成的自增列的值,将ReturnType设置为RT_PK,可以在数据写入成功后返回自增列的值。

    读取数据时,需要完整的主键值。通过设置PutRow、UpdateRow或者BatchWriteRow中的ReturnType为RT_PK可以获取完整的主键值。

    读取数据时,如果已记录完整主键,您可以使用读取单行数据或者批量读取数据方式读取数据;如果未记录自增主键列的值,您可以使用范围读取数据方式按照第一个主键列确定范围读取数据。

    说明

    要更新已存在的行数据时,如果未记录自增主键列的值,请先通过GetRange接口获取要更新的行主键信息,然后再进行数据更新。

示例

主键自增列功能主要涉及创建表(CreateTable)和写数据(PutRow、UpdateRow和BatchWriteRow)两类接口。

  1. 创建表

    创建表时,只需将自增的主键属性设置为PK_AUTO_INCR。

    以下示例用于创建数据表时配置主键自增列。该表的主键为gid(Integer类型)和uid(Integer类型),其中gid主键列为分区键,uid主键列为自增列。

    table_name = '<TABLE_NAME>'
    def create_table(client):
        # 创建表,表中包括两个主键:gid,INTEGER类型;uid,INTEGER类型,为自增列。
        schema_of_primary_key = [('gid', 'INTEGER'), ('uid', 'INTEGER', PK_AUTO_INCR)]
        table_meta = TableMeta(table_name, schema_of_primary_key)
        table_options = TableOptions()
        reserved_throughput = ReservedThroughput(CapacityUnit(0, 0))
        client.create_table(table_meta, table_options, reserved_throughput)
        print ('Table has been created.')
  2. 写数据

    写入数据时,无需为自增列设置具体值,只需将自增列的值设置为占位符PK_AUTO_INCR。

    以下示例用于向数据表中写入一行数据,并返回完整主键值和消耗的预留读写吞吐量。

    table_name = '<TABLE_NAME>'
    def put_row(client):
        # 设置主键信息:gid为1,uid为自增列。uid列必须设置,否则报错。
        primary_key = [('gid',1), ('uid', PK_AUTO_INCR)]
        # 设置属性列。
        attribute_columns = [('name','John'), ('mobile',1390000****), ('address','China'), ('age',20)]
        row = Row(primary_key, attribute_columns)
    
        # 写入数据,返回消耗的CU但是不返回主键信息。
        #consumed, return_row = client.put_row(table_name, row)
        #print ('Write succeed, consume %s write cu.' % consumed.write)
        
        # 写入数据,返回消耗的CU和主键信息。
        consumed, return_row = client.put_row(table_name, row, return_type = ReturnType.RT_PK)
        print ('Write succeed, consume %s write cu.' % consumed.write)
        print ('Primary key:%s' % return_row.primary_key)
  • 本页导读 (1)