すべてのプロダクト
Search
ドキュメントセンター

Tablestore:TableInBatchGetRowRequest

最終更新日:Dec 28, 2024

データテーブルの構成を読み取ります。

データ構造

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

time_range と max_versions の少なくともいずれかを設定する必要があります。

読み取るバージョンの範囲または特定のバージョン。

このパラメータの値は、ミリ秒単位のタイムスタンプです。有効な値:0 ~ INT64.MAX。

  • 特定の期間内のバージョンのデータをクエリするには、start_time と end_time を設定する必要があります。 start_time は開始タイムスタンプを示します。 end_time は終了タイムスタンプを示します。指定された範囲には、開始タイムスタンプが含まれ、終了タイムスタンプは含まれません。

  • 特定のバージョンのデータをクエリするには、specific_time を設定する必要があります。 specific_time は特定のタイムスタンプを示します。

max_versions

int32

max_versions と time_range の少なくともいずれかを設定する必要があります。

読み取ることができるデータバージョンの最大数。

max_versions の値が 2 の場合、各列について最大 2 つのバージョンのデータが返されます。

filter

bytes

いいえ

フィルター条件の式。フィルター条件の式は、Protobuf を使用してバイナリデータとしてシリアル化されます。詳細については、Filter を参照してください。

start_column

string

いいえ

行内の読み取り操作を開始する列。このパラメータは、ワイドカラムを読み取るために使用されます。

  • レスポンスには、指定された開始列が含まれます。

  • 列は、名前のアルファベット順にソートされます。

たとえば、テーブルに列「a」、「b」、および「c」が含まれており、start_column の値が「b」の場合、読み取り操作は列「b」から開始され、列「b」と「c」が返されます。

end_column

string

いいえ

行内の読み取り操作を終了する列。このパラメータは、ワイドカラムを読み取るために使用されます。

  • レスポンスには、指定された終了列は含まれません。

  • 列は、名前のアルファベット順にソートされます。

たとえば、テーブルに列「a」、「b」、および「c」が含まれており、end_column の値が「b」の場合、読み取り操作は列「b」で終了し、列「a」のみが返されます。

参照

BatchGetRow