Biml API Reference
AstTableCloneNode Type
BimlStudio 2017

TableClone enables you to create a copy of an existing table, allowing you to add your own additional columns, indexes, and keys in order to support staging mechanisms, temp-tables, etc.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
AllMergedColumns
Gets a collection of all columns including, those from ancestor clone tables, base tables, and this clone table
(Inherited from AstTableNode)
AllMergedColumns
Gets a collection of all columns including, those from ancestor clone tables, base tables, and this clone table
AllMergedIndexes
Gets a collection of all indexes including, those from ancestor clone tables, base tables, and this clone table
(Inherited from AstTableNode)
AllMergedIndexes
Gets a collection of all indexes including, those from ancestor clone tables, base tables, and this clone table
AllMergedKeys
Gets a collection of all keys including, those from ancestor clone tables, base tables, and this clone table
(Inherited from AstTableNode)
AllMergedKeys
Gets a collection of all keys including, those from ancestor clone tables, base tables, and this clone table
AllMergedSources
Gets a collection of all sources including, those from ancestor clone tables, base tables, and this clone table
(Inherited from AstTableNode)
AllMergedSources
Gets a collection of all sources including, those from ancestor clone tables, base tables, and this clone table
AllRelationalColumns
Gets a collection of all columns including, those from ancestor clone tables, base tables, and this clone table but excluding those that are placeholders for Analysis Services Named Calculations
(Inherited from AstTableNode)
AllRelationalColumns
Gets a collection of all columns including, those from ancestor clone tables, base tables, and this clone table but excluding those that are placeholders for Analysis Services Named Calculations
AnalysisMetadata
This is a container for all SQL Server Analysis Services (SSAS) metadata objects that are associated with this table definition. These include both multidimensional and tabular metadata.
(Inherited from AstTableNode)
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)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
(Inherited from AstTableNode)
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
(Inherited from AstTableNode)
CheckConstraints
Defines the collection of check constraints associated with the table.
(Inherited from AstTableNode)
ClonedColumns
This collection is for internal use only. It is used to store column definitions that have been cloned from the table that is the basis for this clone table.
ClonedIndexes
This collection is for internal use only. It is used to store index definitions that have been cloned from the table that is the basis for this clone table.
ClonedKeys
This collection is for internal use only. It is used to store key definitions that have been cloned from the table that is the basis for this clone table.
ClonedSources
This collection is for internal use only. It is used to store source definitions that have been cloned from the table that is the basis for this clone table.
CloneIndexes
This value specifies whether indexes from the referenced table should be included in the cloned table. In situations where the clone table will be used for a smaller amount of data or for different purposes than the reference table, the same indexes may not be required. The default value is False.
CloneIndexesDefaultValue
Gets the default value for the CloneIndexes property
CloneKeys
This value specifies whether keys from the referenced table should be included in the cloned table. In situations where the clone table will include unverified data, the same keys may not be valid. The default value is False.
CloneKeysDefaultValue
Gets the default value for the CloneKeys property
CloneStaticSources
This value specifies whether static source values defined on the referenced table should also be added to the clone table. Static source values are those data items that are prepopulated into the table when it is created. The default value is False.
CloneStaticSourcesDefaultValue
Gets the default value for the CloneStaticSources property
Columns
This is a container for table column definitions.
(Inherited from AstTableNode)
CompressionType
This value specifies what kind of compression the table uses.
(Inherited from AstTableNode)
CompressionTypeDefaultValue
Gets the default value for the CompressionType property
(Inherited from AstTableNode)
Connection
Returns the connection used by this object.
(Inherited from AstTableNode)
CustomExtensions
This is a collecton of containers for table index definitions or other table customization.
(Inherited from AstTableNode)
DatabaseQualifiedName
Returns the database qualified name for the table.
(Inherited from AstTableNode)
DataSourceViewQualifiedName
Returns the schema qualified name for a data source view
(Inherited from AstTableNode)
Emit
Gets or sets a value that determines if this node should be emitted as a package in the build output
(Inherited from AstTableNode)
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)
ExternalPartitionScheme
Defines that the table uses a partition that is not modeled as part of the project. This can also be used to create the table on a particular filegroup or the "default" filegroup.
(Inherited from AstTableNode)
ExternalPartitionSchemeDefaultValue
Gets the default value for the ExternalPartitionScheme property
(Inherited from AstTableNode)
FileGroup
Specifies the database file group within which this table should be created.
(Inherited from AstTableNode)
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)
FriendlyName
Specifies the name to use in the SSAS data source view and downstream SSAS objects.
(Inherited from AstTableNode)
FriendlyNameDefaultValue
Gets the default value for the FriendlyName property
(Inherited from AstTableNode)
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
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstTableNode)
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
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstSecurableNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstTableNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
HasIdentity
Gets a value that indicates whether the table contains any identity columns
(Inherited from AstTableNode)
HasScdColumns
Gets a value indicating whether any of the columns have ScdType of Historical
(Inherited from AstTableNode)
HasTableReferenceCycles
Gets a value to indicate whether this clone table directly or indirectly clones itself or another clone table that clones itself - thereby creating an infinite loop
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
Indexes
This is a container for table index definitions.
(Inherited from AstTableNode)
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)
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 AstTableNode)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Keys
This is a container for table key definitions.
(Inherited from AstTableNode)
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.
(Inherited from AstTableNode)
LateArrivingDefaultValue
Gets the default value for the LateArriving property
(Inherited from AstTableNode)
LogicalDisplayFolder
Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
(Inherited from AstTableNode)
LogicalDisplayFolderDefaultValue
Gets the default value for the LogicalDisplayFolder property
(Inherited from AstTableNode)
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
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)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
NullClonedColumns
This value specifies whether all columns from the referenced tables should be modified to permit null values. This is often useful in situations where the clone table will be used as a staging area for unverified data that will be loaded into the referenced table after null and other quality checks have been performed. The default value is False.
NullClonedColumnsDefaultValue
Gets the default value for the NullClonedColumns property
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)
PackageFileName
Gets the file name of the SSIS package that will be emitted during build, if this node has Emit = true
(Inherited from AstTableNode)
PackageName
Gets the name of the package that will be emitted during build, if this node has Emit = true
(Inherited from AstTableNode)
PackageRelativeFolder
Gets the name of the folder into which the built package will be written, relative to the main build output folder
(Inherited from AstTableNode)
PackageRelativePath
Gets the path to which the built package will be written, relative to the main build output folder
(Inherited from AstTableNode)
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.
(Inherited from AstTableNode)
PackageSubpathDefaultValue
Gets the default value for the PackageSubpath property
(Inherited from AstTableNode)
PackageType
Gets the type of package that will be emitted for the current object
(Inherited from AstTableNode)
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)
PartitionColumn
Defines the table column used by the partition scheme.
(Inherited from AstTableNode)
PartitionScheme
Indicates the partition scheme that will be used by this table.
(Inherited from AstTableNode)
PreferredKey
Gets the preferred key for this table to be used in lookups and other operations. This is the primary key or identity if present. Otherwise, it is based on the key with the minimum number of bytes to compare across all columns referenced by the key.
(Inherited from AstTableNode)
ProjectFileName
Gets the file name of the SSIS project that will be emitted to contain this package, if this node has Emit = true
(Inherited from AstTableNode)
ProjectRelativeFolder
Gets the name of folder into which the SSIS project will be emitted, relative to the main build output folder
(Inherited from AstTableNode)
ProjectRelativePath
Gets the path of the SSIS project that will be emitted to contain this package, relative to the main build output folder
(Inherited from AstTableNode)
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)
ReadOnlyColumns
Gets a collection of the read-only columns contained by this table
(Inherited from AstTableNode)
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(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.
(Inherited from AstTableNode)
SchemaName
Returns an adjusted schema name - either the name of the schema, or null if the schema is the default schema.
(Inherited from AstTableNode)
SchemaQualifiedName
Returns the schema qualified name for the table.
(Inherited from AstTableNode)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
Sources
This is a container for table source definitions.
(Inherited from AstTableNode)
SsasName
Gets the name of the table that should be used for SSAS emission, including DSVs and dimension/fact naming
(Inherited from AstTableNode)
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)
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
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.
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)
View
Defines the information necessary to emit the table as a view.
(Inherited from AstTableNode)
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
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
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.
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.
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.
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.
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]
GetColumnAssignmentList()
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnAssignmentList(String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnAssignmentList(String,String,String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList()
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList(String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList(String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList(String,String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList(String,String,String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnComparisonList(String,String,String,String,String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnList()
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnList(String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetColumnList(String,String,String)
Builds a string containing the column list for the table, formatted for a SQL statement
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetDeleteSql
Generates the SQL statement to delete rows from the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetDropAndCreateDdl()
Generates the SQL statement to drop and create the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetInsertSql
Generates the SQL statement to insert rows into the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetSelectSql
Generates the SQL statement to select rows from the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
GetTableSql
Generates the SQL statement to create the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
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]
GetUpdateSql
Generates the SQL statement to update rows in the table
[Extension Method: Import namespace Varigence.Biml.Extensions.SchemaManagement]
.NET API Metadata
Assembly:
Biml
Friendly Name:
TableClone
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Table.AstTableCloneNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False