BatchGetRow 操作中,用于指定单张数据表读取配置的消息结构。
数据结构
message TableInBatchGetRowRequest {
required string table_name = 1;
repeated bytes primary_key = 2; //由Plainbuffer编码。
repeated bytes token = 3;
repeated string columns_to_get = 4; // 不指定则读出所有的列。
optional TimeRange time_range = 5;
optional int32 max_versions = 6;
optional bytes filter = 8;
optional string start_column = 9;
optional string end_column = 10;
}
|
名称 |
类型 |
是否必须 |
描述 |
|
table_name |
string |
是 |
数据表名称。 |
|
primary_key |
bytes |
是 |
指定行的全部主键列,包含主键名和主键值,由 Plainbuffer 编码。更多信息,请参见Plainbuffer。 |
|
token |
bytes |
否 |
宽行读取时指定下一次读取的起始位置,暂不可用。 |
|
columns_to_get |
string |
否 |
要返回的列名列表。不指定则返回所有列。 |
|
time_range |
和 max_versions 必须至少存在一个 |
读取指定版本范围或特定版本的数据。时间戳单位为毫秒,取值范围为 [0, INT64.MAX]。
|
|
|
max_versions |
int32 |
和 time_range 必须至少存在一个 |
每列最多返回的版本数。例如,设置为 2 时,每列最多返回 2 个版本的数据。 |
|
filter |
bytes |
否 |
筛选条件表达式,即Filter对象经 protobuf 序列化后的二进制数据。 |
|
start_column |
string |
否 |
读取的起始列,主要用于宽行读取。列按列名字典序排序,返回结果包含起始列。 例如,表中有"a"、"b"、"c"三列,指定 start_column 为"b"时,返回"b"和"c"两列。 |
|
end_column |
string |
否 |
读取的结束列,主要用于宽行读取。列按列名字典序排序,返回结果不包含结束列。 例如,表中有"a"、"b"、"c"三列,指定 end_column 为"b"时,仅返回"a"列。 |
相关操作
该文章对您有帮助吗?