Biml API Reference
AstRootNode Type
BimlStudio 2017

AstRootNode serves as the root of the entire project tree. Anything that can be defined in a Biml project must be a descendant of the AstRootNode, and all constructs in the project can be reached by following a path through the child properties starting at the AstRootNode.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
AdoNetConnections
Gets a collection of all AstAdoNetConnectionNode objects contained in the Connections property for this root node
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)
BuildSettings
Gets a collection of all root-level items contained by this root node
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
Connections
This is a collection of all connection definitions in the project.
CubeProjects
Gets a collection of all AstCubeProjectNode objects contained in the Projects property for this root node
Cubes
This is a collection of all SQL Server Analysis Services (SSAS) cube definitions in the project.
Databases
This is a collection of all database definitions in the project.
DataFactories
This is a collection of all Azure Data Factory linked service, dataset, and pipeline objects in the project.
DbConnections
Gets a collection of all AstDbConnectionNode objects contained in the Connections property for this root node
Dimensions
Gets a collection of all AstDimensionMetadataNode objects contained in the all Tables for this root node
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)
FileFormats
This is a collection of all file format definitions in the project.
FlatFileFormats
Gets a collection of all AstFlatFileFormatNode objects contained in the FileFormats property for this root node
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)
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
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
GlobalBuildSettings
Gets a collection of all root-level items contained by this root node
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
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)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Items
Gets a collection of all root-level items contained by this root node
MeasureGroups
Gets a collection of all AstMeasureGroupMetadataNode objects contained in the all Tables for this root node
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Metadata
Defines the collection of offline metadata contaiers associated with this Biml project These containers can be used to store query and table column type information which can then be used to perform builds without needing to connect to the live data sources.
MetadataInstances
Gets a collection of all AstMetadataInstanceNode objects contained in the Metadata collection for this root node
MetadataModels
Gets a collection of all AstMetadataModelNode objects contained in the Metadata collection for this root node
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)
OdbcConnections
Gets a collection of all AstOdbcConnectionNode objects contained in the Connections property for this root node
OfflineSchemas
Gets a collection of all AstOfflineSchemaNode objects contained in the Metadata collection for this root node
OleDbConnections
Gets a collection of all AstOleDbConnectionNode objects contained in the Connections property for this root node
PackageProjects
Gets a collection of all AstPackageProjectNode objects contained in the Projects property for this root node
Packages
This is a collection of all SQL Server Integration Services package definitions in the project.
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)
Principals
This is a collection of all principal definitions in the project.
Projects
Defines the collection of PackageProjects and CubeProjects associated with this Biml project.
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)
RawFileFormats
Gets a collection of all AstRawFileFormatNode objects contained in the FileFormats property for this root node
RootItemXsdName
Retrieves the root schema element name corresponding to this root item.
Schemas
This is a collection of all database schema definitions in the project.
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScriptProjects
This is a collection of all SQL Server Integration Services script project definitions in the project.
Servers
This is a collection of all server definitions in the project.
SsisPackageParts
This is a collection of all SQL Server Integration Services package part definitions in the project.
SymbolTable
Gets the symbol table that is used to track referenceable items in this project.
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
Tables
This is a collection of all regular table definitions in the project.
TabularModels
This is a collection of all SQL Server Analysis Services (SSAS) tabular model definitions in the project.
TabularProjects
Gets a collection of all AstTabularProjectNode objects contained in the Projects property for this root node
TabularTables
Gets a collection of all AstTabularMetadataNode objects contained in the all Tables for this root node
TierFilteredRootItemType
Gets the type of the tier filtered root item that corresponds to this root item type.
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
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.
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:
Root
Abstract:
False
Referenceable:
False
Root Item:
True
Scope Boundary:
False
Symbol Table Provider:
True
Xml Schema Name:
Varigence.Languages.Biml.AstRootNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
False
Scope Boundary:
False