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 |
いいえ |
フィルター条件です。これは、protobuf を使用してエンコードされた Filter オブジェクトのバイナリ形式でシリアル化されたものです。 |
|
start_column |
string |
いいえ |
読み取り操作の開始列です。主にワイド行読み取りで使用されます。列は名前の辞書順でソートされ、結果には開始列が含まれます。 たとえば、テーブルに列 a、b、c があり、start_column を b に設定した場合、列 b および c が返されます。 |
|
end_column |
string |
いいえ |
読み取り操作の終了列です。主にワイド行読み取りで使用されます。列は名前の辞書順でソートされ、結果には終了列は含まれません。 たとえば、テーブルに列 a、b、c があり、end_column を b に設定した場合、列 a のみが返されます。 |