Biml API Reference
AstTableIndexNode Type
BimlStudio 2017

AstTableIndexNode corresponds directly to a SQL Server relational database index.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
Annotations
This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.
(Inherited from AstNode)
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
Clustered
This value specifies whether the index is clustered. A clustered index is physically laid out on disc with all columns of the rows of the table.
ClusteredDefaultValue
Gets the default value for the Clustered property
Columns
This is a container for index column reference definitions.
CompressionType
This value specifies what kind of compression the index uses.
CompressionTypeDefaultValue
Gets the default value for the CompressionType property
DropExisting
When DropExisting is specified, the index creation removes any existing indexes with the same name before creating the new index. Unspecified properties in the new index are inherited from the dropped index. Without this option, an attempt to create a second index with the same name would result in an error.
DropExistingDefaultValue
Gets the default value for the DropExisting property
Error
Gets the error string for this node, if any
(Inherited from AstNode)
ErrorCount
Gets the count of error diagnostics that have been generated for this node
(Inherited from AstNode)
FileGroup
Specifies the file group within which this index should be created.
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
FilterPredicate
Specifies the T-SQL predicate expression that should be used to include/exclude rows from a filtered index.
FilterPredicateDefaultValue
Gets the default value for the FilterPredicate property
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
ForceDisableIncrementalChangeTracking
This value specifies whether changes to property values of this node should be automatically reflected in the corresponding Biml code. Its primary use is for temporary nodes that will never be persisted into BimlFiles.
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
IgnoreDupKey
This value specifies whether incoming rows that have a duplicate index value should produce a warning (and continue) or an error (and terminate). This property applies only for indexes 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
Includes
This is a container for index include column reference definitions.
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
(Inherited from AstNode)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Items
Gets a collection that contains all index column references and include column references
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Name
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
(Inherited from AstNamedNode)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
ObjectTag
This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.
(Inherited from AstNode)
Online
This value specifies whether the index remains online and accessible while index operations are being performed.
OnlineDefaultValue
Gets the default value for the Online 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
ParentItem
This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node.
(Inherited from AstNode)
ParentXObjectMappingProvider
This value specifies the parent of the current node for Xml Binding purposes.
(Inherited from AstNode)
PartitionColumn
Defines the column used by the partition scheme.
PartitionScheme
Defines the partition scheme used to partition this index.
PropertyChangeNotificationTarget
Gets a reference to the ViewModel object for this node. This property should only be used by the internal Biml framework.
(Inherited from AstNode)
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(Inherited from AstNamedNode)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
SortInTempDB
This value determines whether the configured temporary database should be used for storing the index.
SortInTempDBDefaultValue
Gets the default value for the SortInTempDB property
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SsisSafeScopedName
Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
Unique
This value specifies whether each index value is unique. When the value is True, no two rows have the same values across all of the columns participating in the index.
UniqueDefaultValue
Gets the default value for the Unique property
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
WarningCount
Gets the count of warning diagnostics that have been generated for this node
(Inherited from AstNode)
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
Methods
  Name Summary
Events
  Name Summary
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
NameChanged
The NameChanged event occurs when the Name property of the current node has changed to a new value and that value has been committed.
NameChanging
The NameChanging event occurs when the Name property of the current node is receiving a new value but that value has not yet been committed.
ScopeBoundaryChanged
The ScopeBoundaryChanged event occurs when any ancestor (as determined by following ParentItem to the AstRootNode) changes in such a way as the ScopeBoundary for this node changes. This will force the ScopedName of this node to change if it is an AstNamedNode.
ScopedNameChanged
The ScopedNameChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
Extension Methods
  Name Summary
AddAnnotation(AnnotationType,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
AddAnnotation(AnnotationType,String,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
EnumerateAncestors
Returns the ancestors of the current node
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetBiml()
Retrieve the Biml that represents the AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
.NET API Metadata
Assembly:
Biml
Friendly Name:
TableIndex
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Table.AstTableIndexNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False