文档

TableInBatchGetRowRequest

更新时间:

在BatchGetRow操作中TableInBatchGetRowRequest表示单个读取表数据的配置。

数据结构

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

TimeRange

和max_versions必须至少存在一个

读取版本号范围或特定版本号的数据。

时间戳的单位是毫秒,取值范围为0到INT64.MAX。

  • 如果要查询一个范围的数据,则需要设置start_time和end_time。start_time和end_time分别表示起始时间戳和结束时间戳,范围为前闭后开区间,即[ start_time, end_time)

  • 如果要查询特定版本号的数据,则需要设置specific_time。specific_time表示特定的时间戳。

max_versions

int32

和time_range必须至少存在一个

最多读取的版本数。

如果指定max_versions为2,则每一列最多返回2个版本的数据。

filter

bytes

过滤条件表达式。Filter经过protobuf序列化后的二进制数据。

start_column

string

指定读取时的起始列,主要用于宽行读。

  • 返回的结果中包含当前起始列。

  • 列的顺序按照列名的字典序排序。

如果一张表有"a"、"b"、"c"三列,读取时指定start_column为“b”,则会从"b"列开始读,返回"b","c"两列。

end_column

string

指定读取时的结束列,主要用于宽行读。

  • 返回的结果中不包含当前结束列。

  • 列的顺序按照列名的字典序排序。

如果一张表有"a"、"b"、"c"三列,读取时指定end_column为“b”,则读到"b"列时会结束,返回"a"列。

相关操作

BatchGetRow