Read the configurations of a data table - Tablestore - Alibaba Cloud Documentation Center

Specifies that the configurations of a data table is read.

Data structure

message TableInBatchGetRowRequest {
    required string table_name = 1;
    repeated bytes primary_key = 2; // The primary key columns are encoded in the PlainBuffer format. 
    repeated bytes token = 3;
    repeated string columns_to_get = 4;  // If you do not specify this parameter, all columns are read. 
    optional TimeRange time_range = 5;
    optional int32 max_versions = 6;
    optional bytes filter = 8;
    optional string start_column = 9;
    optional string end_column = 10;
}

Parameter	Type	Required	Description
table_name	string	Yes	The name of the data table.
primary_key	bytes	Yes	All primary key columns of the row whose data you want to read, including the names and values of the primary key columns. The primary key columns are encoded in the PlainBuffer format. For more information, see PlainBuffer.
token	bytes	No	The position from which the next wide-column read operation starts. This parameter is unavailable.
columns_to_get	string	No	The names of all columns to return.
time_range	TimeRange	You must configure at least one of time_range and max_versions.	The range of versions or a specific version that you want to read. The value of this parameter is a timestamp in milliseconds. Valid values: 0 to INT64.MAX. To query data whose versions are in a specific time range, you must configure start_time and end_time. start_time indicates the start timestamp. end_time indicates the end timestamp. The specified range includes the start timestamp and excludes the end timestamp. To query data of a specific version, you must configure specific_time. specific_time indicates a specific timestamp.
max_versions	int32	You must configure at least one of max_versions and time_range.	The maximum number of data versions that you can read. If the value of max_versions is 2, up to two versions of data is returned for each column.
filter	bytes	No	The expressions of filter conditions. The expression of a filter condition is serialized as binary data by using Protobuf. For more information, see Filter.
start_column	string	No	The column from which the read operation starts in a row. This parameter is used to read wide columns. The response contains the specified start column. The columns are sorted based on their names in alphabetical order. For example, if a table contains columns "a", "b", and "c", and the value of start_column is "b", the read operation starts from column "b", and columns "b" and "c" are returned.
end_column	string	No	The column at which the read operation ends in a row. This parameter is used to read wide columns. The response does not contain the specified end column. The columns are sorted based on their names in alphabetical order. For example, if a table contains columns "a", "b", and "c", and the value of end_column is "b", the read operation ends at column "b", and only column "a" is returned.

References

BatchGetRow