• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstCandidateKeyProfileRequestNode

The AstCandidateKeyProfileRequestNode type corresponds directly to the candidate key data profile in the SQL Server Integration Services data profiling task, which will report which column(s) have unique values across rows and could consequently serve as keys.

Namespace:
Varigence.Languages.Biml.Task
Assembly:
Biml.dll
C#
    public class AstCandidateKeyProfileRequestNode : AstDataProfileRequestNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstDataProfileRequestNode
AstCandidateKeyProfileRequestNode
Derived
AstCandidateKeyProfileRequestNode
Implements

IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable,

Constructors

AstCandidateKeyProfileRequestNode(IFrameworkItem)

Initializes a new instance of the AstCandidateKeyProfileRequestNode class with the specified parent node.

Properties

FriendlyTypeName

Gets the friendly name of the type of this node

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

KeyColumns

This is a collection of names of columns that will be examined as candidate key columns for the table.

KeyColumnsDefaultValue

Gets the default value for the KeyColumns property

KeyStrengthThreshold

This value specifies the threshold for key strength that must be satisfied before key strength is reported. This value must be specified in conjunction with a ThresholdSetting of 'Specified'. The default is 0.95.

KeyStrengthThresholdDefaultValue

Gets the default value for the KeyStrengthThreshold property

MaxNumberOfViolations

This value specifies the maximum number of unique key violations to report. If ThresholdSetting is 'Exact', then this property is ignored (as it is implied to be 0). The default is 100.

MaxNumberOfViolationsDefaultValue

Gets the default value for the MaxNumberOfViolations property

ThresholdSetting

This value specifies the conditions under which the strength of a given candidate key will be reported. The default is 'Specified'.

ThresholdSettingDefaultValue

Gets the default value for the ThresholdSetting property

Methods

BindingScopeBoundaries()

Retrieves the permitted scope boundaries to bind references from this node.

CopyFrom(IFrameworkItem, UnboundReferences)

Instructs the node to copy property values from the supplied node into itself. This method should only be used by the internal Biml framework.

Duplicate()

Creates a duplicate of the current node

Duplicate(Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the scoped node mapping

Duplicate(IFrameworkItem)

Creates a duplicate of the current node with the specified parent item

Duplicate(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Creates a duplicate of the current node with the specified parent item and scoped node mapping

DuplicateHusk(IFrameworkItem)

Creates an empty object into which the values from the current node will be duplicated. This method should only be used by the internal Biml framework

DuplicateInto(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>)

Copies the values from the current node into a husk object with the specified scoped node mapping. This method should only be used by the internal Biml framework

EmitXmlForAction(AstEnginePropertyAction)

Instructs the node to make changes to its underlying Biml code that correspond to the provided action. This method should only be used by the internal Biml framework.

EmitXmlForProperty(String, Int32)

Instructs the node to make changes to its underlying Biml code that correspond to the provided property and index. This method should only be used by the internal Biml framework.

GetBimlAttributeFragment(CulturedStringBuilder)
GetBimlChildFragment(CulturedStringBuilder, Int32)
GetBimlFragment(CulturedStringBuilder, Int32, Boolean)

Internal method used by the Biml engine to produce the XML code for the current object.

GetDefaultValue(String)

Retrieves the default value for the property with the name propertyName

GetDefaultValue<T>(String)

Retrieves the default value for the property with the name propertyName

GetJson(StringBuilder, ref Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

Generates a JavaScript Object Notation (JSON) representation of the current node

GetPotentialParentProperties()

Retrieves the reflection information for related properties of this node type.

GetPropertyValue(String)

Retrieves the current value for the property with the name propertyName

GetReflectionInfoFromXmlParsePath(String)

Retrieves the reflection information corresponding to the Xml parse path beginning at this node.

HasAnyBimlChildNodes()
MergeFrom(IFrameworkItem, UnboundReferences, Boolean)

Instructs the node to merge property values from the supplied node into itself. This method should only be used by the internal Biml framework.

NotifyCollectionPropertyChanged(Object, String, NotifyCollectionChangedEventArgs)

Internal Biml framework method used to notify this node that the specified collection property value has changed.

ParseAttribute(XAttribute, ParserContext)
ParseChild(XElement, ParserContext)
StructureEquals(Object)

Compares this node to the provided object to determine if all defined children and references are equal.

© Varigence