All Products
Search
Document Center

Tablestore:ParallelScan

Last Updated:May 11, 2024

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

ColumnsToGet

No

The columns to return.

session_id

bytes

No

The session ID. The session ID can be used to determine the result set of scanned data. The value must be encoded by using protobuf.

scan_query

ScanQuery

Yes

The scan configurations.

timeout_ms

int32

No

The timeout period for scanning data. Unit: milliseconds.

Response syntax

message ParallelScanResponse {
    repeated bytes rows = 1;
    optional bytes next_token = 2;
}

Parameter

Type

Required

Description

rows

bytes

No

The row data that is returned. The value is encoded by using PlainBuffer. For more information, see PlainBuffer.

next_token

bytes

No

The position from which the next scan starts.

Use Tablestore SDKs

You can use the following Tablestore SDKs to scan data in parallel: