WriteMultipleResult

class borneo.WriteMultipleResult

Bases: borneo.operations.Result

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

If the WriteMultiple succeeds, the execution result of each sub operation can be retrieved using get_results().

If the WriteMultiple operation is aborted because of the failure of an operation with abort_if_unsuccessful set to True, then the index of failed operation can be accessed using get_failed_operation_index(), and the execution result of failed operation can be accessed using get_failed_operation_result().

Methods Summary

get_failed_operation_index()	Returns the index of failed operation that results in the entire WriteMultiple operation aborting.
get_failed_operation_result()	Returns the result of the operation that results in the entire WriteMultiple operation aborting.
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_results()	Returns the list of execution results for the operations.
get_success()	Returns True if the WriteMultiple operation succeeded, or False if the operation is aborted due to the failure of a sub operation.
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.
size()	Returns the number of results.

Methods Documentation

get_failed_operation_index()

Returns the index of failed operation that results in the entire WriteMultiple operation aborting.

Returns:the index of operation, -1 if not set. Return type:int

get_failed_operation_result()

Returns the result of the operation that results in the entire WriteMultiple operation aborting.

Returns:the result of the operation, None if not set. Return type:OperationResult or None

get_read_kb()

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 because this was an update operation.

Returns:the read KBytes consumed. Return type:int

get_read_units()

Returns the read throughput consumed by this operation, in read units. This number may be larger than that returned by get_read_kb() because it was an update operation.

Returns:the read units consumed. Return type:int

get_results()

Returns the list of execution results for the operations.

Returns:the list of execution results. Return type:list(OperationResult)

get_success()

Returns True if the WriteMultiple operation succeeded, or False if the operation is aborted due to the failure of a sub operation.

The failed operation index can be accessed using get_failed_operation_index() and its result can be accessed using get_failed_operation_result().

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

get_write_kb()

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

Returns:the write KBytes consumed. Return type:int

get_write_units()

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

Returns:the write units consumed. Return type:int

size()

Returns the number of results.

Returns:the number of results. Return type:int