Specifies the configuration for reading data from a single table in a BatchGetRow operation.
Data structure
message TableInBatchGetRowRequest {
required string table_name = 1;
repeated bytes primary_key = 2; // Encoded using Plainbuffer.
repeated bytes token = 3;
repeated string columns_to_get = 4; // If not specified, 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;
}
|
Name |
Type |
Required |
Description |
|
table_name |
string |
Yes |
The name of the data table. |
|
primary_key |
bytes |
Yes |
The primary key columns for the specified row, including their names and values. The columns are encoded using Plainbuffer. For more information, see Plainbuffer. |
|
token |
bytes |
No |
The start position for the next read in a wide row read. This parameter is not currently available. |
|
columns_to_get |
string |
No |
The names of the columns to return. If not specified, all columns are returned. |
|
time_range |
Either this parameter or max_versions must be specified. |
The version range or specific version to read. Timestamps are in milliseconds and must be in the range [0, INT64.MAX].
|
|
|
max_versions |
int32 |
Either this parameter or time_range must be specified. |
The maximum number of versions to return per column. For example, if set to 2, at most two versions are returned for each column. |
|
filter |
bytes |
No |
The filter condition. This is the binary-serialized form of a Filter object encoded using protobuf. |
|
start_column |
string |
No |
The start column for the read operation, used primarily for wide row reads. Columns are sorted in lexicographical order by name, and the result includes the start column. For example, if a table has columns a, b, and c, and you set start_column to b, columns b and c are returned. |
|
end_column |
string |
No |
The end column for the read operation, used primarily for wide row reads. Columns are sorted in lexicographical order by name, and the result excludes the end column. For example, if a table has columns a, b, and c, and you set end_column to b, only column a is returned. |