OperationResult¶

class borneo.OperationResult[source]¶

Bases: WriteResult

A single Result associated with the execution of an individual operation in a NoSQLHandle.write_multiple() request. A list of OperationResult is contained in WriteMultipleResult and obtained using WriteMultipleResult.get_results().

Methods Summary

`get_existing_modification_time`()	Returns the existing row modification time if available.
`get_existing_value`()	Returns the previous row value associated with the key if available.
`get_existing_version`()	Returns the existing row version associated with the key if available.
`get_generated_value`()	Returns the value generated if the operation created a new value.
`get_success`()	Returns the flag indicates whether the operation succeeded.
`get_version`()	Returns the version of the new row for put operation, or None if put operations did not succeed or the operation is delete operation.

Methods Documentation

get_existing_modification_time()[source]¶

Returns the existing row modification time if available.

Returns:: the modification time in milliseconds since January 1, 1970
Return type:: int
Versionadded:: 5.3.0

get_existing_value()[source]¶

Returns the previous row value associated with the key if available.

Returns:: the previous row value
Return type:: dict

get_existing_version()[source]¶

Returns the existing row version associated with the key if available.

Returns:: the existing row version
Return type:: Version

get_generated_value()[source]¶

Returns the value generated if the operation created a new value. This can happen if the table contains an identity column or string column declared as a generated UUID. If the table has no such columns this value is None. If a value was generated for the operation, it is non-None.

This value is only valid for a put operation on a table with an identity column or string as uuid column.

Returns:: the generated value.

get_success()[source]¶

Returns the flag indicates whether the operation succeeded. A put or delete operation may be unsuccessful if the condition is not matched.

Returns:: True if the operation succeeded.
Return type:: bool

get_version()[source]¶

Returns the version of the new row for put operation, or None if put operations did not succeed or the operation is delete operation.

Returns:: the version.
Return type:: Version