DbTransaction.RollbackAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
RollbackAsync(CancellationToken) |
Asynchronously rolls back a transaction from a pending state. |
RollbackAsync(String, CancellationToken) |
Rolls back all commands that were executed after the specified savepoint was established. |
RollbackAsync(CancellationToken)
- Source:
- DbTransaction.cs
- Source:
- DbTransaction.cs
- Source:
- DbTransaction.cs
Asynchronously rolls back a transaction from a pending state.
public virtual System.Threading.Tasks.Task RollbackAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member RollbackAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RollbackAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function RollbackAsync (Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
- cancellationToken
- CancellationToken
An optional token to cancel the asynchronous operation. The default value is None.
Returns
A task representing the asynchronous operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
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 Rollback().
Applies to
RollbackAsync(String, CancellationToken)
- Source:
- DbTransaction.cs
- Source:
- DbTransaction.cs
- Source:
- DbTransaction.cs
Rolls back all commands that were executed after the specified savepoint was established.
public virtual System.Threading.Tasks.Task RollbackAsync (string savepointName, System.Threading.CancellationToken cancellationToken = default);
abstract member RollbackAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RollbackAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function RollbackAsync (savepointName As String, Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
- savepointName
- String
The name of the savepoint to roll back to.
- cancellationToken
- CancellationToken
An optional token to cancel the asynchronous operation. The default value is None.
Returns
A Task representing the asynchronous operation.
Exceptions
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 Rollback(String).