Class SqlCmdMessage

Namespace

ItTiger.TigerQuery.Events

Assembly

ItTiger.TigerQuery.dll

Represents a SQL Server informational/error message or an exception converted to the engine's message model.

public sealed class SqlCmdMessage

Inheritance

object

SqlCmdMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Fields

SeverityException

Gets the synthetic severity assigned to non-SQL exceptions.

public const byte SeverityException = 254

Field Value

byte

SeverityFatalException

Gets the synthetic severity assigned to TigerQueryException.

public const byte SeverityFatalException = 255

Field Value

byte

Properties

IsError

Gets whether the category is a warning, error, or exception.

public bool IsError { get; }

Property Value

bool

IsFatalError

Gets whether the category is a fatal SQL error or fatal exception.

public bool IsFatalError { get; }

Property Value

bool

LineNumber

Gets the SQL Server-reported one-based line number, or null when unavailable.

public int? LineNumber { get; init; }

Property Value

int?

Remarks

SQL Server line numbers are relative to the submitted batch.

Number

Gets the SQL Server error number, or -1 for converted exceptions.

public int Number { get; }

Property Value

int

Procedure

Gets the SQL Server stored-procedure name when one was reported.

public string? Procedure { get; }

Property Value

string

Severity

Gets the SQL Server or synthetic severity.

public byte Severity { get; init; }

Property Value

byte

State

Gets the SQL Server state value, or zero for converted exceptions.

public byte State { get; }

Property Value

byte

Text

Gets the message text.

public string Text { get; init; }

Property Value

string

Timestamp

Gets the UTC time at which the message object was created.

public DateTime Timestamp { get; init; }

Property Value

DateTime

Type

Gets the category derived from Severity.

public SqlCmdMessageType Type { get; }

Property Value

SqlCmdMessageType

Methods

FromException(Exception)

Creates a synthetic message from a non-SQL exception.

public static SqlCmdMessage FromException(Exception exception)

Parameters

exception Exception

The exception whose message and category are copied.

Returns

SqlCmdMessage

A fatal-exception message for TigerQueryException; otherwise a nonfatal exception message.

FromSqlError(SqlError)

Creates a message from a SQL Server error.

public static SqlCmdMessage FromSqlError(SqlError error)

Parameters

error SqlError

The provider error to copy.

Returns

SqlCmdMessage

A message containing the provider's diagnostics.

ToString()

Formats the timestamp, category, severity, and message text.

public override string ToString()

Returns

string

A concise display string for the message.