EventDefinition<TParam> Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Diagnostics

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v2.0.3

Package:: Microsoft.EntityFrameworkCore v2.1.11

Package:: Microsoft.EntityFrameworkCore v2.2.6

Package:: Microsoft.EntityFrameworkCore v3.0.0

Package:: Microsoft.EntityFrameworkCore v3.1.0

Package:: Microsoft.EntityFrameworkCore v5.0.0

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

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.

Defines metadata for an event with one parameter and a cached delegate to log the event with reduced allocations.

public class EventDefinition<TParam> : Microsoft.EntityFrameworkCore.Diagnostics.EventDefinitionBase

type EventDefinition<'Param> = class
    inherit EventDefinitionBase

Public Class EventDefinition(Of TParam)
Inherits EventDefinitionBase

Type Parameters

TParam

Inheritance: Object

EventDefinitionBase
EventDefinition<TParam>

Remarks

See Implementation of database providers and extensions for more information and examples.

Constructors

EventDefinition<TParam>(EventId, LogLevel, Action<ILogger,TParam,Exception>)	Creates an event definition instance.
EventDefinition<TParam>(EventId, LogLevel, String, Action<ILogger,TParam,Exception>)	Creates an event definition instance.
EventDefinition<TParam>(ILoggingOptions, EventId, LogLevel, String, Func<LogLevel,Action<ILogger,TParam,Exception>>)	Creates an event definition instance.

Properties

EventId	The EventId. (Inherited from EventDefinitionBase)
EventIdCode	A string representing the code that should be passed to ConfigureWarnings(Action<WarningsConfigurationBuilder>) to suppress this event as an error. (Inherited from EventDefinitionBase)
Level	The LogLevel at which the event will be logged. (Inherited from EventDefinitionBase)
WarningBehavior	The configured WarningBehavior. (Inherited from EventDefinitionBase)

Methods

GenerateMessage(TParam, Exception)	Generates the message that would be logged without logging it. Typically used for throwing an exception in warning-as-error cases.
GenerateMessage(TParam)	Generates the message that would be logged without logging it. Typically used for throwing an exception in warning-as-error cases.
GetLogBehavior<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>)	Gets the log behavior for this event. This determines whether it should be logged, thrown as an exception or ignored. (Inherited from EventDefinitionBase)
Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>, TParam, Exception)	Obsolete. Logs the event, or throws if the event has been configured to be treated as an error.
Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>, TParam)	Logs the event, or throws if the event has been configured to be treated as an error.
Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>, WarningBehavior, TParam, Exception)	Logs the event, or throws if the event has been configured to be treated as an error.
Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>, WarningBehavior, TParam)	Logs the event, or throws if the event has been configured to be treated as an error.
WarningAsError(String)	Returns a warning-as-error exception wrapping the given message for this event. (Inherited from EventDefinitionBase)

Applies to

Share via