GetResult

class borneo.GetResult[source]

Bases: borneo.operations.Result

Represents the result of a NoSQLHandle.get() operation.

On a successful operation the value of the row is available using get_value() and the other state available in this class is valid. On failure that value is None and other state, other than consumed capacity, is undefined.

Methods Summary

get_expiration_time() Returns the expiration time of the row.
get_read_kb() Returns the read throughput consumed by this operation, in KBytes.
get_read_units() Returns the read throughput consumed by this operation, in read units.
get_value() Returns the value of the returned row, or None if the row does not exist.
get_version() Returns the Version of the row if the operation was successful, or None if the row does not exist.
get_write_kb() Returns the write throughput consumed by this operation, in KBytes.
get_write_units() Returns the write throughput consumed by this operation, in write units.

Methods Documentation

get_expiration_time()[source]

Returns the expiration time of the row. A zero value indicates that the row does not expire. This value is valid only if the operation successfully returned a row (get_value() returns non-none).

Returns:the expiration time in milliseconds since January 1, 1970, or zero if the row never expires or the row does not exist.
Return type:int
get_read_kb()[source]

Returns the read throughput consumed by this operation, in KBytes. This is the actual amount of data read by the operation. The number of read units consumed is returned by get_read_units() which may be a larger number if the operation used Consistency.ABSOLUTE.

Returns:the read KBytes consumed.
Return type:int
get_read_units()[source]

Returns the read throughput consumed by this operation, in read units. This number may be larger than that returned by get_read_kb() if the operation used Consistency.ABSOLUTE.

Returns:the read units consumed.
Return type:int
get_value()[source]

Returns the value of the returned row, or None if the row does not exist.

Returns:the value of the row, or None if it does not exist.
Return type:dict
get_version()[source]

Returns the Version of the row if the operation was successful, or None if the row does not exist.

Returns:the version of the row, or None if the row does not exist.
Return type:Version
get_write_kb()[source]

Returns the write throughput consumed by this operation, in KBytes.

Returns:the write KBytes consumed.
Return type:int
get_write_units()[source]

Returns the write throughput consumed by this operation, in write units.

Returns:the write units consumed.
Return type:int