IRelationalCommandDiagnosticsLogger.CommandCanceledAsync Method

Definition

Namespace:

Microsoft.EntityFrameworkCore.Diagnostics

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Logs for the CommandCanceled event.

public System.Threading.Tasks.Task CommandCanceledAsync (Microsoft.EntityFrameworkCore.Storage.IRelationalConnection connection, System.Data.Common.DbCommand command, Microsoft.EntityFrameworkCore.DbContext? context, Microsoft.EntityFrameworkCore.Diagnostics.DbCommandMethod executeMethod, Guid commandId, Guid connectionId, DateTimeOffset startTime, TimeSpan duration, Microsoft.EntityFrameworkCore.Diagnostics.CommandSource commandSource, System.Threading.CancellationToken cancellationToken = default);

abstract member CommandCanceledAsync : Microsoft.EntityFrameworkCore.Storage.IRelationalConnection * System.Data.Common.DbCommand * Microsoft.EntityFrameworkCore.DbContext * Microsoft.EntityFrameworkCore.Diagnostics.DbCommandMethod * Guid * Guid * DateTimeOffset * TimeSpan * Microsoft.EntityFrameworkCore.Diagnostics.CommandSource * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CommandCanceledAsync (connection As IRelationalConnection, command As DbCommand, context As DbContext, executeMethod As DbCommandMethod, commandId As Guid, connectionId As Guid, startTime As DateTimeOffset, duration As TimeSpan, commandSource As CommandSource, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

connection

IRelationalConnection

The connection.

command

DbCommand

The database command object.

context

DbContext

The DbContext currently being used, to null if not known.

executeMethod

DbCommandMethod

Represents the method that will be called to execute the command.

commandId

Guid

The correlation ID associated with the given DbCommand.

connectionId

Guid

The correlation ID associated with the DbConnection being used.

startTime

DateTimeOffset

The time that execution began.

duration

TimeSpan

The amount of time that passed until the exception was raised.

commandSource

CommandSource

Source of the command.

cancellationToken

CancellationToken

A CancellationToken to observe while waiting for the task to complete.

Returns

Task

A Task representing the async operation.

Exceptions

OperationCanceledException

If the CancellationToken is canceled.