Table of Contents

Class DbCommandInterceptor

Namespace
Microsoft.EntityFrameworkCore.Diagnostics
Assembly
Microsoft.EntityFrameworkCore.Relational.dll

Abstract base class for IDbCommandInterceptor for use when implementing a subset of the interface methods.

public abstract class DbCommandInterceptor : IDbCommandInterceptor, IInterceptor
Inheritance
DbCommandInterceptor
Implements
IInterceptor
Inherited Members

Remarks

See EF Core interceptors for more information and examples.

Constructors

DbCommandInterceptor() 

protected DbCommandInterceptor()

Methods

CommandCanceled(DbCommand, CommandEndEventData) 

public virtual void CommandCanceled(DbCommand command, CommandEndEventData eventData)

Parameters

command DbCommand
eventData CommandEndEventData

CommandCanceledAsync(DbCommand, CommandEndEventData, CancellationToken) 

public virtual Task CommandCanceledAsync(DbCommand command, CommandEndEventData eventData, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandEndEventData
cancellationToken CancellationToken

Returns

Task

CommandCreated(CommandEndEventData, DbCommand) 

public virtual DbCommand CommandCreated(CommandEndEventData eventData, DbCommand result)

Parameters

eventData CommandEndEventData
result DbCommand

Returns

DbCommand

CommandCreating(CommandCorrelatedEventData, InterceptionResult<DbCommand>) 

public virtual InterceptionResult<DbCommand> CommandCreating(CommandCorrelatedEventData eventData, InterceptionResult<DbCommand> result)

Parameters

eventData CommandCorrelatedEventData
result InterceptionResult<DbCommand>

Returns

InterceptionResult<DbCommand>

CommandFailed(DbCommand, CommandErrorEventData) 

public virtual void CommandFailed(DbCommand command, CommandErrorEventData eventData)

Parameters

command DbCommand
eventData CommandErrorEventData

CommandFailedAsync(DbCommand, CommandErrorEventData, CancellationToken) 

public virtual Task CommandFailedAsync(DbCommand command, CommandErrorEventData eventData, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandErrorEventData
cancellationToken CancellationToken

Returns

Task

CommandInitialized(CommandEndEventData, DbCommand) 

public virtual DbCommand CommandInitialized(CommandEndEventData eventData, DbCommand result)

Parameters

eventData CommandEndEventData
result DbCommand

Returns

DbCommand

DataReaderClosing(DbCommand, DataReaderClosingEventData, InterceptionResult) 

public virtual InterceptionResult DataReaderClosing(DbCommand command, DataReaderClosingEventData eventData, InterceptionResult result)

Parameters

command DbCommand
eventData DataReaderClosingEventData
result InterceptionResult

Returns

InterceptionResult

DataReaderClosingAsync(DbCommand, DataReaderClosingEventData, InterceptionResult) 

public virtual ValueTask<InterceptionResult> DataReaderClosingAsync(DbCommand command, DataReaderClosingEventData eventData, InterceptionResult result)

Parameters

command DbCommand
eventData DataReaderClosingEventData
result InterceptionResult

Returns

ValueTask<InterceptionResult>

DataReaderDisposing(DbCommand, DataReaderDisposingEventData, InterceptionResult) 

public virtual InterceptionResult DataReaderDisposing(DbCommand command, DataReaderDisposingEventData eventData, InterceptionResult result)

Parameters

command DbCommand
eventData DataReaderDisposingEventData
result InterceptionResult

Returns

InterceptionResult

NonQueryExecuted(DbCommand, CommandExecutedEventData, int) 

public virtual int NonQueryExecuted(DbCommand command, CommandExecutedEventData eventData, int result)

Parameters

command DbCommand
eventData CommandExecutedEventData
result int

Returns

int

NonQueryExecutedAsync(DbCommand, CommandExecutedEventData, int, CancellationToken) 

public virtual ValueTask<int> NonQueryExecutedAsync(DbCommand command, CommandExecutedEventData eventData, int result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandExecutedEventData
result int
cancellationToken CancellationToken

Returns

ValueTask<int>

NonQueryExecuting(DbCommand, CommandEventData, InterceptionResult<int>) 

public virtual InterceptionResult<int> NonQueryExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<int> result)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<int>

Returns

InterceptionResult<int>

NonQueryExecutingAsync(DbCommand, CommandEventData, InterceptionResult<int>, CancellationToken) 

public virtual ValueTask<InterceptionResult<int>> NonQueryExecutingAsync(DbCommand command, CommandEventData eventData, InterceptionResult<int> result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<int>
cancellationToken CancellationToken

Returns

ValueTask<InterceptionResult<int>>

ReaderExecuted(DbCommand, CommandExecutedEventData, DbDataReader) 

public virtual DbDataReader ReaderExecuted(DbCommand command, CommandExecutedEventData eventData, DbDataReader result)

Parameters

command DbCommand
eventData CommandExecutedEventData
result DbDataReader

Returns

DbDataReader

ReaderExecutedAsync(DbCommand, CommandExecutedEventData, DbDataReader, CancellationToken) 

public virtual ValueTask<DbDataReader> ReaderExecutedAsync(DbCommand command, CommandExecutedEventData eventData, DbDataReader result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandExecutedEventData
result DbDataReader
cancellationToken CancellationToken

Returns

ValueTask<DbDataReader>

ReaderExecuting(DbCommand, CommandEventData, InterceptionResult<DbDataReader>) 

public virtual InterceptionResult<DbDataReader> ReaderExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<DbDataReader> result)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<DbDataReader>

Returns

InterceptionResult<DbDataReader>

ReaderExecutingAsync(DbCommand, CommandEventData, InterceptionResult<DbDataReader>, CancellationToken) 

public virtual ValueTask<InterceptionResult<DbDataReader>> ReaderExecutingAsync(DbCommand command, CommandEventData eventData, InterceptionResult<DbDataReader> result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<DbDataReader>
cancellationToken CancellationToken

Returns

ValueTask<InterceptionResult<DbDataReader>>

ScalarExecuted(DbCommand, CommandExecutedEventData, object?) 

public virtual object? ScalarExecuted(DbCommand command, CommandExecutedEventData eventData, object? result)

Parameters

command DbCommand
eventData CommandExecutedEventData
result object

Returns

object

ScalarExecutedAsync(DbCommand, CommandExecutedEventData, object?, CancellationToken) 

public virtual ValueTask<object?> ScalarExecutedAsync(DbCommand command, CommandExecutedEventData eventData, object? result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandExecutedEventData
result object
cancellationToken CancellationToken

Returns

ValueTask<object>

ScalarExecuting(DbCommand, CommandEventData, InterceptionResult<object>) 

public virtual InterceptionResult<object> ScalarExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<object> result)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<object>

Returns

InterceptionResult<object>

ScalarExecutingAsync(DbCommand, CommandEventData, InterceptionResult<object>, CancellationToken) 

public virtual ValueTask<InterceptionResult<object>> ScalarExecutingAsync(DbCommand command, CommandEventData eventData, InterceptionResult<object> result, CancellationToken cancellationToken = default)

Parameters

command DbCommand
eventData CommandEventData
result InterceptionResult<object>
cancellationToken CancellationToken

Returns

ValueTask<InterceptionResult<object>>