行の削除 - Tablestore SDK for Python - Tablestore - Alibaba Cloud ドキュメントセンター

Tablestore SDK for Python を使用して、プライマリキーで行を削除します。オプションで、削除条件やローカルトランザクションを指定することもできます。

前提条件

Tablestore SDK for Python をインストールし、クライアントを初期化します。

メソッドの説明

delete_row を呼び出して、プライマリキーで指定した行全体を削除します。

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

次の例では、example_table からプライマリキーが [("partition", "device"), ("id", 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`	操作によって消費された書き込みキャパシティーユニット。
return_row	`Row`	返される行です。`return_type` が `RT_PK` の場合、プライマリキーが返されます。それ以外の場合、この値は `None` です。