調用BulkExport介面大量匯出資料。
請求訊息結構
message BulkExportRequest {
required string table_name = 1;
repeated string columns_to_get = 2;
required bytes inclusive_start_primary_key = 3;
required bytes exclusive_end_primary_key = 4;
optional bytes filter = 5;
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 | 否 | 返回結果的資料區塊類型。 |
響應訊息結構
message BulkExportResponse {
required ConsumedCapacity consumed = 1;
required bytes rows = 2;
optional bytes next_start_primary_key = 3;
optional DataBlockType data_block_type = 4;
}
參數 | 類型 | 是否必選 | 描述 |
consumed | 是 | 本次操作消耗的服務能力單元。更多資訊,請參見服務能力單元消耗。 | |
rows | bytes | 是 | 擷取到的行資料,包括主鍵和屬性列,由Plainbuffer編碼,詳見Plainbuffer編碼。 |
next_start_primary_key | bytes | 否 | 下一次讀取的起始主鍵,由Plainbuffer編碼,詳見Plainbuffer編碼。 如果傳回值為空白,則表示已讀取全部資料。 |
data_block_type | 否 | 返回結果的資料區塊類型。 |