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"列。 |