edit-icon download-icon

TableInBatchGetRowRequest

最終更新日: Apr 17, 2018

BatchGetRow 操作で読み取るテーブルのリクエスト情報を示します。

データ構造

  1. message TableInBatchGetRowRequest {
  2. required string table_name = 1;
  3. repeated bytes primary_key = 2; // Plainbuffer encoding
  4. repeated bytes token = 3;
  5. repeated string columns_to_get = 4; // If it is not specified, all columns are read
  6. optional TimeRange time_range = 5;
  7. optional int32 max_versions = 6;
  8. optional bool cache_blocks = 7 [default = true]; // Whether the read data enters the BlockCache
  9. optional bytes filter = 8;
  10. optional string start_column = 9;
  11. optional string end_column = 10;
  12. }

table_name

  • 型: String

  • このテーブルの名前。

primary_key:

  • 型: Repeated bytes

  • 必須パラメーターか: はい

  • 主キーの名前と値を含む、行内のすべての主キー列。主キー列は Plainbuffer 形式でエンコードされます。詳細は、Plainbuffer encodingを参照してください。

token:

  • 型: Repeated bytes

  • 必須パラメーターか: いいえ

  • 次回に行の読み込み開始位置を指定します。現在は使用できません。

columns_to_get:

  • 型: repeated string

  • 説明: このテーブルから返されるすべての列の名前。

time_range:

  • 型: TimeRange

  • 必須パラメーターか: time_range と max_versionsどちらか1つが必要。

  • データのバージョンを読み込むためのタイムスタンプの範囲。

  • タイムスタンプの単位はミリ秒です。タイム・スタンプの最小値と最大値はそれぞれ 0 と INT64.MAX です。

  • データを照会するにはstart_time と end_time を指定します。

  • 特定のタイム・スタンプのデータを照会するには、specific_timeを指定します。

  • 例: time_rangeの値が(100,200)の場合、返される列のデータのタイムスタンプは[100,200]以内でなければなりません。

max_versions:

  • 型: int32

  • 必須パラメーターか: max_versions とtime_range どちらか1つが必要。

  • 返されるデータの最大バージョン数。

  • 例:max_versionsの値が2の場合、各列に対して最大2つのバージョンのデータが戻されます。

cache_blocks:

  • 型: Bool

  • 必須パラメーターか: いいえ

  • 読み込まれたデータがBlockCacheに入るかどうか。

  • デフォルト値はtrueです。

  • このパラメータは現在falseに設定することはできません。

rows

start_column:

  • 型: String

  • 必須パラメーターか: いいえ

  • 読み取り開始列。wide 行を読み取りために使用されます。

  • 返された結果には現在の開始列が含まれます。

  • 列名は辞書順にソートされます。

  • 例:表に “a”、 “b”、 “c”の列があり、start_columnの値が “b”の場合、列 “b”から読み込みが開始され、列 “b”と “c”が返されます。

end_column:

  • 型: String

  • 必須パラメーターか: いいえ

  • 読み込みの最後の列。wide 行を読み取るために使用されます。

  • 返された結果に現在の終了列が含まれていません。

  • 列名は辞書順にソートされます。

  • 例:表に “a”、 “b”、 “c”の列があり、end_columnの値が “b”の場合、列 “b”で読み込みが終了し、列 “a”が返されます。

関連する操作

BatchGetRow