Queries the incremental data of a shard.
Request syntax
message GetStreamRecordRequest {
required string shard_iterator = 1;
optional int32 limit = 2;
optional string table_name = 3;
}|
Parameter |
Type |
Required |
Description |
|
shard_iterator |
string |
Yes |
The shard iterator used to read incremental data from the shard. |
|
limit |
int32 |
No |
The maximum number of records to return. |
|
table_name |
string |
No |
The name of the data table. |
Response syntax
message GetStreamRecordResponse {
repeated StreamRecord stream_records = 1;
optional raw_string next_shard_iterator = 2;
optional ConsumedCapacity consumed = 3;
optional bool may_more_record = 4;
}|
Parameter |
Type |
Description |
|
StreamRecord |
repeated StreamRecord |
A stream record entry read from the current shard. |
|
next_shard_iterator |
string |
The shard iterator to use in the next GetStreamRecord request to continue reading from the current shard. |
|
consumed |
The number of read capacity units (CUs) consumed, rounded up based on the formula: read CUs = total size of all rows read / 4 KB. For more information about how to calculate the total size of data in all rows that are actually read, see Storage usage. |
|
|
may_more_record |
bool |
Indicates whether more records are available to read from the shard. Use this parameter to determine whether the client needs to make further read or processing requests. |
Use Tablestore SDKs
Tablestore SDK for Java: GetStreamRecord