Biml API Reference
AstTableColumnBaseNode Type
BimlStudio 2017

AstTableColumnBaseNode is the base type that is used for all table column types in Biml.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
AstTableColumnBaseNode is an abstract type, so it does not have a corresponding Biml 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)
CheckConstraint
The check constraint associated with this column.
CodePage
This value specifies the integer index for the codepage of the dataflow column. This property applies only to dataflow column types that support code pages, such as strings. Codepages supported by Windows are listed at: http://msdn.microsoft.com/en-us/goglobal/bb964654.aspx.
CodePageDefaultValue
Gets the default value for the CodePage property
Computed
This value specifies a computed value for the column using Transact-SQL expression syntax. Computed column specifications conform to all SQL Server computed column rules as described at http://msdn.microsoft.com/en-us/library/ms191250.aspx
ComputedDefaultValue
Gets the default value for the Computed property
CustomType
This value specifies the type of a column when the main column type has been set to Custom. This permits the specification of less commonly used SQL Server column types. A complete list of allowed types is available at http://msdn.microsoft.com/en-us/library/ms127023%28SQL.90%29.aspx
CustomTypeDefaultValue
Gets the default value for the CustomType property
DataType
This value specifies the type of the data stored in this column using the unified type system. The type values include all of those types commonly used in Microsoft SQL Server table definitions.
Default
This value specifies a default value for the column using Transact-SQL constant expression syntax.
DefaultConstraintName
This value specifies the name that should be used for the default value constraint for this column in the database. If the Default property has not been specified, the value of this property will be ignored.
DefaultConstraintNameDefaultValue
Gets the default value for the DefaultConstraintName property
DefaultDefaultValue
Gets the default value for the Default property
DefaultValue
Gets or sets the default value for this column. This will be emitted as a default value constraint.
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)
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)
FriendlyName
Provides a convenience property for storing an alternative name for this column.
FriendlyNameDefaultValue
Gets the default value for the FriendlyName property
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
(Inherited from AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
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
(Inherited from AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
IdentityIncrement
Set IdentityIncrement to a non-zero value to enable this column as an IDENTITY. This value specifies the amount by which the Identity value is incremented when a row is inserted. Removing this property or setting the value to 0 will remove the IDENTITY specification for this column.
IdentityIncrementDefaultValue
Gets the default value for the IdentityIncrement property
IdentitySeed
This value specifies the starting value for an identity column. When the first row is inserted into the table, this value is used. Both seed and increment must be specified if either is explicitly specified. The default value is 1.
IdentitySeedDefaultValue
Gets the default value for the IdentitySeed property
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
IsAssignable
Indicates whether this column is assignable. Generally false only if the column is computed, auto-generated, participates in an identity, or has been fixed by a constraint
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsAutoGenerated
Indicates whether the value of column is automatically generated
IsComputed
Indicates whether this is a computed column
IsCustomTypeExplicitlySet
Gets whether or not the IsCustomTypeExplicitlySet property has been set directly.
IsDataTypeExplicitlySet
Gets whether or not the IsDataTypeExplicitlySet property has been set directly.
IsIdentityColumn
Indicates whether this column participates in an identity
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)
IsIsNullableExplicitlySet
Gets whether or not the IsIsNullableExplicitlySet property has been set directly.
IsLargeObject
Indicates whether this column uses a large object (LOB) data type
IsLengthExplicitlySet
Gets whether or not the IsLengthExplicitlySet property has been set directly.
IsNullable
This value specifies whether null values are accepted for the column.
IsNullableDefaultValue
Gets the default value for the IsNullable property
IsPrecisionExplicitlySet
Gets whether or not the IsPrecisionExplicitlySet property has been set directly.
IsScaleExplicitlySet
Gets whether or not the IsScaleExplicitlySet property has been set directly.
IsUsedInIndex
Indicates whether this column is used in any index
IsUsedInKey
Indicates whether this column is used in any key
IsUsedInPrimaryKey
Indicates whether this column is used in a primary key
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Length
(Set to -1 to indicate MAX length). This value specifies the length parameter for the column type associated with this column. This property applies only to column types that support a length specification, such as String and Binary types.
LengthDefaultValue
Gets the default value for the Length property
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)
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)
Precision
This value specifies the precision parameter for the column type associated with this column. Precision is the number of digits stored for a numeric value. This property applies only to column types that support precision, such as Decimal.
PrecisionDefaultValue
Gets the default value for the Precision property
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)
QualifiedName
Gets the fully qualified T-SQL name for this column
ReadOnly
Advanced Feature: Use at your own risk. Specifies that the column should be treated as a read-only column. This will automatically remove the column from assignment from Merge statements and other auto-generated code paths. Computed columns and rowversion columns are two examples of data types which are read-only.
ReadOnlyDefaultValue
Gets the default value for the ReadOnly property
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
ReferencedColumn
For reference columns, returns the referenced column
ReferencedCustomType
For reference columns, returns the referenced column's custom data type
ReferencedDataType
For reference columns, returns the referenced column's data type
ReferencedLength
For reference columns, returns the referenced column's length
ReferencedPrecision
For reference columns, returns the referenced column's length
ReferencedScale
For reference columns, returns the referenced column's length
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)
Scale
This value specifies the scale parameter for the column type associated with this column. Scale is the number of digits to the right of the decimal point in a numeric value. This property applies only to column types that support precision, such as Decimal.
ScaleDefaultValue
Gets the default value for the Scale property
ScdType
This value specifies the slowly changing dimension type for the column. The value determines the behavior of the table when a row with a matching unique key value is added to the table. This behavior is enforced in the various Task and Dataflow transformations that interact with this table.
ScdTypeDefaultValue
Gets the default value for the ScdType property
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)
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)
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:
TableColumnBase
Abstract:
True
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Biml Language Metadata
Xml Schema Name:
Varigence.Languages.Biml.Table.AstTableColumnBaseNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False