BIML API Reference
AstSchemaNode Node Type
Schema objects correspond directly to SQL Server schemas, which are logical containers for tables, stored procedures, views, and other database objects.
Inheritance Hierarchy
- Varigence.Languages.Biml.AstNode
- Varigence.Languages.Biml.AstNamedNode
- Varigence.Languages.Biml.AstScopeBoundaryNode
- Varigence.Languages.Biml.AstSecurableNode
- Varigence.Languages.Biml.Table.AstSchemaNode
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) | |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. (Inherited from AstNode) | |
 | Connection | This value specifies the connection where the schema is located. | |
| CustomExtensions | This collection specifies the definition for one or more SSIS package containers that can be used to execute custom actions relevant to the creation of this schema. This is useful for creating schema-specific stored procedures, custom constraints, and other custom operations. | |
 | Database | This value specifies the database where the schema will be located. Note that the database will not affect generated code and exists solely to allow for multiple schemas with the same name. Server and Database connections are managed in generated code by the Connection. | |
| 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 |
 | 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) | |
| Owner | Specifies the principal as the schema owner. Passed in as the value to the AUTHORIZATION statement on CREATE SCHEMA. | |
| PackageSubpath | This specifies a file path fragment to use for emitting output files for this schema. It is most commonly employed to ensure that the output files for multiple schemas will be placed into the same output directory. | |
| 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) | |
| 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) | |
| 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) |
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.Table
Assembly:
Biml
Friendly Name:
Schema
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Table.AstSchemaNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False
Properties Referencing This Type
| Referencing Type | Referencing Property | Property Summary | |
|---|---|---|---|
 | AstRootNode | Schemas | This is a collection of all database schema definitions in the project. |
| AstSchemaPermissionNode | Schema | This value specifies the schema to which the permission is applied. |
| AstStoredProcNode | Schema | This value specifies the schema to which this stored procedure belongs. If this value is not supplied, the stored procedure will use the default schema specified in the database. |
| AstTableNode | Schema | This value specifies the schema to which this table belongs. If this value is not supplied, the table will use the default schema specified in the database. |