Class AstPackageNode
The AstPackageNode type corresponds directly to a SQL Server Integration Services package.
Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
C#
public class AstPackageNode : AstContainerTaskNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IDataflowItem, ISsisPackageFragment, IEmittableAstNode, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem
Inheritance AstNode
-
Implements
Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, ISsisPackageFragment, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo, Varigence.Utility.Collections.IScopedNameIndexable,
Constructors
| Constructors | Description |
|---|---|
| AstPackageNode(IFrameworkItem) | Initializes a new instance of the AstPackageNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| ScopedNamePrefixBackingStore | |
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| AutoCreateConfigurationsTable | This value specifies a direct reference to the table that will be used to store automatically created package configurations in the event that the AutoCreateConfigurationType property is set to Sql. |
| AutoCreateConfigurationsType | This value specifies whether or not package configurations will be automatically created and where they will be stored. |
| AutoCreateConfigurationsTypeDefaultValue | Gets the default value for the AutoCreateConfigurationsType property |
| CheckpointFileName | This value specifies the path to the file in which checkpoint information is saved. Checkpoint information can be used to restart a package if it fails. |
| CheckpointFileNameDefaultValue | Gets the default value for the CheckpointFileName property |
| CheckpointUsage | This value specifies whether a package can be restarted and how the checkpoint file is used. The default value is Never, which means that the package cannot be restarted. |
| CheckpointUsageDefaultValue | Gets the default value for the CheckpointUsage property |
| Connections | This is a collection of references to connection definitions. It is the equivalent of the collection of connection managers in SSIS. |
| CreationDate | Specifies the date when the package was created. If this value is not specified, the current date at the time of build will be used. |
| CreationDateDefaultValue | Gets the default value for the CreationDate property |
| CreatorComputerName | Specifies the name of the computer that was used to create this package. If this value is not specified, the computer name from the system environment will be used. |
| CreatorComputerNameDefaultValue | Gets the default value for the CreatorComputerName property |
| CreatorName | Specifies the username of the person that created this package. If this value is not specified, the username from the system environment will be used. |
| CreatorNameDefaultValue | Gets the default value for the CreatorName property |
| DisablePackageConfigurations | Specifies whether package configurations should be disabled in the generated package. By default, configurations are enabled automatically when package configurations are defined. This property can be used to override that default behavior. |
| DisablePackageConfigurationsDefaultValue | Gets the default value for the DisablePackageConfigurations property |
| Emit | Gets or sets a value that determines if this node should be emitted as a package in the build output |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| LogicalDisplayFolder | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. |
| LogicalDisplayFolderDefaultValue | Gets the default value for the LogicalDisplayFolder property |
| MaxConcurrentExecutables | This value specifies the maximum number of concurrently running threads a package is allowed to create. |
| MaxConcurrentExecutablesDefaultValue | Gets the default value for the MaxConcurrentExecutables property |
| PackageConfigurations | This is a collection of package configuration definitions. |
| PackagePassword | Specifies the password to use when using password-based encryption. This value is only used when the package ProtectionLevel is set to EncryptAllWithPassword or EncryptSensitiveWithPassword. If a global password value is specified for SSIS encryption, this property will override that value. |
| PackagePasswordDefaultValue | Gets the default value for the PackagePassword property |
| PackageSubpath | This specifies a file path fragment to use for emitting output files for this package. It is most commonly employed to ensure that the output files for multiple packages will be placed into the same output directory. PackageSubpath will override the default package location behavior. Packages will no longer be emitted under OutputDirectory\Type\PackageName.dtsx but instead OutputDirectory<PackageSubpath>\PackageName.dtsx |
| PackageSubpathDefaultValue | Gets the default value for the PackageSubpath property |
| PackageType | This is a tag for the type or use of this package. It is used for documentation and to determine the folder into which to place generated output files. |
| PackageTypeDefaultValue | Gets the default value for the PackageType property |
| Parameters | Defines the collection of parameters for this package. |
| PriorityClass | This value specifies a thread processing priority level for the package. |
| PriorityClassDefaultValue | Gets the default value for the PriorityClass property |
| ProtectionLevel | This value specifies the level of data protection for the package. |
| ProtectionLevelDefaultValue | Gets the default value for the ProtectionLevel property |
| RelatedFiles | This is a collection of attached file definitions for this package. |
| SaveCheckpoints | This value specifies whether checkpoints are saved during package execution. The value must be set to True to enable a package to be restarted. |
| SaveCheckpointsDefaultValue | Gets the default value for the SaveCheckpoints property |
| SsisPackageType | This identifies the tool that created a package. |
| SsisPackageTypeDefaultValue | Gets the default value for the SsisPackageType property |
| SsisVersionComments | This specifies the version comments for the package. |
| SsisVersionCommentsDefaultValue | Gets the default value for the SsisVersionComments property |
| SuppressConfigurationWarnings | This value specifies whether warnings generated by configurations for this package are suppressed. |
| SuppressConfigurationWarningsDefaultValue | Gets the default value for the SuppressConfigurationWarnings property |
| VersionBuild | This value specifies the build number for the package. |
| VersionBuildDefaultValue | Gets the default value for the VersionBuild property |
| VersionGuid | Allows the developer to specify a unique version identifier (GUID) for the package. This can be used to retain a consistent VersionGUID between builds. |
| VersionGuidDefaultValue | Gets the default value for the VersionGuid property |
| VersionMajor | This value specifies the major version number for the package. |
| VersionMajorDefaultValue | Gets the default value for the VersionMajor property |
| VersionMinor | This value specifies the minor version number for the package. |
| VersionMinorDefaultValue | Gets the default value for the VersionMinor property |
| Tasks | Container for child task definitions. |
| ConstraintMode | This value specifies the mode that should be used to execute the children of the container or package. Parallel directly matches the SSIS behavior and will require that precedence constraints are created manually for all task connections. Linear will automatically create precedence constraints so that tasks will run one after the other in the order that they are specified in the Biml. Linear is primarily useful for scripting scenarios where creating precedence constraints would be tedious. |
| SsisAnnotations | This is a collection of SSIS annotations that will be rendered on the SSIS design surface within the parent container object. |
| ConstraintModeDefaultValue | Gets the default value for the ConstraintMode property |
| 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 |
| 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. |
| OutputPath | Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint |
| SystemVariables | Gets a collection of all variables defined in this task that have been provided by SSIS as system variables |
| PrecedenceConstraints | This is a container for task precedence constraint definitions. |
| Events | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| 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. |
| IsolationLevel | Sets the Isolation Level which controls how Transactions behave for this container. |
| 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. |
| 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. |
| 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. |
| ForcedExecutionValueDataType | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| Disabled | This value specifies whether the item is disabled. The default value is False. |
| 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. |
| FailParentOnFailure | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| 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. |
| Language | This specifies the default language to be used by this task and its descendants. |
| DisableEventHandlers | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| TransactionMode | This value specifies the transaction context in which this task will execute. |
| Variables | This is a container for variable 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. |
| LogEvents | This is a container for log event definitions that are specific to this task, container, or package. |
| LogProviders | Defines the log providers to use for the SSIS task or container |
| Expressions | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| Id | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| DelayValidationDefaultValue | Gets the default value for the DelayValidation property |
| IsolationLevelDefaultValue | Gets the default value for the IsolationLevel property |
| ForcedExecutionValueDefaultValue | Gets the default value for the ForcedExecutionValue property |
| ForceExecutionResultDefaultValue | Gets the default value for the ForceExecutionResult property |
| ForceExecutionValueDefaultValue | Gets the default value for the ForceExecutionValue property |
| DisabledDefaultValue | Gets the default value for the Disabled property |
| FailPackageOnFailureDefaultValue | Gets the default value for the FailPackageOnFailure property |
| FailParentOnFailureDefaultValue | Gets the default value for the FailParentOnFailure property |
| MaximumErrorCountDefaultValue | Gets the default value for the MaximumErrorCount property |
| LanguageDefaultValue | Gets the default value for the Language property |
| DisableEventHandlersDefaultValue | Gets the default value for the DisableEventHandlers property |
| TransactionModeDefaultValue | Gets the default value for the TransactionMode property |
| LoggingModeDefaultValue | Gets the default value for the LoggingMode property |
| IdDefaultValue | Gets the default value for the Id 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. |
| 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(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| 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. |
| 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. |
| AddExpressionProperty(AstPropertyNode) | |
| CreateVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object) | Adds a variable with this task as the parent node |
| AddVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object) | Adds a variable with this task as the parent node |
| 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) |