BIML API Reference

AstTableNode Node Type

Table objects correspond directly to regular tables in the SQL Server product. They support all of the same features and present all of the same limitations.

Inheritance Hierarchy

Namespace:

Varigence.Languages.Biml.Table

Assembly:

Biml (in Biml.dll)

Language Element:

Table Element

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)
Columns	This is a container for table column definitions.
CompressionType	This value specifies what kind of compression the table uses.	None
Connection	This value specifies the connection where the table is located.
CustomExtensions	This is a collecton of containers for table index definitions or other table customization.
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
FriendlyName	Specifies the name to use in the SSAS data source view and downstream SSAS objects.
Indexes	This is a container for table index definitions.
Keys	This is a container for table key definitions.
LateArriving	This value specifies whether the table supports late arriving rows. Late arriving rows allow the table to create placeholder values that are patched later when a dimension foreign key value is loaded in a referencing tabe before it is present in this table.	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)
PackageSubpath	This specifies a file path fragment to use for emitting output files for this table. It is most commonly employed to ensure that the output files for multiple tables 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)
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.
Sources	This is a container for table source definitions.
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]
	GetColumnList	Builds a string containing the column list for the table, formatted for a SQL statement [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement]
	GetColumnList(AstTableNode, Func<AstTableColumnBaseNode, Boolean>, String, String, String)	Builds a string containing the column list for the table, formatted for a SQL statement [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement]
	GetColumnList(AstTableNode, String, String, String)	Builds a string containing the column list for the table, formatted for a SQL statement [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement]
	GetTableSql	Generates the SQL statement to create a table [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement]

.NET API Metadata

Code Namespace:

Varigence.Languages.Biml.Table

Assembly:

Biml

Friendly Name:

Table

Abstract:

False

Referenceable:

True

Root Item:

False

Scope Boundary:

False

Symbol Table Provider:

False

BIML Language Metadata

Xml Schema Name:

Varigence.Languages.Biml.Table.AstTableNode

Xsd Namespace:

http://schemas.varigence.com/biml.xsd

Referenceable:

True

Scope Boundary:

False

Properties Referencing This Type

Referencing Type	Referencing Property	Property Summary
AstColumnPatternProfileRequestNode	TagTable	This value specifies a direct connection to the tag table which will tag 2 string columns - Tag and Term.
AstDatabaseTablePartitionSourceNode	Table	This value specifies a direct reference to the table that stores the rows that will comprise this partition.
AstDataProfileRequestNode	Table	This value specifies a direct connection to the table that will examined by the data profile task.
AstDsvTablePartitionSourceNode	Table	This value specifies a direct reference to the table that stores the rows that will comprise this partition.
AstPackageNode	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.
AstProactiveCachingIncrementalNotificationNode	Table	This value specifies a direct reference to the table to use.
AstRootNode	Tables	This is a collection of all regular table definitions in the project.
AstRootNode	Tables	This is a collection of all regular table definitions in the project.
AstStagingContainerTaskNode	Tables	This is a collection of the tables that will be created at the beginning of execution of this container and destroyed at the end of execution of this container.
AstStagingContainerTaskNode	Tables	This is a collection of the tables that will be created at the beginning of execution of this container and destroyed at the end of execution of this container.
AstTableCloneNode	Table	This is a reference to the table that will serve as the basis for the clone table. Except as modified using the other clone table properties, the clone table will be an exact schema copy of the referenced table.
AstTableColumnTableReferenceNode	Table	This value specifies the name of a table to reference. This creates a column that matches the type of the primary key of the referenced table and also creates a foreign key constraint on the referenced table, unless the foreign key feature is disabled.
AstTablePermissionNode	Table	This value specifies the table to which the permission is applied.
AstTableResourceNode	Table	This value specifies a direct reference to the target table.
AstValueInclusionProfileRequestNode	SupersetTableOrView	This value specifies a direct connection to the table that will used as the superset table.

By Product

By Audience

Audience Offerings

Consulting

Training

About Varigence

Work at Varigence

Varigence, Inc.