DbConnection.BeginTransactionAsync Method

Definition

Overloads

BeginTransactionAsync(CancellationToken)

Asynchronously begins a database transaction.

BeginTransactionAsync(IsolationLevel, CancellationToken)

Asynchronously begins a database transaction.

BeginTransactionAsync(CancellationToken)

Asynchronously begins a database transaction.

public System.Threading.Tasks.ValueTask<System.Data.Common.DbTransaction> BeginTransactionAsync (System.Threading.CancellationToken cancellationToken = default);
member this.BeginTransactionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Data.Common.DbTransaction>
Public Function BeginTransactionAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of DbTransaction)

Parameters

cancellationToken
CancellationToken

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

Returns

ValueTask<DbTransaction>

A task whose Result property is an object representing the new transaction.

Remarks

If you do not specify an isolation level, the default isolation level for the specific type of connection is used.

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.

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

Applies to

BeginTransactionAsync(IsolationLevel, CancellationToken)

Asynchronously begins a database transaction.

public System.Threading.Tasks.ValueTask<System.Data.Common.DbTransaction> BeginTransactionAsync (System.Data.IsolationLevel isolationLevel, System.Threading.CancellationToken cancellationToken = default);
member this.BeginTransactionAsync : System.Data.IsolationLevel * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Data.Common.DbTransaction>
Public Function BeginTransactionAsync (isolationLevel As IsolationLevel, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of DbTransaction)

Parameters

isolationLevel
IsolationLevel

One of the enumeration values that specifies the isolation level for the transaction to use.

cancellationToken
CancellationToken

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

Returns

ValueTask<DbTransaction>

A task whose Result property is an object representing the new transaction.

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.

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 BeginTransaction(IsolationLevel).

Applies to