DbCommand.PrepareAsync(CancellationToken) Method

Definition

Asynchronously creates a prepared (or compiled) version of the command on the data source.

public virtual System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = null);
abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

cancellationToken
CancellationToken

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

Returns

A Task representing the asynchronous operation.

Remarks

The default implementation of this asynchronous method delegates to its synchronous counterpart and returns a completed Task, potentially blocking the calling thread.

Data providers that support asynchronous programming should override the default implementation using asynchronous I/O operations.

If the CommandType property is set to TableDirect, PrepareAsync does nothing. If CommandType is set to StoredProcedure, the call to PrepareAsync should succeed, although it may result in a no-op.

Applies to