すべてのプロダクト
Search
ドキュメントセンター

Tablestore:DeleteRow

最終更新日:Dec 28, 2024

データ行を削除します。

リクエスト構文

message DeleteRowRequest {
    required string table_name = 1;
    required bytes primary_key = 2; // プライマリキーは、PlainBuffer 形式でバイナリデータとしてエンコードされます。
    required Condition condition = 3;
    optional ReturnContent return_content = 4;
    optional string transaction_id = 5;
}

パラメーター

タイプ

必須

説明

table_name

string

はい

データテーブルの名前。

primary_key

bytes

はい

削除する行のプライマリキー。

プライマリキーは PlainBuffer 形式でエンコードされます。PlainBuffer の詳細については、PlainBuffer を参照してください。

condition

Condition

はい

データ操作の前に行の存在チェックを実行するかどうかを指定します。デフォルト値:IGNORE。有効な値:

  • IGNORE:行の存在チェックは実行されません。

    condition パラメーターを IGNORE に設定すると、行が存在するかどうかに関係なく操作は成功します。

  • EXPECT_EXIST:行が存在することが想定されます。

    condition パラメーターを EXPECT_EXIST に設定すると、行が存在する場合は削除操作は成功し、行が存在しない場合は削除操作は失敗してエラーが報告されます。

return_content

ReturnContent

いいえ

行が正常に書き込まれた後に返されるデータのタイプ。プライマリキーのみを返すことができます。ほとんどの場合、このパラメーターは自動インクリメントプライマリキー列機能によって使用されます。

transaction_id

string

いいえ

ローカルトランザクションの ID。ローカルトランザクションを使用してデータを削除する場合、このパラメーターは必須です。

レスポンス構文

message DeleteRowResponse {
    required ConsumedCapacity consumed = 1;
    optional bytes row = 2;
}

パラメーター

タイプ

説明

consumed

ConsumedCapacity

操作で消費される容量ユニット (CU) の数。詳細については、CU 消費量を参照してください。

row

bytes

return_content に値を指定した場合に返されるデータ。 return_content に値を指定しない場合、または戻り値が存在しない場合は、NULL が返されます。

返されるデータは PlainBuffer 形式でエンコードされます。PlainBuffer の詳細については、PlainBuffer を参照してください。

Tablestore SDK の使用

以下の Tablestore SDK を使用して、単一のデータ行を削除できます。

CU 消費量

  • 削除する行が存在しない場合、消費される CU の数は、condition パラメーターに指定した値によって異なります。

    • condition パラメーターの値が IGNORE の場合、消費される書き込み CU の数は、次の式を使用して計算された値から切り上げられます。消費される書き込み CU の数 = 行のすべてのプライマリキー列のデータサイズ/4 KB。

    • condition パラメーターの値が EXPECT_EXIST の場合、行の削除は失敗します。1 つの書き込み CU と 1 つの読み取り CU が消費されます。

  • 削除する行が存在する場合、消費される CU の数は、condition パラメーターに指定した値によって異なります。

    • condition パラメーターの値が IGNORE の場合、消費される書き込み CU の数は、次の式を使用して計算された値から切り上げられます。消費される書き込み CU の数 = 行のすべてのプライマリキー列のデータサイズ/4 KB。

    • condition パラメーターの値が EXPECT_EXIST の場合、書き込み CU と読み取り CU の両方が消費されます。消費される書き込み CU の数は、次の式を使用して計算された値から切り上げられます。消費される書き込み CU の数 = 行のすべてのプライマリキー列のデータサイズ/4 KB。消費される読み取り CU の数は、次の式を使用して計算された値から切り上げられます。消費される読み取り CU の数 = 行のすべてのプライマリキー列のデータサイズ/4 KB。

    データサイズの計算方法の詳細については、課金概要を参照してください。

  • リクエストがタイムアウトし、結果が未定義の場合、CU が消費される場合と消費されない場合があります。

  • 内部エラーが発生したことを示す HTTP ステータスコード 5xx が返された場合、操作では CU は消費されません。その他のエラーが返された場合は、1 つの書き込み CU が消費されます。