edit-icon download-icon

GetRow

最終更新日: Apr 17, 2018

アクション:

GetRowは任意のプライマリキーに基づいて単一のデータ行を読み取ります。

リクエストの構造:

  1. message GetRowRequest {
  2. required string table_name = 1;
  3. required bytes primary_key = 2;
  4. repeated string columns_to_get = 3;
  5. optional TimeRange time_range = 4;
  6. optional int32 max_versions = 5;
  7. optional bytes filter = 7;
  8. optional string start_column = 8;
  9. optional string end_column = 9;
  10. optional bytes token = 10;
  11. }

table_name:

  • 型: string
  • 必須パラメーター: はい
  • 読み取るデータを保持するテーブルの名前。

primary_key:

  • 型: bytes
  • 必須パラメーター: はい
  • この行のすべてのプライマリキー列

columns_to_get:

  • 型: repeated string
  • 必須パラメーター: いいえ
  • 返されるすべての列の名前。null の場合、この行のすべての列が返されます。
  • 指定された列が存在しない場合は、この列に対するデータは返されません。
  • 重複する列名が指定された場合、戻り結果にはこの列は一度しか含まれません。
  • columns_to_get では、文字列の数が 128 を超えないようにする必要があります。

応答メッセージの構造:

  1. message GetRowResponse {
  2. required ConsumedCapacity consumed = 1;
  3. required bytes row = 2;
  4. }

consumed:

  • 型: CapacityUnit

  • この操作で消費される容量単位。

row:

  • 型: bytes

  • この行に対して返される一連の列データ。ここで、primary_key_columns と attribute_columns はそれぞれ、読み取られるプライマリキー列と属性列を格納します。その順序は、GetRowRequest の columns_to_get の順序とは整合しない場合があります。

  • この行が存在しない場合、primary_key_columns と attribute_columns は null になります。

容量単位の消費:

  • リクエストした行が存在しない場合は、1 つの読み取り容量単位が消費されます。
  • リクエストした行が存在する場合、消費された読み取り容量単位の数は、この行のすべてのデータを 1 KB で除算して切り上げたサイズです。
  • リクエストタイムアウトが発生し、結果が定義されていない場合は、容量単位が消費される場合とされない場合、どちらもありえます。
  • 内部エラーコード (HTTP ステータスコード: 5XX) が返される場合、この操作では容量単位が消費されません。その他のエラーが返された場合は、1 つの読み取り容量単位が消費されます。