GetRow

Action:

Reads a single data row based on a given primary key.

Request Structure:

message GetRowRequest {
    required string table_name = 1;
    repeated Column primary_key = 2;
    repeated string columns_to_get = 3;
}

table_name:

• Type: string

• Required Parameter: Yes

• The name of the table holding the data to be read.

primary_key:

• Type: repeated Column

• Required Parameter: Yes

• All primary key columns of this row.

columns_to_get:

• Type: repeated string

• Required Parameter: No

• The names of all columns to be returned. If null, all columns of this row will be returned.

• If the specified column does not exist, data will not be returned for this column.

• If a duplicate column name is given, the return results will only include this column once.

• In columns_to_get, the number of strings should not exceed 128.

Response Message Structure:

message GetRowResponse {
    required ConsumedCapacity consumed = 1;
    required Row row = 2;
}

consumed:

• Type: CapacityUnit

• The capacity units consumed by this operation.

row:

• Type: Row

• The collection of column data to be returned for this row. Here, primary_key_columns and attribute_columns respectively store primary key columns and attribute columns that are read. Their order may not be consistent with that of columns_to_get in GetRowRequest.

• If this row does not exist, primary_key_columns and attribute_columns will be null.

Capacity Unit Consumption:

• If the requested row does not exist, 1 read capacity unit is consumed.

• If the requested row exists, the number of consumed read capacity units is the size of all data from this row divided by 1KB and rounded up. For information on data size calculation, please refer to Billing Explanation.

• If request timeout occurs and the results are undefined, a capacity unit may or may not be consumed.

• If an internal error code is returned (HTTP status code: 5XX), this operation will not consume capacity units. If other errors are returned, it will consume 1 read capacity unit.

Request Example:

GetRowRequest {
  table_name: "consume_history"
  primary_key {
    name: "CardID"
    value {
      type: STRING
      v_string: "2007035023"
    }
  }
  primary_key {
    name: "SellerID"
    value {
      type: STRING
      v_string: "00022"
    }
  }
  primary_key {
    name: "DeviceID"
    value {
      type: STRING
      v_string: "061104"
    }
  }
  primary_key {
    name: "OrderNumber"
    value {
      type: INTEGER
      v_int: 142857
    }
  }
  columns_to_get: "CardID"
  columns_to_get: "SellerID"
  columns_to_get: "DeviceID"
  columns_to_get: "OrderNumber"
  columns_to_get: "Amount"
  columns_to_get: "Remarks"
}

Response Example:

GetRowResponse {
  consumed {
    capacity_unit {
      read: 1
    }
  }
  row {
    primary_key_columns {
      name: "CardID"
      value {
        type: STRING
        v_string: "2007035023"
      }
    }
    primary_key_columns {
      name: "SellerID"
      value {
        type: STRING
        v_string: "00022"
      }
    }
    primary_key_columns {
      name: "DeviceID"
      value {
        type: STRING
        v_string: "061104"
      }
    }
    primary_key_columns {
      name: "OrderNumber"
      value {
        type: INTEGER
        v_int: 142857
      }
    }
    attribute_columns {
      name: "Amount"
      value {
        type: DOUBLE
        v_double: 2.5
      }
    }
    attribute_columns {
      name: "Remarks"
      value {
        type: STRING
        v_string: "ice cream"
      }
    }
  }
}