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

Tablestore:BulkExport

最終更新日:Dec 28, 2024

データをバッチエクスポートします。

リクエスト構文

message BulkExportRequest {
    required string table_name = 1; // データテーブルの名前。
    repeated string columns_to_get = 2; // エクスポートする列。このパラメータを指定しない場合、すべての列がエクスポートされます。
    required bytes inclusive_start_primary_key = 3; // PlainBuffer 形式でエンコードされた開始プライマリキー。詳細は、PlainBuffer を参照してください。行が存在する場合、その行はレスポンスに含まれます。
    required bytes exclusive_end_primary_key = 4; // PlainBuffer 形式でエンコードされた終了プライマリキー。詳細は、PlainBuffer を参照してください。行が存在するかどうかに関係なく、その行はレスポンスに含まれません。
    optional bytes filter = 5; // PlainBuffer 形式でエンコードされたフィルタ条件。詳細は、PlainBuffer を参照してください。
    optional DataBlockType data_block_type_hint = 6 [default = DBT_SIMPLE_ROW_MATRIX]; // 返される結果のデータブロックタイプ。
}

パラメータ

タイプ

必須

説明

table_name

string

はい

データテーブルの名前。

columns_to_get

string

いいえ

エクスポートする列。このパラメータを指定しない場合、すべての列がエクスポートされます。

inclusive_start_primary_key

bytes

はい

PlainBuffer 形式でエンコードされた開始プライマリキー。詳細は、PlainBuffer を参照してください。

行が存在する場合、その行はレスポンスに含まれます。

exclusive_end_primary_key

bytes

はい

PlainBuffer 形式でエンコードされた終了プライマリキー。詳細は、PlainBuffer を参照してください。

行が存在するかどうかに関係なく、その行はレスポンスに含まれません。

filter

bytes

いいえ

PlainBuffer 形式でエンコードされたフィルタ条件。詳細は、PlainBuffer を参照してください。

data_block_type_hint

DataBlockType

いいえ

返される結果のデータブロックタイプ。

レスポンス構文

message BulkExportResponse {
     required ConsumedCapacity consumed = 1; // 操作で消費されたキャパシティユニット (CU) の数。詳細は、CU 消費量を参照してください。
     required bytes rows = 2; // エクスポートされた行データ。プライマリキーと属性列が含まれます。行データは PlainBuffer 形式でエンコードされます。詳細は、PlainBuffer を参照してください。
     optional bytes next_start_primary_key = 3; // 次の読み取り操作の開始プライマリキー。開始プライマリキーは PlainBuffer 形式でエンコードされます。詳細は、PlainBuffer を参照してください。戻り値が空の場合、すべてのデータが読み取られます。
     optional DataBlockType data_block_type = 4; // 返される結果のデータブロックタイプ。
}

パラメータ

タイプ

必須

説明

consumed

ConsumedCapacity

はい

操作で消費されたキャパシティユニット (CU) の数。詳細は、CU 消費量を参照してください。

rows

bytes

はい

エクスポートされた行データ。プライマリキーと属性列が含まれます。行データは PlainBuffer 形式でエンコードされます。詳細は、PlainBuffer を参照してください。

next_start_primary_key

bytes

いいえ

次の読み取り操作の開始プライマリキー。開始プライマリキーは PlainBuffer 形式でエンコードされます。詳細は、PlainBuffer を参照してください。

戻り値が空の場合、すべてのデータが読み取られます。

data_block_type

DataBlockType

いいえ

返される結果のデータブロックタイプ。

Tablestore SDK の使用

Java 向け Tablestore SDK: オフラインデータのバッチ読み取り

CU 消費量:

  • リクエストされた行が存在しない場合、1 つの読み取り CU が消費されます。

  • リクエストされた行が存在する場合、消費される読み取り CU の数は、次の式の計算結果から切り上げられます。消費される読み取り CU の数 = (行のすべてのプライマリキー列のデータサイズ + 読み取られる属性列のデータサイズ)/4 KB。データサイズの計算方法については、ストレージ使用量 を参照してください。

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

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