Table Clone Element
X-Ref:
- Ast Table Clone Node
- Ast Table Node
- Ast Securable Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| TableName | AstTableNode | 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. This is a required reference to an existing definiton. | |
| CloneIndexes | Boolean | false | 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. |
| CloneKeys | Boolean | false | 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. |
| CloneStaticSources | Boolean | false | 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. |
| CompressionType | TableCompressionType | None | This value specifies what kind of compression the table uses. |
| ExternalPartitionScheme | String | 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. | |
| FriendlyName | String | Specifies the name to use in the SSAS data source view and downstream SSAS objects. | |
| LateArriving | Boolean | false | 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. |
| LogicalDisplayFolder | String | string.Empty | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. |
| NullClonedColumns | Boolean | false | 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. |
| PackageSubpath | String | 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. | |
| PartitionColumnName | AstTableColumnBaseNode | Defines the table column used by the partition scheme. This references an existing definiton. | |
| PartitionSchemeName | AstPartitionSchemeNode | Indicates the partition scheme that will be used by this table. This references an existing definiton. | |
| SchemaName | AstSchemaNode | This value specifies the schema to which this table belongs. This value must be supplied unless the table is configured as an SsasOnly View. This references an existing definiton. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <FileGroup /> | AstDatabaseFileGroupResourceNode | AstDatabaseFileGroupResourceNode is used for creating references to database file groups that have been modeled in the Biml project. |
| <ExternalFileGroup /> | AstExternalDatabaseFileGroupResourceNode | AstExternalDatabaseFileGroupResourceNode is used for creating references to database file groups that have not been modeled in the Biml project. |
| <View /> | AstViewNode | Defines a view, based on a SELECT statement and additional metadata. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Columns> Multiple Choices... </Columns> | AstTableColumnBaseNode | This is a container for table column definitions. This is a required property |
| <AnalysisMetadata> Multiple Choices... </AnalysisMetadata> | AstAnalysisMetadataBaseNode | 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. |
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | 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. |
| <CheckConstraints> <CheckConstraint /> </CheckConstraints> | AstCheckConstraintNode | Defines the collection of check constraints associated with the table. |
| <CustomExtensions> <CustomExtension /> </CustomExtensions> | AstCustomExtensionContainerTaskNode | This is a collecton of containers for table index definitions or other table customization. |
| <Indexes> <Index /> </Indexes> | AstTableIndexNode | This is a container for table index definitions. |
| <Keys> Multiple Choices... </Keys> | AstTableKeyBaseNode | This is a container for table key definitions. |
| <Sources> <StaticSource /> </Sources> | AstTableSourceBaseNode | This is a container for table source definitions. |