MultiDeleteResult¶

class borneo.MultiDeleteResult[source]¶

Bases: borneo.operations.Result

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

On a successful operation the number of rows deleted is available using get_num_deletions(). There is a limit to the amount of data consumed by a single call. If there are still more rows to delete, the continuation key can be get using get_continuation_key().

Methods Summary

`get_continuation_key`()	Returns the continuation key where the next MultiDelete request resume from.
`get_num_deletions`()	Returns the number of rows deleted from the table.
`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_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_continuation_key()[source]¶

Returns the continuation key where the next MultiDelete request resume from.

Returns:	the continuation key, or None if there are no more rows to delete.
Return type:	bytearray

get_num_deletions()[source]¶

Returns the number of rows deleted from the table.

Returns:	the number of rows deleted.
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 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_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