DbBatch.PrepareAsync(CancellationToken) Method

Definition

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbBatch.cs

Asynchronously creates a prepared (or compiled) version of the batch, or of each of its commands, on the data source.

public abstract System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public MustOverride Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken

CancellationToken

An optional token to cancel the asynchronous operation. The default value is None.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

OperationCanceledException

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

Remarks

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 Prepare().