RuleDescriptor Class

SQL Server 2014

Updated: April 20, 2017

Describes a rule discovered by the rule engine and supports configuration of its properties. Descriptors inherit properties from RuleConfiguration, to support enabling/disabling the rule during analysis and specifying the severity for problems created by the rule. This class is not intended to be subclasses by external users - instances of RuleDescriptor are created by the analysis service.

Namespace: Microsoft.SqlServer.Dac.CodeAnalysis
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Inheritance Hierarchy

System::Object
Microsoft.SqlServer.Dac.CodeAnalysis::RuleConfiguration
Microsoft.SqlServer.Dac.CodeAnalysis::RuleDescriptor

Syntax

C++

public ref class RuleDescriptor abstract : RuleConfiguration

Constructors

	Name	Description
	RuleDescriptor(String^)	Protected constructor to be called by implementing classes.

Properties

	Name	Description
	DisplayDescription	The description of the rule. This should be a short human readable description of what the rule is intended to warn against or block. This is automatically read from the Metadata property
	DisplayName	Display name describing the rule. This is automatically read from the Metadata property
	Enabled	Gets or sets a value that indicates whether the rule is enabled and should be included in the code analysis. The default value is true.(Inherited from RuleConfiguration.)
	Metadata	The ISqlAnalysisRuleMetadata describing the rule. This is a required property that must be defined by subclasses.
	Namespace	Gets the namespace for the rule. This is the part of the rule that precedes the final "." in the ID name. For instance for a rule ID "My.Org.MyRuleName", the namespace would be "My.Org".(Inherited from RuleConfiguration.)
	Rule	The actual instance of the SqlAnalysisRule
	RuleId	Gets the unique ID used to identify the rule. This is the fully qualified ID, which would usually be in the form "My.Org.MyRuleName".(Inherited from RuleConfiguration.)
	Severity	Gets the severity of the rule. The default severity is Warning(Inherited from RuleConfiguration.)
	ShortRuleId	Gets the last part of the rule ID. This is the part of the rule that follows the final "." in the ID name. For instance for a rule ID "My.Org.MyRuleName", the short rule ID would be "MyRuleName".(Inherited from RuleConfiguration.)

Methods

	Name	Description
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD