Scans data in parallel.
Request syntax
message ParallelScanRequest {
optional string table_name = 1;
optional string index_name = 2;
optional ColumnsToGet columns_to_get = 3;
optional bytes session_id = 4;
optional ScanQuery scan_query = 5;
optional int32 timeout_ms = 6;
}|
Parameter |
Type |
Required |
Description |
|
table_name |
string |
Yes |
The name of the data table. |
|
index_name |
string |
Yes |
The name of the search index. |
|
columns_to_get |
No |
The columns to return. |
|
|
session_id |
bytes |
No |
The session ID. You can use the session ID to determine the result set of scanned data. The value must be encoded using protobuf. |
|
scan_query |
Yes |
The scan configuration. |
|
|
timeout_ms |
int32 |
No |
The scan timeout period. Unit: milliseconds. |
Response syntax
message ParallelScanResponse {
repeated bytes rows = 1;
optional bytes next_token = 2;
}|
Parameter |
Type |
Required |
Description |
|
rows |
bytes |
No |
The returned row data, encoded in PlainBuffer format. For more information, see PlainBuffer. |
|
next_token |
bytes |
No |
The position from which the next scan starts. |
Use Tablestore SDKs
The following Tablestore SDKs support parallel scan:
Tablestore SDK for Java: Parallel scan
Tablestore SDK for Go: Parallel scan
Tablestore SDK for Python: Parallel scan
Tablestore SDK for Node.js: Parallel scan
Tablestore SDK for .NET: Parallel scan
Tablestore SDK for PHP: Parallel scan