DeleteResult¶

class borneo.DeleteResult[source]¶

Bases: borneo.operations.WriteResult

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

If the delete succeeded get_success() returns True. Information about the existing row on failure may be available using get_existing_value() and get_existing_version(), depending on the use of DeleteRequest.set_return_row().

Methods Summary

`get_existing_modification_time`()	Returns the existing row modification time if available.
`get_existing_value`()	Returns the existing row value if available.
`get_existing_version`()	Returns the existing row `Version` if available.
`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_success`()	Returns True if the delete operation succeeded.
`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_existing_modification_time()[source]¶

Returns the existing row modification time if available. It will be available if the target row exists and the operation failed because of a Version mismatch and the corresponding DeleteRequest the method DeleteRequest.set_return_row() was called with a True value.

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

get_existing_value()[source]¶

Returns the existing row value if available. It will be available if the target row exists and the operation failed because of a Version mismatch and the corresponding DeleteRequest the method DeleteRequest.set_return_row() was called with a True value.

Returns:	the value.
Return type:	dict

get_existing_version()[source]¶

Returns the existing row Version if available. It will be available if the target row exists and the operation failed because of a Version mismatch and the corresponding DeleteRequest the method DeleteRequest.set_return_row() was called with a True value.

Returns:	the version.
Return type:	Version

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

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() because it was an update operation.

Returns:	the read units consumed.
Return type:	int

get_success()[source]¶

Returns True if the delete operation succeeded.

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

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