Share via

RuleDescriptor Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dac.CodeAnalysis
Assembly:
Microsoft.SqlServer.Dac.Extensions.dll
Package:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
Package:
Microsoft.SqlServer.DacFx v150.5282.3
Package:
Microsoft.SqlServer.DacFx v160.6161.0
Package:
Microsoft.SqlServer.DacFx v162.2.111
Package:
Microsoft.Data.Tools.Msbuild v10.0.61804.210

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.

public abstract class RuleDescriptor : Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration
type RuleDescriptor = class
    inherit RuleConfiguration
Public MustInherit Class RuleDescriptor
Inherits RuleConfiguration
Inheritance
Object
RuleConfiguration
RuleDescriptor

Constructors

RuleDescriptor(String)

Protected constructor to be called by implementing classes.

Properties

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

Specifies if 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

What severity should problems created by the rule have?

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)

Applies to