Class AstOfflineSchemaColumnNode
The AstOfflineSchemaColumnNode class defines the type metadata information for an individual column within an offline schema.
Namespace: Varigence.Languages.Biml.Metadata
Assembly: Biml.dll
C#
public class AstOfflineSchemaColumnNode : AstTableColumnBaseNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem
Inheritance AstNode
-
Implements
Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo, Varigence.Utility.Collections.IScopedNameIndexable, Varigence.Utility.Database.Specification.IColumnTypeSpecification,
Constructors
| Constructors | Description |
|---|---|
| AstOfflineSchemaColumnNode(IFrameworkItem) | Initializes a new instance of the AstOfflineSchemaColumnNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| DataType_BackingField | |
| Length_BackingField | |
| Precision_BackingField | |
| Scale_BackingField | |
| CustomType_BackingField | |
| IsNullable_BackingField | |
| ScopedNamePrefixBackingStore | |
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| ComputedText | Gets the computed text expression for this column, if any |
| DatabaseProvider | Gets the database provider for this column |
| DefaultExpression | Gets the default expression for this column, if any |
| DoNotEmitOutputColumn | Specifies whether or not this column should be included in the output path for the referencing SSIS dataflow component. This is normally set to true for columns with a data type that is not supported by SSIS data flows. |
| DoNotEmitOutputColumnDefaultValue | Gets the default value for the DoNotEmitOutputColumn property |
| DotNetType | Gets the .NET type that should be used for this column when its data values are manipulated with .NET code. |
| DotNetTypeName | Specifies the namespace qualified name of the .NET type that should be used for this column when its data values are manipulated with .NET code. |
| DotNetTypeNameDefaultValue | Gets the default value for the DotNetTypeName property |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| IsAssignable | Indicates whether the column can have values assigned to it |
| IsAutoIncrement | Gets whether or not this column is an auto-increment or identity column |
| IsByteSemantic | Indicates whether this column uses a single byte for string character representation or a multi-byte format |
| IsComputed | Indicates whether the column derives its value from an expression |
| IsKey | Specifies whether or not this column participates in a relational database key when it is used by a referencing SSIS dataflow component. |
| IsKeyDefaultValue | Gets the default value for the IsKey property |
| IsLargeObject | Indicates whether this column uses a large object (LOB) data type |
| IsLong | Specifies whether or not this column uses a version of the underlying relational database type that should be treated as long. |
| IsLongDefaultValue | Gets the default value for the IsLong property |
| IsReadOnly | Specifies whether or not this column is marked as read only in the relational database. |
| IsReadOnlyDefaultValue | Gets the default value for the IsReadOnly property |
| IsRowVersion | Specifies whether or not this column uses a database-specific rowversion data type when it is used by a referencing SSIS dataflow component. |
| IsRowVersionDefaultValue | Gets the default value for the IsRowVersion property |
| IsUnique | Specifies whether or not this column participates in a relational database unique constraint when it is used by a referencing SSIS dataflow component. |
| IsUniqueDefaultValue | Gets the default value for the IsUnique property |
| KeyValuePairs | Provides a property bag for storing supplemental external column information. This is normally used for provider specific values. |
| Ordinal | Specifies the ordinal position of this column in the relational database table or query result set. |
| OrdinalDefaultValue | Gets the default value for the Ordinal property |
| ProviderType | Specifies the database specific code assigned to the data type for this column. |
| ProviderTypeDefaultValue | Gets the default value for the ProviderType property |
| RawDataType | Specifies the data type that is reported by the database provider for this column using the preferred text representation for the provider. |
| RawDataTypeDefaultValue | Gets the default value for the RawDataType property |
| RawDataTypeId | Specifies the data type id that is reported by the database provider for this column using the preferred type code for the provider. |
| RawDataTypeIdDefaultValue | Gets the default value for the RawDataTypeId property |
| RawLength | Specifies the length that is reported by the database provider for this column. |
| RawLengthDefaultValue | Gets the default value for the RawLength property |
| RawPrecision | Specifies the precision that is reported by the database provider for this column. |
| RawPrecisionDefaultValue | Gets the default value for the RawPrecision property |
| RawScale | Specifies the scale that is reported by the database provider for this column. |
| RawScaleDefaultValue | Gets the default value for the RawScale property |
| ReferencedColumn | For reference columns, returns the referenced column |
| SizeInBytes | Specifies the size of the data type of this column as measured in bytes by the underlying relational database. |
| SizeInBytesDefaultValue | Gets the default value for the SizeInBytes property |
| IsAutoGenerated | Indicates whether the value of column is automatically generated |
| QualifiedName | Gets the fully qualified T-SQL name for this column |
| IsIdentityColumn | Indicates whether this column participates in an identity |
| DefaultValue | Gets or sets the default value for this column. This will be emitted as a default value constraint. |
| IsUsedInKey | Indicates whether this column is used in any key |
| IsUsedInPrimaryKey | Indicates whether this column is used in a primary key |
| IsUsedInIndex | Indicates whether this column is used in any index |
| ReferencedDataType | For reference columns, returns the referenced column's data type |
| ReferencedCustomType | For reference columns, returns the referenced column's custom 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 |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
| 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 |
| Default | This value specifies a default value for the column using Transact-SQL constant expression syntax. |
| 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. |
| IsNullable | This value specifies whether null values are accepted for the 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. |
| 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. |
| 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. |
| CheckConstraint | The check constraint associated with this column. |
| 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. |
| 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. |
| FriendlyName | Provides a convenience property for storing an alternative name for this column. |
| LengthDefaultValue | Gets the default value for the Length property |
| PrecisionDefaultValue | Gets the default value for the Precision property |
| ScaleDefaultValue | Gets the default value for the Scale property |
| CustomTypeDefaultValue | Gets the default value for the CustomType property |
| ComputedDefaultValue | Gets the default value for the Computed property |
| DefaultDefaultValue | Gets the default value for the Default property |
| ScdTypeDefaultValue | Gets the default value for the ScdType property |
| IsNullableDefaultValue | Gets the default value for the IsNullable property |
| ReadOnlyDefaultValue | Gets the default value for the ReadOnly property |
| IdentitySeedDefaultValue | Gets the default value for the IdentitySeed property |
| IdentityIncrementDefaultValue | Gets the default value for the IdentityIncrement property |
| DefaultConstraintNameDefaultValue | Gets the default value for the DefaultConstraintName property |
| CodePageDefaultValue | Gets the default value for the CodePage property |
| FriendlyNameDefaultValue | Gets the default value for the FriendlyName property |
| ScopedName | Gets the scoped name which can be used to uniquely identify this object among other objects of its type |
| SymbolTable | Gets a reference to the symbol table that stores a reference to this and all other named objects in the project |
| SsisSafeScopedName | Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS. |
| SsisSafeName | Returns a version of the Name that has been cleaned of invalid characters for SSIS. |
| Name | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. |
| References | Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node. |
| NameDefaultValue | Gets the default value for the Name property |
| Guid | |
| 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. |
| 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. |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. |
| ItemLabel | Gets a label that can be used to identify this node |
| 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. |
Methods
| Methods | Description |
|---|---|
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| 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 |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| ConvertOleDbTypeToColumnType(OleDbType) | Converts an OleDbType into a DbType. |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| 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. |
| ParseChild(XElement, ParserContext) | |
| GetBimlChildFragment(CulturedStringBuilder, Int32) | |
| HasAnyBimlChildNodes() | |
| ToString() | Returns a string that represents the current object. In this case, it is the Name of the node. |
| OnScopedNameChanged(String, String) | |
| OnItemLabelChanged(String, String) | |
| OnNameChanging(String, String) | |
| OnNameChanged(String, String) | |
| AddScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>) | Adds the scoped name changed event handler to the specified referenceable item. |
| RemoveScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>) | Removes the scoped name changed event handler from the specified referenceable item. |
| FirstChildOfType<TChild>() | Gets the first defined descendant node of the specified type |
| RemoveFromParent() | Removes this node definition from its parent |
| GetJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetExternalJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetJson(Boolean, Boolean, Boolean, Boolean, Boolean) | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetXObjectName() | Gets the fully qualified XML element name for this node in the code document. |
| FirstParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type |
| FirstParent<TAstNode>(Type) | Retrieves the first parent or ancestor node of the specified type with the specified custom attribute type |
| FirstThisOrParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type, including this node |
| IsDirectAncestor(IFrameworkItem) | Retrieves a value indicating whether the specified node is a direct ancestor of this node. |
| AncestorDistance(IFrameworkItem) | Retrieves the number of steps between this node and the nearest shared ancestor with the specified relative node. |
| FirstThisOrParent<TAstNode>(Type) | Retrieves the first parent or ancestor node (including this node) of the specified type with the specified custom attribute type |
| AllDefinedSuccessors() | Retrieves the collection of all nodes defined as a child of this or any successor node or the current node |
| AllDefinedSuccessors(Boolean) | Retrieves the collection of all nodes defined as a child of this or any successor node or optionally the current node |
| OnNotificationTargetPropertyChanged(String) | |
| OnScopeBoundaryChanged(IScopeBoundary, IScopeBoundary) | |
| AddParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| RemoveScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| AddParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| ParseSelf(XElement, ParserContext) | |
| ParseNameValueMapping(XElement) | |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) |