Class AstTaskNode
AstTaskNode is the base type that is used for all SQL Server Integration Services tasks in Biml.
Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
[AstDoNotEmitXmlSchemaType]
public abstract class AstTaskNode : AstScopeBoundaryNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable, IDataflowItem
- Inheritance
-
System.ObjectAstTaskNode
Implements
IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable, IDataflowItem,
Constructors
| Name | Description |
|---|---|
| AstTaskNode(IFrameworkItem) | Initializes a new instance of the AstTaskNode class with the specified parent node. |
Properties
| Name | Description |
|---|---|
| CanAutoLayoutMoveSinkAnchors | Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping |
| CanAutoLayoutMoveSourceAnchors | Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping |
| DelayValidation | This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run. |
| DelayValidationDefaultValue | Gets the default value for the DelayValidation property |
| Disabled | This value specifies whether the item is disabled. The default value is False. |
| DisabledDefaultValue | Gets the default value for the Disabled property |
| DisableEventHandlers | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| DisableEventHandlersDefaultValue | Gets the default value for the DisableEventHandlers property |
| Events | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| ExpressionProperties | This collection holds properties that can be referenced by expressions. It's not necessarily the same properties that are available directly on the object. These AstPropertyNodes are here to support binding, not to be confused with the Properties collection on the generic control flow base object, which has "real" AstPropertyNodes. |
| Expressions | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| FailPackageOnFailure | This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False. |
| FailPackageOnFailureDefaultValue | Gets the default value for the FailPackageOnFailure property |
| FailParentOnFailure | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| FailParentOnFailureDefaultValue | Gets the default value for the FailParentOnFailure property |
| ForcedExecutionValue | If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0. |
| ForcedExecutionValueDataType | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForcedExecutionValueDefaultValue | Gets the default value for the ForcedExecutionValue property |
| ForceExecutionResult | This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome. |
| ForceExecutionResultDefaultValue | Gets the default value for the ForceExecutionResult property |
| ForceExecutionValue | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property. |
| ForceExecutionValueDefaultValue | Gets the default value for the ForceExecutionValue property |
| FriendlyTypeName | Gets the friendly name of the type of this node |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| Id | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| IdDefaultValue | Gets the default value for the Id property |
| IsolationLevel | Sets the Isolation Level which controls how Transactions behave for this container. |
| IsolationLevelDefaultValue | Gets the default value for the IsolationLevel property |
| Language | This specifies the default language to be used by this task and its descendants. |
| LanguageDefaultValue | Gets the default value for the Language property |
| LogEvents | This is a container for log event definitions that are specific to this task, container, or package. |
| LoggingMode | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| LoggingModeDefaultValue | Gets the default value for the LoggingMode property |
| LogProviders | Defines the log providers to use for the SSIS task or container |
| MaximumErrorCount | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| MaximumErrorCountDefaultValue | Gets the default value for the MaximumErrorCount property |
| OutputPath | Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint |
| PrecedenceConstraints | This is a container for task precedence constraint definitions. |
| StaticUserDefinedItems | Specifies a collection of items that are common across all instances of the same type in the framework. |
| SystemVariables | Gets a collection of all variables defined in this task that have been provided by SSIS as system variables |
| TransactionMode | This value specifies the transaction context in which this task will execute. |
| TransactionModeDefaultValue | Gets the default value for the TransactionMode property |
| Variables | This is a container for variable definitions that are specific to this task, container, or package. |
| VisiblePackageParameters | Gets a collection of all package parameter nodes that are available to be used by this task. |
| VisibleProjectParameters | Gets a collection of all project parameter nodes that are available to be used by this task. This include all parameters defined by all package projects that contain the parent package for this task. |
| VisibleVariables | Gets a collection of all variable nodes that are available to be used by this task. It includes variables defined by this task and any tasks/packages that contain this task |
Methods
| Name | Description |
|---|---|
| AddExpressionProperty(AstPropertyNode) | |
| AddVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object) | Adds a variable with this task as the parent node |
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| CanDropItemOfType(Type) | Gets a value to indicate whether items of the specified type can be dropped onto this item in the design surface |
| 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. |
| CreateVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object) | Adds a variable with this task as the parent node |
| 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) | |
| PreviewRebindReplacementToCollection(IEnumerable<IFrameworkItem>) | This method is called by the Biml Framework to indicate when a BimlScript transformer is about to replace an existing item. This permits the node to store information necessary to manage references to/from the replaced item. |
| RebindReplacementToCollection(IEnumerable<IFrameworkItem>) | This method is called by the Biml Framework to indicate when a BimlScript transformer has replaced an existing item. This permits the node to manage references to/from the replaced item. |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |