DbBatch.ExecuteNonQueryAsync(CancellationToken) Method

Definition

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbBatch.cs

This is the asynchronous version of ExecuteNonQuery(). Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteNonQuery() method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery() will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.

public abstract System.Threading.Tasks.Task<int> ExecuteNonQueryAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ExecuteNonQueryAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public MustOverride Function ExecuteNonQueryAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)

Parameters

cancellationToken

CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<Int32>

A task representing the asynchronous operation.

Exceptions

DbException

An error occurred while executing the batch.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

For more information about asynchronous programming, see Asynchronous Programming.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ExecuteNonQuery().

See also

• ADO.NET Overview