semantic-link-labs 0.7.3__py3-none-any.whl → 0.8.0__py3-none-any.whl

sempy_labs/tom/_model.py

@@ -230,7 +230,10 @@ class TOMWrapper:
         description: Optional[str] = None,
         display_folder: Optional[str] = None,
         format_string_expression: Optional[str] = None,
+        data_category: Optional[str] = None,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
+        detail_rows_expression: Optional[str] = None,
     ):
         """
         Adds a measure to the semantic model.
@@ -253,8 +256,14 @@ class TOMWrapper:
             The display folder in which the measure will reside.
         format_string_expression : str, default=None
             The format string expression.
+        data_category : str, default=None
+            Specifies the type of data contained in the measure so that you can add custom behaviors based on measure type.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
+        detail_rows_expression : str, default=None
+            The detail rows expression.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
 
@@ -272,8 +281,16 @@ class TOMWrapper:
             fsd = TOM.FormatStringDefinition()
             fsd.Expression = format_string_expression
             obj.FormatStringDefinition = fsd
+        if lineage_tag is not None:
+            obj.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
+        if detail_rows_expression is not None:
+            drd = TOM.DetailRowsDefinition()
+            drd.Expression = detail_rows_expression
+            obj.DetailRowsDefinition = drd
+        if data_category is not None:
+            obj.DataCategory = data_category
 
         self.model.Tables[table_name].Measures.Add(obj)
 
@@ -290,6 +307,7 @@ class TOMWrapper:
         data_category: Optional[str] = None,
         key: Optional[bool] = False,
         summarize_by: Optional[str] = None,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
         """
@@ -320,6 +338,8 @@ class TOMWrapper:
         summarize_by : str, default=None
             Sets the value for the Summarize By property of the column.
             Defaults to None resolves to 'Default'.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -354,6 +374,8 @@ class TOMWrapper:
             obj.DisplayFolder = display_folder
         if data_category is not None:
             obj.DataCategory = data_category
+        if lineage_tag is not None:
+            obj.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
         self.model.Tables[table_name].Columns.Add(obj)
@@ -371,6 +393,7 @@ class TOMWrapper:
         data_category: Optional[str] = None,
         key: Optional[bool] = False,
         summarize_by: Optional[str] = None,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
         """
@@ -401,6 +424,8 @@ class TOMWrapper:
         summarize_by : str, default=None
             Sets the value for the Summarize By property of the column.
             Defaults to None resolves to 'Default'.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -435,6 +460,8 @@ class TOMWrapper:
             obj.DisplayFolder = display_folder
         if data_category is not None:
             obj.DataCategory = data_category
+        if lineage_tag is not None:
+            obj.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
         self.model.Tables[table_name].Columns.Add(obj)
@@ -452,6 +479,7 @@ class TOMWrapper:
         data_category: Optional[str] = None,
         key: Optional[bool] = False,
         summarize_by: Optional[str] = None,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
         """
@@ -482,6 +510,8 @@ class TOMWrapper:
         summarize_by : str, default=None
             Sets the value for the Summarize By property of the column.
             Defaults to None which resolves to 'Default'.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -516,6 +546,8 @@ class TOMWrapper:
             obj.DisplayFolder = display_folder
         if data_category is not None:
             obj.DataCategory = data_category
+        if lineage_tag is not None:
+            obj.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
         self.model.Tables[table_name].Columns.Add(obj)
@@ -677,6 +709,7 @@ class TOMWrapper:
         levels: Optional[List[str]] = None,
         hierarchy_description: Optional[str] = None,
         hierarchy_hidden: Optional[bool] = False,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
         """
@@ -696,6 +729,8 @@ class TOMWrapper:
             A description of the hierarchy.
         hierarchy_hidden : bool, default=False
             Whether the hierarchy is visible or hidden.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -724,6 +759,8 @@ class TOMWrapper:
         obj.IsHidden = hierarchy_hidden
         if hierarchy_description is not None:
             obj.Description = hierarchy_description
+        if lineage_tag is not None:
+            obj.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             obj.SourceLineageTag = source_lineage_tag
         self.model.Tables[table_name].Hierarchies.Add(obj)
@@ -871,7 +908,12 @@ class TOMWrapper:
         self.model.Tables.Add(tbl)
 
     def add_expression(
-        self, name: str, expression: str, description: Optional[str] = None, source_lineage_tag: Optional[str] = None,
+        self,
+        name: str,
+        expression: str,
+        description: Optional[str] = None,
+        lineage_tag: Optional[str] = None,
+        source_lineage_tag: Optional[str] = None,
     ):
         """
         Adds an `expression <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.namedexpression?view=analysisservices-dotnet>`_ to a semantic model.
