Method DeleteIfVersionAsync

DeleteIfVersionAsync(String, MapValue, RowVersion, DeleteOptions, CancellationToken)

Deletes a row from a table if there is an existing row that matches the primary key and its RowVersion matches the provided value.
Declaration
public Task<DeleteResult<RecordValue>> DeleteIfVersionAsync(string tableName, MapValue primaryKey, RowVersion version, DeleteOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
String tableName Name of the table.
MapValue primaryKey Primary key of the row.
RowVersion version Row version to match.
DeleteOptions options (Optional) Options for the Delete operation. Note that the value of MatchVersion is not used for this API.
CancellationToken cancellationToken (Optional) Cancellation token.
Returns
Type Description
Task<DeleteResult<RecordValue>> Task returning DeleteResult<TRow>.
Remarks
This API is a shorthand for DeleteAsync(String, MapValue, DeleteOptions, CancellationToken) with MatchVersion specified.
Exceptions
Type Condition
ArgumentException If tableName is null or invalid or primaryKey is null or invalid or version is null or invalid or options contains invalid values.
TimeoutException Operation has timed out.
InvalidOperationException The table or the service is not in a valid state to perform this operation.
NoSQLException NoSQLException or one of its subclasses is thrown if operation cannot be performed for any other reason. See documentation for corresponding subclass of NoSQLException.
See Also