TableInBatchGetRowRequest は、BatchGetRow 操作で読み取りを行うテーブルのリクエスト情報を示します。

データ構造

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

				
table_name:
  • データ型:String

  • テーブルの名前。

primary_key:
  • データ型:Repeated bytes

  • 必須 / 省略可能:必須

  • 行内のすべての主キー列 (主キーの名前と値を含む) 。 主キー列は Plainbuffer 形式でエンコードされます。 詳細については、Plainbuffer エンコーディングをご参照ください。

token:
  • データ型:Repeated bytes

  • 必須 / 省略可能:省略可能

  • 次に読み込みを行う (現在は使用不可の) ワイド行の開始位置を指定します。

columns_to_get:
  • データ型:Repeated string

  • 該当のテーブルから返されるすべての列の名前。

time_range:
  • データ型:TimeRange

  • 必須 / 省略可能:time_range または max_versions のいずれか、または両方が存在する必要があります。

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

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

  • 時間範囲のデータを照会するには、 start_time および end_time を指定します。

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

  • 例:time_range の値が (100、200) の場合、返される列データのタイムスタンプは [100、200) 以内である必要があります。

max_versions:
  • データ型:int32

  • 必須 / 省略可能:少なくとも max_versions、 time_range のいずれかが存在する必要があります。

  • 返される結果の最大数です。

  • 例:max_versions の値が 2 の場合、列ごとに最大 2 つのバージョンのデータが返されます。

cache_blocks:
  • データ型:Bool

  • 必須 / 省略可能:省略可能

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

  • 既定値:true

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

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