写入数据

接口

"""
说明：写入一行数据。返回本次操作消耗的CapacityUnit。
``table_name``是对应的表名。
``row``是行数据，包括主键和属性列。
``condition``表示执行操作前做条件检查，满足条件才执行，是tablestore.metadata.Condition类的实例。
目前支持两种条件检测，一是对行的存在性进行检查，检查条件包括：'IGNORE'，'EXPECT_EXIST'和'EXPECT_NOT_EXIST';二是对属性列值的条件检测。
``return_type``表示返回类型，是tablestore.metadata.ReturnType类的实例，目前仅支持返回PrimaryKey，一般用于主键列自增中。
返回：本次操作消耗的CapacityUnit和需要返回的行数据。
consumed表示消耗的CapacityUnit，是tablestore.metadata.CapacityUnit类的实例。
return_row表示返回的行数据，可能包括主键、属性列。
示例：
    primary_key = [('gid',1), ('uid',101)]
    attribute_columns = [('name','张三'), ('mobile',111111111), ('address','中国A地'), ('age',20)]
    row = Row(primary_key, attribute_columns)
    condition = Condition('EXPECT_NOT_EXIST')
    consumed, return_row = client.put_row('myTable', row, condition)
"""
def put_row(self, table_name, row, condition = None, return_type = None, transaction_id = None):

参数

示例

插入一行数据。

# 设置数据表名称。
table_name = '<TABLE_NAME>'

# 主键的第一个主键列是gid，值是整数1，第二个主键列是uid，值是整数101。
primary_key = [('gid',1), ('uid',101)]
# 属性列包括五个：
# 第一个属性列的名字是name，值是字符串John，版本号没有指定，使用系统当前时间作为版本号。
# 第二个属性列的名字是mobile，值是整数1390000****，版本号没有指定，使用系统当前时间作为版本号。
# 第三个属性列的名字是address，值是二进制的China，版本号没有指定，使用系统当前时间作为版本号。
# 第四个属性列的名字是female，值是布尔值False，版本号没有指定，使用系统当前时间作为版本号。
# 第五个属性列的名字是age，值是29.7，指定版本号为1498184687000。
attribute_columns = [('name','John'), ('mobile',1390000****),('address', bytearray('China', encoding='utf8')),('female', False), ('age', 29.7, 1498184687000)]
# 通过primary_key和attribute_columns构造Row。
row = Row(primary_key, attribute_columns)

# 设置条件更新，行条件检查为期望行不存在。如果行存在会出现Condition Update Failed错误。
condition = Condition(RowExistenceExpectation.EXPECT_NOT_EXIST)
try:
    # 调用put_row方法，如果没有指定ReturnType，则return_row为None。
    consumed, return_row = client.put_row(table_name, row, condition)

    # 打印此次请求消耗的写CU。
    print('put row succeed, consume %s write cu.' % consumed.write)
# 客户端异常，一般为参数错误或者网络异常。
except OTSClientError as e:
    print("put row failed, http_status:%d, error_message:%s" % (e.get_http_status(), e.get_error_message()))
# 服务端异常，一般为参数错误或者流控错误。
except OTSServiceError as e:
    print("put row failed, http_status:%d, error_code:%s, error_message:%s, request_id:%s" % (e.get_http_status(), e.get_error_code(), e.get_error_message(), e.get_request_id()))                    

详细代码请参见PutRow@GitHub。

接口

"""
说明：更新一行数据。
``table_name``是对应的表名。
``row``表示更新的行数据，包括主键列和属性列，主键列是list；属性列是dict。
``condition``表示执行操作前做条件检查，满足条件才执行，是tablestore.metadata.Condition类的实例。
目前支持两种条件检测，一是对行的存在性进行检查，检查条件包括：'IGNORE'，'EXPECT_EXIST'和'EXPECT_NOT_EXIST';二是对属性列值的条件检测。
``return_type``表示返回类型，是tablestore.metadata.ReturnType类的实例，目前仅支持返回PrimaryKey，一般用于主键列自增中。
返回：本次操作消耗的CapacityUnit和需要返回的行数据return_row
consumed表示消耗的CapacityUnit，是tablestore.metadata.CapacityUnit类的实例。
return_row表示需要返回的行数据。
示例：
    primary_key = [('gid',1), ('uid',101)]
    update_of_attribute_columns = {
        'put' : [('name','张三丰'), ('address','中国B地')],
        'delete' : [('mobile', 1493725896147)],
        'delete_all' : [('age')],
        'increment' : [('counter', 1)]
    }
    row = Row(primary_key, update_of_attribute_columns)
    condition = Condition('EXPECT_EXIST')
    consumed = client.update_row('myTable', row, condition)
"""
def update_row(self, table_name, row, condition, return_type = None, transaction_id = None):

参数

示例

更新一行数据。

# 设置数据表名称。
table_name = '<TABLE_NAME>'

