View Source

Class ThrottlingCondition

Implements an object holding the decoded reason code returned from SQL Azure when encountering throttling conditions.

Inheritance

System.Object

Namespace: Umbraco.Cms.Persistence.SqlServer.FaultHandling.Strategies

Assembly: Umbraco.Cms.Persistence.SqlServer.dll

Syntax

public class ThrottlingCondition

Fields

ThrottlingErrorNumber

Gets the error number that corresponds to throttling conditions reported by SQL Azure.

Declaration

public const int ThrottlingErrorNumber = 40501

Field Value

Type	Description
System.Int32

Properties

IsThrottledOnCpu

Gets a value indicating whether CPU throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnCpu { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnDatabaseSize

Gets a value indicating whether database size throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnDatabaseSize { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnDataRead

Gets a value indicating whether data read activity throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnDataRead { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnDataSpace

Gets a value indicating whether physical data file space throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnDataSpace { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnLogSpace

Gets a value indicating whether physical log space throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnLogSpace { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnLogWrite

Gets a value indicating whether transaction activity throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnLogWrite { get; }

Property Value

Type	Description
System.Boolean

IsThrottledOnWorkerThreads

Gets a value indicating whether concurrent requests throttling was reported by SQL Azure.

Declaration

public bool IsThrottledOnWorkerThreads { get; }

Property Value

Type	Description
System.Boolean

IsUnknown

Gets a value indicating whether throttling conditions were not determined with certainty.

Declaration

public bool IsUnknown { get; }

Property Value

Type	Description
System.Boolean

ThrottledResources

Gets a list of resources in SQL Azure that were subject to throttling conditions.

Declaration

public IEnumerable<Tuple<ThrottledResourceType, ThrottlingType>> ThrottledResources { get; }

Property Value

Type	Description
IEnumerable<Tuple<ThrottledResourceType, ThrottlingType>>

ThrottlingMode

Gets the value that reflects the throttling mode in SQL Azure.

Declaration

public ThrottlingMode ThrottlingMode { get; }

Property Value

Type	Description
ThrottlingMode

Unknown

Gets an unknown throttling condition in the event the actual throttling condition cannot be determined.

Declaration

public static ThrottlingCondition Unknown { get; }

Property Value

Type	Description
ThrottlingCondition

Methods

FromError(Nullable<SqlError>)

Determines the throttling conditions from the specified SQL error.

Declaration

public static ThrottlingCondition FromError(SqlError? error)

Parameters

Type	Name	Description
System.Nullable<SqlError>	error	The object containing information relevant to a warning or error returned by SQL Server.

Returns

Type	Description
ThrottlingCondition	An instance of the object holding the decoded reason codes returned from SQL Azure when encountering throttling conditions.

FromException(Nullable<SqlException>)

Determines throttling conditions from the specified SQL exception.

Declaration

public static ThrottlingCondition FromException(SqlException? ex)

Parameters

Type	Name	Description
System.Nullable<SqlException>	ex	The object containing information relevant to an error returned by SQL Server when encountering throttling conditions.

Returns

Type	Description
ThrottlingCondition	An instance of the object holding the decoded reason codes returned from SQL Azure upon encountering throttling conditions.

FromReasonCode(Int32)

Determines the throttling conditions from the specified reason code.

Declaration

public static ThrottlingCondition FromReasonCode(int reasonCode)

Parameters

Type	Name	Description
System.Int32	reasonCode	The reason code returned by SQL Azure which contains the throttling mode and the exceeded resource types.

Returns

Type	Description
ThrottlingCondition	An instance of the object holding the decoded reason codes returned from SQL Azure when encountering throttling conditions.

ToString()

Returns a textual representation the current ThrottlingCondition object including the information held with respect to throttled resources.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current ThrottlingCondition object.