@@ -884,6 +926,8 @@ class TOMWrapper:
             The M expression of the expression.
         description : str, default=None
             A description of the expression.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -893,6 +937,8 @@ class TOMWrapper:
         exp.Name = name
         if description is not None:
             exp.Description = description
+        if lineage_tag is not None:
+            exp.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             exp.SourceLineageTag = source_lineage_tag
         exp.Kind = TOM.ExpressionKind.M
@@ -988,6 +1034,7 @@ class TOMWrapper:
         entity_name: str,
         expression: Optional[str] = None,
         description: Optional[str] = None,
+        schema_name: Optional[str] = None,
     ):
         """
         Adds an entity partition to a table within a semantic model.
@@ -997,12 +1044,14 @@ class TOMWrapper:
         table_name : str
             Name of the table.
         entity_name : str
-            Name of the lakehouse table.
+            Name of the lakehouse/warehouse table.
         expression : TOM Object, default=None
             The expression used by the table.
             Defaults to None which resolves to the 'DatabaseQuery' expression.
         description : str, default=None
             A description for the partition.
+        schema_name : str, default=None
+            The schema name.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
 
@@ -1013,6 +1062,8 @@ class TOMWrapper:
             ep.ExpressionSource = self.model.Expressions["DatabaseQuery"]
         else:
             ep.ExpressionSource = self.model.Expressions[expression]
+        if schema_name is not None:
+            ep.SchemaName = schema_name
         p = TOM.Partition()
         p.Name = table_name
         p.Source = ep
@@ -1601,13 +1652,25 @@ class TOMWrapper:
         objType = object.ObjectType
 
         # Have to remove translations and perspectives on the object before removing it.
-        if objType in ["Table", "Column", "Measure", "Hierarchy", "Level"]:
+        if objType in [
+            TOM.ObjectType.Table,
+            TOM.ObjectType.Column,
+            TOM.ObjectType.Measure,
+            TOM.ObjectType.Hierarchy,
+            TOM.ObjectType.Level,
+        ]:
             for lang in object.Model.Cultures:
                 try:
                     self.remove_translation(object=object, language=lang.Name)
                 except Exception:
                     pass
-        if objType in ["Table", "Column", "Measure", "Hierarchy"]:
+        if objType in [
+            TOM.ObjectType.Table,
+            TOM.ObjectType.Column,
+            TOM.ObjectType.Measure,
+            TOM.ObjectType.Hierarchy,
+            TOM.ObjectType.Level,
+        ]:
             for persp in object.Model.Perspectives:
                 try:
                     self.remove_from_perspective(
@@ -2524,6 +2587,7 @@ class TOMWrapper:
         description: Optional[str] = None,
         data_category: Optional[str] = None,
         hidden: Optional[bool] = False,
+        lineage_tag: Optional[str] = None,
         source_lineage_tag: Optional[str] = None,
     ):
         """
@@ -2539,6 +2603,8 @@ class TOMWrapper:
             The data category for the table.
         hidden : bool, default=False
             Whether the table is hidden or visible.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
         source_lineage_tag : str, default=None
             A tag that represents the lineage of the source for the object.
         """
@@ -2550,6 +2616,8 @@ class TOMWrapper:
             t.Description = description
         if data_category is not None:
             t.DataCategory = data_category
+        if lineage_tag is not None:
+            t.LineageTag = lineage_tag
         if source_lineage_tag is not None:
             t.SourceLineageTag = source_lineage_tag
         t.Hidden = hidden
@@ -2562,6 +2630,8 @@ class TOMWrapper:
         description: Optional[str] = None,
         data_category: Optional[str] = None,
         hidden: Optional[bool] = False,
+        lineage_tag: Optional[bool] = None,
+        source_lineage_tag: Optional[bool] = None,
     ):
         """
         Adds a calculated table to the semantic model.
@@ -2578,6 +2648,10 @@ class TOMWrapper:
             The data category for the table.
         hidden : bool, default=False
             Whether the table is hidden or visible.
+        lineage_tag : str, default=None
+            A tag that represents the lineage of the object.
+        source_lineage_tag : str, default=None
+            A tag that represents the lineage of the source for the object.
         """
         import Microsoft.AnalysisServices.Tabular as TOM
 
@@ -2594,6 +2668,10 @@ class TOMWrapper:
             t.Description = description
         if data_category is not None:
             t.DataCategory = data_category
+        if lineage_tag is not None:
+            t.LineageTag = lineage_tag
+        if source_lineage_tag is not None:
+            t.SourceLineageTag = source_lineage_tag
         t.Hidden = hidden
         t.Partitions.Add(par)
         self.model.Tables.Add(t)
@@ -3937,7 +4015,7 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
         import System
 
-        c = self.model.Tables[table_name].Measures[column_name]
+        c = self.model.Tables[table_name].Columns[column_name]
         if c.Type == TOM.ColumnType.Data:
             if source_column is not None:
                 c.SourceColumn = source_column