Table of Contents

Namespace Microsoft.EntityFrameworkCore.Diagnostics

Classes

BatchEventData

The DiagnosticSource event payload for RelationalEventId batch events.

CommandCorrelatedEventData

The DiagnosticSource event payload for events correlated with a DbCommand.

CommandEndEventData

The DiagnosticSource event payload for RelationalEventId command end events.

CommandErrorEventData

The DiagnosticSource event payload for CommandError.

CommandEventData

The DiagnosticSource event payload for RelationalEventId command events.

CommandExecutedEventData

The DiagnosticSource event payload for CommandExecuted.

ConnectionEndEventData

The DiagnosticSource event payload class for RelationalEventId connection ending events.

ConnectionErrorEventData

The DiagnosticSource event payload for ConnectionError.

ConnectionEventData

The DiagnosticSource event payload base class for RelationalEventId connection events.

DataReaderDisposingEventData

DiagnosticSource event payload for DataReaderDisposing.

DbCommandInterceptor

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

DbConnectionInterceptor

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

DbTransactionInterceptor

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

EntityTypeSchemaEventData

The DiagnosticSource event payload base class for events that reference an entity type and a schema

IndexEventData

A DiagnosticSource event payload class for the events involving an invalid index.

IndexWithPropertiesEventData

A DiagnosticSource event payload class for the IndexPropertiesMappedToNonOverlappingTables event.

IndexWithPropertyEventData

A DiagnosticSource event payload class for the events involving an invalid property name on an index.

MigrationAssemblyEventData

The DiagnosticSource event payload for RelationalEventId migrations assembly events.

MigrationEventData

The DiagnosticSource event payload for RelationalEventId events of a specific migration.

MigrationScriptingEventData

The DiagnosticSource event payload for RelationalEventId migration scripting events.

MigrationTypeEventData

The DiagnosticSource event payload for RelationalEventId migration events.

MigratorConnectionEventData

The DiagnosticSource event payload for RelationalEventId migration connection events.

MigratorEventData

The DiagnosticSource event payload for RelationalEventId migration events.

MinBatchSizeEventData

The DiagnosticSource event payload for RelationalEventId min batch size events.

RelationalEventId

Event IDs for relational events that correspond to messages logged to an ILogger and events sent to a DiagnosticSource.

These IDs are also used with Microsoft.EntityFrameworkCore.Diagnostics.WarningsConfigurationBuilder to configure the behavior of warnings.

RelationalLoggerExtensions

This class contains static methods used by EF Core internals and relational database providers to write information to an ILogger and a DiagnosticListener for well-known events.

This type is typically used by database providers (and other extensions). It is generally not used in application code.

RelationalLoggingDefinitions

Contains placeholders for caching of Microsoft.EntityFrameworkCore.Diagnostics.EventDefinitionBase.

This class is public so that it can be inherited by database providers to add caching for their events. It should not be used for any other purpose.

RelationalStrings

String resources used in EF exceptions, etc.

These strings are exposed publicly for use by database providers and extensions. It is unusual for application code to need these strings.

SequenceEventData

The DiagnosticSource event payload base class for events that reference a sequence.

TransactionEndEventData

The DiagnosticSource event payload base class for RelationalEventId transaction end events.

TransactionEnlistedEventData

The DiagnosticSource event payload for RelationalEventId transaction enlisted events.

TransactionErrorEventData

The DiagnosticSource event payload base class for RelationalEventId transaction error events.

TransactionEventData

The DiagnosticSource event payload base class for RelationalEventId transaction events.

TransactionStartingEventData

The DiagnosticSource event payload base class for RelationalEventId transaction events.

TwoSqlExpressionsEventData

The DiagnosticSource event payload base class for events that references two SqlExpression.

Interfaces

IDbCommandInterceptor

Allows interception of commands sent to a relational database.

Command interceptors can be used to view, change, or suppress execution of the DbCommand, and to modify the result before it is returned to EF.

Consider inheriting from DbCommandInterceptor if not implementing all methods.

Use Microsoft.EntityFrameworkCore.DbContextOptionsBuilder.AddInterceptors(Microsoft.EntityFrameworkCore.Diagnostics.IInterceptor[]) to register application interceptors.

Extensions can also register interceptors in the internal service provider. If both injected and application interceptors are found, then the injected interceptors are run in the order that they are resolved from the service provider, and then the application interceptors are run last.

IDbConnectionInterceptor

Allows interception of operations on DbConnection.

Connection interceptors can be used to view, change, or suppress the operation on DbConnection, and to modify the result before it is returned to EF.

Consider inheriting from DbConnectionInterceptor if not implementing all methods.

Use Microsoft.EntityFrameworkCore.DbContextOptionsBuilder.AddInterceptors(Microsoft.EntityFrameworkCore.Diagnostics.IInterceptor[]) to register application interceptors.

Extensions can also register interceptors in the internal service provider. If both injected and application interceptors are found, then the injected interceptors are run in the order that they are resolved from the service provider, and then the application interceptors are run last.

IDbTransactionInterceptor

Allows interception of operations related to a DbTransaction.

Transaction interceptors can be used to view, change, or suppress operations on DbTransaction, and to modify the result before it is returned to EF.

Consider inheriting from DbTransactionInterceptor if not implementing all methods.

Use Microsoft.EntityFrameworkCore.DbContextOptionsBuilder.AddInterceptors(Microsoft.EntityFrameworkCore.Diagnostics.IInterceptor[]) to register application interceptors.

Extensions can also register interceptors in the internal service provider. If both injected and application interceptors are found, then the injected interceptors are run in the order that they are resolved from the service provider, and then the application interceptors are run last.

Enums

DbCommandMethod

Enum used by CommandEventData, an subclasses to indicate the method on DbCommand being used to execute the command.