BIML API Reference
AstPackageNode Node Type
The AstPackageNode type corresponds directly to a SQL Server Integration Services package.
Inheritance Hierarchy
- Varigence.Languages.Biml.AstNode
- Varigence.Languages.Biml.AstNamedNode
- Varigence.Languages.Biml.AstScopeBoundaryNode
- Varigence.Languages.Biml.Task.AstTaskNode
- Varigence.Languages.Biml.Task.AstContainerTaskBaseNode
- Varigence.Languages.Biml.Task.AstContainerTaskNode
- Varigence.Languages.Biml.Task.AstPackageNode
Properties
| Name | Summary | Default | |
|---|---|---|---|
![]() | 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) | |
![]() | 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. | Xml |
![]() | BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. (Inherited from AstNode) | |
![]() | 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. | |
![]() | 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. | Never |
![]() | Connections | This is a collection of references to connection definitions. It is the equivalent of the collection of connection managers in SSIS. | |
![]() | 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. (Inherited from AstContainerTaskBaseNode) | Linear |
![]() | 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. (Inherited from AstTaskNode) | false |
![]() | Disabled | This value specifies whether the package is disabled. The default value is False. (Inherited from AstTaskNode) | false |
![]() | DisableEventHandlers | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. (Inherited from AstTaskNode) | false |
![]() | Events | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. (Inherited from AstTaskNode) | |
![]() | 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. (Inherited from AstTaskNode) | |
![]() | Expressions | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. (Inherited from AstTaskNode) | |
![]() | 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. (Inherited from AstTaskNode) | false |
![]() | FailParentOnFailure | This value determines whether the parent container will fail when a child container failes. The default value is False. (Inherited from AstTaskNode) | false |
![]() | 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. (Inherited from AstTaskNode) | "0" |
![]() | ForcedExecutionValueDataType | This property specifies the data type of the value stored in the ForceExecutionValue property. (Inherited from AstTaskNode) | Int32 |
![]() | 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) | False |
![]() | 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. (Inherited from AstTaskNode) | None |
![]() | 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. (Inherited from AstTaskNode) | false |
![]() | Id | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. (Inherited from AstTaskNode) | 00000000-0000-0000-0000-000000000000 |
![]() | IsolationLevel | Sets the Isolation Level which controls how Transactions behave for this container. (Inherited from AstTaskNode) | Serializable |
![]() | Language | This specifies the default language to be used by this task and its descendants. (Inherited from AstTaskNode) | Inherited |
![]() | LogEvents | This is a container for log event definitions that are specific to this task, container, or package. (Inherited from AstTaskNode) | |
![]() | LoggingMode | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. (Inherited from AstTaskNode) | Inherit |
![]() | LogProviders | Defines the log providers to use for the SSIS task or container (Inherited from AstTaskNode) This is a container for log provider definitions that are specific to this task, container, or package. (Inherited from AstTaskNode) | |
![]() | MaxConcurrentExecutables | This value specifies the maximum number of concurrently running threads a package is allowed to create. | -1 |
![]() | 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. (Inherited from AstTaskNode) | 1 |
![]() | 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) | |
![]() | PackageConfigurations | This is a collection of package configuration definitions. | |
![]() | 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\ | |
![]() | 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. | "ETL" |
![]() | 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) | |
![]() | PrecedenceConstraints | This is a container for task precedence constraint definitions. (Inherited from AstTaskNode) | |
![]() | PriorityClass | This value specifies a thread processing priority level for the package. | Default |
![]() | ProtectionLevel | This value specifies the level of data protection for the package. | DontSaveSensitive |
![]() | ReferenceCount | This value specifies the total number of other node properties that hold a reference to this node. (Inherited from AstNamedNode) | 0 |
![]() | References | This is a collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node. (Inherited from AstNamedNode) | |
![]() | 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. | false |
![]() | 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) | |
![]() | SuppressConfigurationWarnings | This value specifies whether warnings generated by configurations for this package are suppressed. | false |
![]() | Tasks | Container for child task definitions. (Inherited from AstContainerTaskBaseNode) This is a container for child task definitions of this container or package. (Inherited from AstContainerTaskBaseNode) | |
![]() | TransactionMode | This value specifies the transaction context in which this task will execute. (Inherited from AstTaskNode) | Join |
![]() | Variables | This is a container for variable definitions that are specific to this task, container, or package. (Inherited from AstTaskNode) |
Events
| Name | Summary | |
|---|---|---|
![]() | 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. (Inherited from AstNamedNode) |
![]() | 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. (Inherited from AstNamedNode) |
![]() | 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. (Inherited from AstNode) |
![]() | 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. (Inherited from AstNamedNode) |
Extension Methods
| Name | Summary | |
|---|---|---|
![]() | GetBiml |
Retrieve the Biml that represents the AstNode
(Inherited from AstNode) [Extension Method: Import namespace Varigence.Hadron.Extensions] |
.NET API Metadata
Code Namespace:
Varigence.Languages.Biml.Task
Assembly:
Biml
Friendly Name:
Package
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstPackageNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False
Properties Referencing This Type
| Referencing Type | Referencing Property | Property Summary | |
|---|---|---|---|
![]() | AstPackageResourceNode | Package | This value specifies a direct reference to the target package. |
![]() | AstRootNode | Packages | This is a collection of all SQL Server Integration Services package definitions in the project. |








