Merge branch 'main' of github.com:semanticdatalayer/SML into ATSCALE-26533-constraint-translations

Author: stanislavtrifonov88

sml-reference/dimension.md

@@ -154,11 +154,14 @@ classDiagram
     Dimension *-- Hierarchy
     Dimension *-- LevelAttribute
     Dimension *-- CalculationGroup
+    Hierarchy *-- DefaultMember
     Hierarchy *-- Level
     LevelAttribute *-- CustomEmptyMember
+    LevelAttribute *-- SharedDegenerateColumns
     Level *-- SecondaryAttribute
     Level *-- MetricalAttribute
     Level *-- Alias
+    Level *-- ParallelPeriods
     CalculationGroup *-- CalculatedMembers
     SecondaryAttribute *-- CustomEmptyMember
     Alias *-- CustomEmptyMember
@@ -182,11 +185,12 @@ namespace Dimensions{
       Object to
       String role_play
       String type
-      Boolean m2m
     }
     class From{
       String dataset
-      Array~Column~ columns
+      Array~String~ join_columns
+      String hierarchy
+      String level
     }
     class To{
       String dimension
@@ -196,17 +200,22 @@ namespace Dimensions{
     class Hierarchy{
       String unique_name
       String label
+      String description
       String folder
       enum filter_empty
+      DefaultMember default_member
       Array~Level~ levels
     }
+    class DefaultMember{
+      String expression
+      Boolean apply_only_when_in_query
+    }
     class Level{
       String unique_name
-      String description
       Array~SecondaryAttribute~ secondary_attributes
       Array~Alias~ aliases
       Array~MetricalAttribute~ metrics
-      String default_member
+      Array~ParallelPeriods~ parallel_periods
       Boolean is_hidden
     }
     class Alias{
@@ -218,11 +227,11 @@ namespace Dimensions{
       String sort_column
       String folder
       Boolean is_hidden
+      String format
       Boolean exclude_from_dim_agg
+      Boolean is_aggregatable
       Boolean exclude_from_fact_agg
       Array~CustomEmptyMember~ custom_empty_member
-      Array~String~ allowed_calcs_for_dma
-      Object role
     }
     class MetricalAttribute{
       String unique_name
@@ -235,11 +244,16 @@ namespace Dimensions{
       String column
       Boolean is_hidden
       Boolean exclude_from_dim_agg
+      Boolean is_aggregatable
       Boolean exclude_from_fact_agg
       CustomEmptyMember custom_empty_member
       enum unrelated_dimensions_handling
       Array~String~ allowed_calcs_for_dma
     }
+    class ParallelPeriods{
+      String level
+      Array~String~ key_columns
+    }
     class LevelAttribute{
       String unique_name
       String label
@@ -252,10 +266,21 @@ namespace Dimensions{
       Boolean is_hidden
       Boolean is_unique_key
       Boolean exclude_from_dim_agg
+      Boolean is_aggregatable
       Boolean exclude_from_fact_agg
       String time_unit
       Int constraint_translation_rank
       Array~String~ allowed_calcs_for_dma
+      CustomEmptyMember custom_empty_member
+      String folder
+      Array~SharedDegenerateColumns~ shared_degenerate_columns
+    }
+    class SharedDegenerateColumns {
+      String dataset
+      String name_column
+      String sort_column
+      Array~String~ key_columns
+      Boolean is_unique_key
     }
     class SecondaryAttribute{
       String unique_name
@@ -267,9 +292,12 @@ namespace Dimensions{
       String sort_column
       Array~String~ key_columns
       Boolean exclude_from_dim_agg
+      Boolean is_aggregatable
       Boolean exclude_from_fact_agg
       Array~String~ allowed_calcs_for_dma
-      Array~CustomEmptyMember~ custom_empty_member
+      CustomEmptyMember custom_empty_member
+      Boolean is_hidden
+      Boolean contains_unique_names
     }
     class CustomEmptyMember{
       Array~String~ key
@@ -289,6 +317,7 @@ namespace Dimensions{
       String format
       String expression
       Boolean use_input_metric_format
+      String template
     }
 }
 ```
@@ -326,14 +355,6 @@ need to be unique.
 
 A description of the dimension.
 
-## folder
-
-- **Type:** string
-- **Required:** N
-
-The name of the folder in which the calculation group appears in BI
-tools.
-
 ## type
 
 - **Type:** enum
@@ -346,6 +367,13 @@ Supported values:
 - `standard`: Can have any type of hierarchy.
 - `time`: Must have a time hierarchy.
 
+## is_degenerate
+
+- **Type:** boolean
+- **Required:** N
+
+Determines whether the dimension is degenerate. 
+
 ## hierarchies
 
 - **Type:** array
@@ -514,6 +542,13 @@ Defines the individual calculated members in the group.
 
 A description of the calculation group.
 
+## folder
+
+- **Type:** string
+- **Required:** N
+
+The name of the folder in which the calculation group is displayed in BI tools.
+
 # Calculated Members Properties
 
 ## unique_name
@@ -707,6 +742,13 @@ For levels in time dimensions only. Defines a custom parallel period for the lev
 
 You can define as many parallel periods for a level as needed.
 
+## is_hidden
+
+- **Type:** boolean
+- **Required:** N
+
+Determines whether the level is visible in BI tools. 
+
 # Secondary Attributes Properties
 
 ## unique_name
@@ -819,7 +861,7 @@ Excludes this attribute from system generated fact-based aggregates. This is use
 
 ## custom\_empty\_member
 
-- **Type:** array
+- **Type:** object
 - **Required:** N
 
 Defines a custom empty member for the attribute. This feature allows fact data with missing or invalid foreign key values to be isolated and independently aggregated from those with valid foreign key values. Because fact records with invalid foreign keys are aggregated separately from records referencing valid dimension members, analysts can easily spot data integrity problems and further investigate them. Use this feature to ensure that un-joinable values are included in query results and aggregated under a specially designated dimension member called the Custom Empty Member.
@@ -1344,7 +1386,7 @@ A list of the empty member values to use for key fields.
 
 The empty member value to use for name fields.
 
-## sort
+## sort_name
 
 - **Type:** string
 - **Required:** N

sml-reference/metric.md

@@ -148,11 +148,13 @@ Defines the metric as a semi-additive metric.
 - **Type:** string
 - **Required:** Y
 
-Determines whether the metric is First Non-Empty or Last Non-Empty.
+Determines whether the metric is First Non-Empty, Last Non-Empty, First Child or Last Child.
 
 Supported values:
 - `first`
 - `last`
+- `first_child` - introduced in version `1.1`
+- `last_child` - introduced in version `1.1`
 
 ### relationships
 

sml-reference/model.md

@@ -195,6 +195,7 @@ classDiagram
     Aggregate *-- AttributeReference
     Perspective *-- PerspectiveDimension
     PerspectiveDimension *-- PerspectiveHierarchy
+    Drillthrough *-- AttributeReferenceDrillthrough
 namespace Models{
     class Model{
       String unique_name
@@ -207,8 +208,9 @@ namespace Models{
       Array~Aggregate~ aggregates
       Array~Perspective~ perspectives
       Array~Drillthrough~ drillthroughs
-      Array~Partition~ partition
+      Array~Partition~ partitions
       Boolean include_default_drillthrough
+      Object overrides
     }
     class Relationship{
       String unique_name
@@ -243,13 +245,19 @@ namespace Models{
       String unique_name
       String notes
       Array~String~ metrics
-      Array~AttributeReference~ attributes
+      Array~AttributeReferenceDrillthrough~ attributes
+    }
+    class AttributeReferenceDrillthrough{
+      String name
+      String dimension
+      Array~String~ relationships_path
     }
     class AttributeReference{
       String name
       String dimension
       String partition
       String distribution
+      Array~String~ relationships_path
     }
     class Partition{
       String unique_name
@@ -271,14 +279,12 @@ namespace Models{
     }
     class PerspectiveDimension{
       String name
-      Boolean visible
       Array~PerspectiveHierarchy~ hierarchies
-      Array~String~ secondaryattributes
-      Array~String~ metrics
+      Array~String~ secondary_attributes
+      Array~String~ relationships_path
     }
     class PerspectiveHierarchy{
       String name
-      Boolean visible
       Array~String~ levels
     }
 }
@@ -498,18 +504,18 @@ Supported properties:
 - `name`: String, required. The name of the dimension to include in the
   perspective.
 
-- `prefixes`: Array, optional.
-
 - `hierarchies`: Array, optional. A list of the specific hierarchies
   within the `name` dimension to include in the perspective. Supported
   properties:
-- `name`: String, required. The name of the hierarchy.
-- `levels`: Array, optional. A list of the levels within the
-  hierarchy to include in the perspective.
+    - `name`: String, required. The name of the hierarchy.
+    - `levels`: Array, optional. A list of the levels within the
+    hierarchy to include in the perspective.
 
-- `secondaryattributes`: Array, optional. A list of the dimension's
+- `secondary_attributes`: Array, optional. A list of the dimension's
   secondary attributes to include in the perspective.
 
+- `relationships_path`: Array, optional. A list of relationships path.
+
 ## drillthroughs
 
 - **Type:** array
@@ -563,6 +569,7 @@ Supported properties:
   drillthrough.
 - `dimension`: String, optional. The dimension that the attribute
   defined by `name` appears in.
+- `relationships_path`: Array, optional. A list of relationships path.
 
 ## aggregates
 
@@ -754,3 +761,36 @@ you want to set for it at the model level. For example:
 
     dataset1:
         create_hinted_aggregate: true
+
+## overrides
+
+- **Type:** object
+- **Required:** N
+
+The `overrides` property in a model file enables the creation of query name overrides for metrics and degenerate dimensions referenced in а model.
+This scenario arises from legacy projects where metrics or dimensions in different models can use the same `unique_name` when deployed.
+Since project scope uniqueness is enforced these metrics/dimensions are required have a different `unique_name` value in the repo.
+When a model is deployed the overridden `unique_name` is replaced by the original value.
+The best practice is to never use the same `unique_name` for different objects across models so overrides should only be used when migrating
+from a legacy model and wanting to maintain the same query name for existing interfaces.
+
+**Note:** This applies only for degenerate dimensions, NOT the dimensions part of relationships.
+
+- The object key must be a metric or a dimension referenced in the model.
+
+### query_name
+
+- **Type:** string
+- **Required:** Y
+
+The query name that the metric or dimension should be resolved to.
+
+Sample `overrides`:
+
+```yaml
+overrides:
+  salesamount: 
+    query_name: deployed query name for metric
+  Color Dimension:
+    query_name: deployed query name for dimension
+```