调用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 | 否 | 返回结果的数据块类型。 |