BIML API Reference
AstDimensionNode Node Type
Fact table objects include all of the capabilities of regular tables and additionally correspond directly to a Dimension in SQL Server Analysis Services (SSAS).
Inheritance Hierarchy
- Varigence.Languages.Biml.AstNode
- Varigence.Languages.Biml.AstNamedNode
- Varigence.Languages.Biml.AstScopeBoundaryNode
- Varigence.Languages.Biml.AstSecurableNode
- Varigence.Languages.Biml.Table.AstTableNode
- Varigence.Languages.Biml.Dimension.AstDimensionNode
Namespace:
Varigence.Languages.Biml.Dimension
Assembly:
Biml (in Biml.dll)
Language 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) | |
| AttributeAllMemberName | This value specifies the All member attribute of the dimension. | |
| AttributeAllMemberTranslations | This value contains alternate language versions for the captions of the All member of the dimension. | |
| AttributeHierarchies | This is a container for definitions of the attribute hierarchies associated with the dimension. | |
| Attributes | This is a container for definitions of the attributes associated with the dimension. | |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. (Inherited from AstNode) | |
| Collation | This value specifies the data sorting and comparison methods used by the dimension. | |
 | 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) | None |
 | Connection | This value specifies the connection where the table is located. (Inherited from AstTableNode) | |
| CurrentStorageMode | This value specifies which storage mode the dimension uses. | Molap |
| CustomExtensions | This is a collecton of containers for table index definitions or other table customization. (Inherited from AstTableNode) | |
| DimensionType | This value specifies the type of the dimension. This type information is passed to the OLAP client such as Microsoft Excel for presentation to the end-user. | Regular |
| ErrorConfiguration | This value specifies the error configuration properties associated with the dimension. Error configuration includes error logging; null, duplicate, and unknown key handling; error actions; and other settings. | |
| 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. (Inherited from AstTableNode) | |
| Indexes | This is a container for table index definitions. (Inherited from AstTableNode) | |
| Keys | This is a container for table key definitions. (Inherited from AstTableNode) | |
| Language | This value specifies the default language to be associated with the dimension. | None |
| 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) | false |
| MdxMissingMemberMode | This value specifies how missing members are handled for Multidimensional Expressions (MDX) statements. | Default |
| 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. (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) | |
| ProactiveCaching | This value defines how proactive caching is performed for the dimension. Proactive caching enables a dimension to use a MOLAP-style multidimensional store for data but to update that store automatically to stay up-to-date with changes to the underlying relational store. This provides a compromise between MOLAP and ROLAP cube storage models. | |
| ProcessingGroup | This value specifies the processing group for the dimension. The default value is ByAttribute. | ByAttribute |
| ProcessingMode | This value specifies when indexing and aggregating occur. The options are Regular, which means that indexing and aggregations occur during processing, or Lazy, which means that indexing aggregation occur after processing is completed. | Regular |
| ProcessingPriority | This value specifies the priority of background processing operations relative to query handling, other non-background functions, and other functions that have a priority specified. Lower integer values indicate lower priority. The default value is 0. | 0 |
| 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) | |
| Relationships | This is a container for definitions of the attribute relationships associated with the dimension. | |
 | 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) | |
| Sources | This is a container for table source definitions. (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) | |
| StorageMode | This value specifies which storage mode the dimension will use. | Molap |
| Translations | This value contains alternate language versions of measure groups, measures, cube dimension, perspectives, KPIs, actions, named sets, and calculated members associated with a dimension. These are used by client applications such as Microsoft Excel to show values for dimension metadata that are consistent with the language of the end-user. | |
| UnknownMember | This value specifies specifies unknown member behavior for the dimension. | None |
| UnknownMemberName | This value specifies captions for unknown members of the dimension. | |
| WriteEnabled | This value specifies whether users are able to modify the contents of the dimension. | False |
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
(Inherited from AstTableNode) [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
(Inherited from AstTableNode) [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
(Inherited from AstTableNode) [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement] |
| GetTableSql |
Generates the SQL statement to create a table
(Inherited from AstTableNode) [Extension Method: Import namespace Varigence.Hadron.Extensions.SchemaManagement] |
.NET API Metadata
Code Namespace:
Varigence.Languages.Biml.Dimension
Assembly:
Biml
Friendly Name:
Dimension
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Dimension.AstDimensionNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False
Properties Referencing This Type
| Referencing Type | Referencing Property | Property Summary | |
|---|---|---|---|
 | AstCubeDimensionNode | Dimension | This value specifies the unique identifier (ID) of the database dimension. |
| AstDatabaseDimensionPermissionNode | Dimension | This value specifies the database dimension to which the permission is applied. |
| AstDimensionProcessingConfigurationNode | Dimension | This value specifies a direct reference to the dimension that will be processed. |
| AstRootNode | Dimensions | This is a collection of all dimension table definitions in the project. |