# 主键的第一列是gid，值是整数1，第二列是uid，值是整数101。
primary_key = [('gid',1), ('uid',101)]
# 更新包括PUT，DELETE和DELETE_ALL三部分。
# PUT：新增或者更新列值。示例中是新增两列，第一列名字是name，值是David，第二列名字是address，值是Hongkong。
# DELETE: 删除指定版本号（时间戳）的值。示例中是删除版本为1488436949003的address列的值。
# DELETE_ALL：删除列。示例中是删除mobile和age两列的所有版本的值。
update_of_attribute_columns = {
    'PUT' : [('name','David'), ('address','Hongkong')],
    'DELETE' : [('address', None, 1488436949003)],
    'DELETE_ALL' : [('mobile'), ('age')],
}
row = Row(primary_key, update_of_attribute_columns)

# 行条件检查为忽略，无论行是否存在，均会更新。
condition = Condition(RowExistenceExpectation.IGNORE, SingleColumnCondition("age", 20, ComparatorType.EQUAL)) # update row only when this row is exist
try:
    consumed, return_row = client.update_row(table_name, row, condition)
    
    # 打印此次请求消耗的写CU。
    print('put row succeed, consume %s write cu.' % consumed.write)
# 客户端异常，一般为参数错误或者网络异常。
except OTSClientError as e:
    print("update row failed, http_status:%d, error_message:%s" % (e.get_http_status(), e.get_error_message()))
# 服务端异常，一般为参数错误或者流控错误。
except OTSServiceError as e:
    print("update row failed, http_status:%d, error_code:%s, error_message:%s, request_id:%s" % (e.get_http_status(), e.get_error_code(), e.get_error_message(), e.get_request_id()))

详细代码请参见UpdateRow@GitHub。

注意事项

由于批量写入可能存在部分行失败的情况，失败行的Index及错误信息在返回的BatchWriteRowResponse中，但并不抛出异常。因此调用BatchWriteRow接口时，需要检查返回值，判断每行的状态是否成功；如果不检查返回值，则可能会忽略掉部分操作的失败。

当服务端检查到某些操作出现参数错误时，BatchWriteRow接口可能会抛出参数错误的异常，此时该请求中所有的操作都未执行。

示例

批量写数据。

put_row_items = []
# 增加PutRow的行。
for i in range(0, 20):
    primary_key = [('gid',i), ('uid',i+1)]
    attribute_columns = [('name','somebody'+str(i)), ('address','somewhere'+str(i)), ('age',i)]
    row = Row(primary_key, attribute_columns)
    condition = Condition(RowExistenceExpectation.IGNORE)
    item = PutRowItem(row, condition)
    put_row_items.append(item)

# 增加UpdateRow的行。
for i in range(0, 10):
    primary_key = [('gid',i), ('uid',i+1)]
    attribute_columns = {'put': [('name','somebody'+str(i)), ('address','somewhere'+str(i)), ('age',i)]}
    row = Row(primary_key, attribute_columns)
    condition = Condition(RowExistenceExpectation.IGNORE, SingleColumnCondition("age", i, ComparatorType.EQUAL))
    item = UpdateRowItem(row, condition)
    put_row_items.append(item)

# 增加DeleteRow的行。
delete_row_items = []
for i in range(10, 20):
    primary_key = [('gid',i), ('uid',i+1)]
    row = Row(primary_key)
    condition = Condition(RowExistenceExpectation.IGNORE)
    item = DeleteRowItem(row, condition)
    delete_row_items.append(item)

# 构造批量写请求。
request = BatchWriteRowRequest()
request.add(TableInBatchWriteRowItem('<TABLE_NAME>', put_row_items))
request.add(TableInBatchWriteRowItem('<DELETE_TABLE_NAME>', delete_row_items))

# 调用batch_write_row方法执行批量写，如果请求参数等错误会抛异常；如果部分行失败，则不会抛异常，但是内部的Item会失败。
try:
    result = client.batch_write_row(request)
    print('Result status: %s'%(result.is_all_succeed()))

    # 检查Put行的结果。
    print('check first table\'s put results:')
    succ, fail = result.get_put()
    for item in succ:
        print('Put succeed, consume %s write cu.' % item.consumed.write)
    for item in fail:
        print('Put failed, error code: %s, error message: %s' % (item.error_code, item.error_message))

    # 检查Update行的结果。
    print('check first table\'s update results:')
    succ, fail = result.get_update()
    for item in succ:
        print('Update succeed, consume %s write cu.' % item.consumed.write)
    for item in fail:
        print('Update failed, error code: %s, error message: %s' % (item.error_code, item.error_message))

    # 检查Delete行的结果。
    print('check second table\'s delete results:')
    succ, fail = result.get_delete()
    for item in succ:
        print('Delete succeed, consume %s write cu.' % item.consumed.write)
    for item in fail:
        print('Delete failed, error code: %s, error message: %s' % (item.error_code, item.error_message)) 
# 客户端异常，一般为参数错误或者网络异常。
except OTSClientError as e:
    print("get row failed, http_status:%d, error_message:%s" % (e.get_http_status(), e.get_error_message()))
# 服务端异常，一般为参数错误或者流控错误。
except OTSServiceError as e:
    print("get row failed, http_status:%d, error_code:%s, error_message:%s, request_id:%s" % (e.get_http_status(), e.get_error_code(), e.get_error_message(), e.get_request_id()))

详细代码请参见BatchWriteRow@GitHub。