Class AstTableKeyBaseNode
AstTableKeyBaseNode is the base node for all types of keys and constraints that can be defined in a SQL Server relational database.
Namespace: Varigence.Languages.Biml.Table
Assembly: Biml.dll
[AstDoNotEmitXmlSchemaType]
public abstract class AstTableKeyBaseNode : AstNamedNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable
- Inheritance
-
System.ObjectAstTableKeyBaseNode
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
| Name | Description |
|---|---|
| AstTableKeyBaseNode(IFrameworkItem) | Initializes a new instance of the AstTableKeyBaseNode class with the specified parent node. |
Fields
| Name | Description |
|---|---|
| Clustered_BackingField |
Properties
| Name | Description |
|---|---|
| Clustered | This value specifies whether incoming rows that have a duplicate key value should produce a warning (and continue) or an error (and terminate). This property applies only for keys where the value of Unique is True. It is useful for enabling large bulk inserts to complete when duplicate rows exist. |
| ClusteredDefaultValue | Gets the default value for the Clustered property |
| Columns | This is a container for key column reference definitions. |
| ComparisonBytes | For choosing a PreferredKey, the table will select the key that requires the smallest number of bytes to compare. This is only in cases where a key cannot first be selected through some other criteria. This property supplies the comparison bytes value. |
| FillFactor | This value specifies what percentage of each index page the database engine should fill when creating or rebuilding the index. |
| FillFactorDefaultValue | Gets the default value for the FillFactor property |
| FriendlyTypeName | Gets the friendly name of the type of this node |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| IgnoreDupKey | This value specifies whether incoming rows that have a duplicate key value should produce a warning (and continue) or an error (and terminate). This property applies only for keys where the value of Unique is True. It is useful for enabling large bulk inserts to complete when duplicate rows exist. |
| IgnoreDupKeyDefaultValue | Gets the default value for the IgnoreDupKey property |
| IsClusteredExplicitlySet | Gets whether or not the IsClusteredExplicitlySet property has been set directly. |
| IsEnabled | Enables or Disables this constraint. Disabled constraints will not be generated in the emitted SQL statements but will have metadata available for other use. |
| IsEnabledDefaultValue | Gets the default value for the IsEnabled property |
| PadIndex | This value determines whether each intermediate level of the index is padded with extra open space in each page. |
| PadIndexDefaultValue | Gets the default value for the PadIndex property |
| Unique | This value specifies whether each key value is unique. When the value is True, no two rows have the same values across all of the columns participating in the key. |
| UniqueDefaultValue | Gets the default value for the Unique property |
Methods
| Name | Description |
|---|---|
| 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. |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| 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. |
| GetAllItemsReferencedByDefinedSuccessors() | Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem. |
| 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. |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| 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. |
| StructureEquals(AstTableKeyBaseNode, AstTableKeyBaseNode) | Gets a value to indicate whether or not the two keys have identical structure |