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 iterator that is used to read the incremental data of the shard. |
limit | int32 | No | The maximum number of data records that you want returned. |
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 | The record entry that is used to read data from the current shard. |
next_shard_iterator | string | The iterator that is used to read data from the current shard in the next GetStreamRecord request. |
consumed | The number of capacity units (CUs) that are consumed to read stream data is rounded up from the value that is calculated by using the following formula: Number of consumed read CUs = Total size of data in all rows that are 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 there are more records available to read. This parameter provides information to help the client make further data reading or processing decisions. |
Use Tablestore SDKs
Tablestore SDK for Java: GetStreamRecord