表格存储 Python SDK 删除单行数据 - 表格存储

使用 Python SDK 按主键删除单行数据，并按需设置删除条件或局部事务。

前提条件

功能说明

调用 delete_row 方法按主键删除整行数据。

def delete_row(
    self,
    table_name,
    row=None,
    condition=None,
    return_type=None,
    transaction_id=None,
    **kwargs,
)

以下示例删除 example_table 中主键为 ("device", 1) 的一行数据。

primary_key = [("partition", "device"), ("id", 1)]
row = Row(primary_key)
condition = Condition(RowExistenceExpectation.EXPECT_EXIST)

consumed, return_row = client.delete_row(
    "example_table",
    row,
    condition,
)
print("Write CU: %s" % consumed.write)

参数说明

delete_row 方法包含以下参数。

名称	类型	说明
table_name（必选）	`str`	数据表名称。
row（必选）	`Row`	待删除行的主键。`Row.primary_key` 必须包含全部主键列，且主键列的名称、顺序、数量和类型与数据表的主键结构一致。
condition（可选）	`Condition`	删除条件。默认不判断行是否存在。有关配置方法，请参见条件更新。
return_type（可选）	`ReturnType`	返回类型。`RT_NONE`（默认值）表示不返回数据；`RT_PK` 表示返回主键列。
transaction_id（可选）	`str`	局部事务 ID。仅在局部事务内删除数据时设置。有关使用方法，请参见局部事务。

返回值

delete_row 返回以下值。

字段	类型	说明
consumed	`CapacityUnit`	本次操作消耗的读写 CU。
return_row	`Row`	返回的行数据。`return_type` 为 `RT_PK` 时返回主键列，否则为 `None`。