semantic-link-labs 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

sempy_labs/tom/_model.py

@@ -93,7 +93,7 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
 
         for t in self.model.Tables:
-            if any(p.SourceType == TOM.ColumnType.Calculated for p in t.Partitions):
+            if any(p.SourceType == TOM.PartitionSourceType.Calculated for p in t.Partitions):
                 yield t
 
     def all_calculation_groups(self):
@@ -658,22 +658,16 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
 
         if isinstance(columns, str):
-            print(
-                f"{icons.red_dot} The 'levels' parameter must be a list. For example: ['Continent', 'Country', 'City']"
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The 'levels' parameter must be a list. For example: ['Continent', 'Country', 'City']")
+            
         if len(columns) == 1:
-            print(f"{icons.red_dot} There must be at least 2 levels in order to create a hierarchy.")
-            return
+            raise ValueError(f"{icons.red_dot} There must be at least 2 levels in order to create a hierarchy.")            
 
         if levels is None:
             levels = columns
 
         if len(columns) != len(levels):
-            print(
-                f"{icons.red_dot} If specifying level names, you must specify a level for each column."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} If specifying level names, you must specify a level for each column.")            
 
         obj = TOM.Hierarchy()
         obj.Name = hierarchy_name
@@ -1003,9 +997,7 @@ class TOMWrapper:
         import System
 
         if base_column is not None and base_table is None:
-            print(
-                f"{icons.red_dot} If you specify the base table you must also specify the base column"
-            )
+            raise ValueError(f"{icons.red_dot} If you specify the base table you must also specify the base column")
 
         summarization_type = (
             summarization_type.replace(" ", "")
@@ -1015,10 +1007,7 @@ class TOMWrapper:
 
         summarizationTypes = ["Sum", "GroupBy", "Count", "Min", "Max"]
         if summarization_type not in summarizationTypes:
-            print(
-                f"{icons.red_dot} The 'summarization_type' parameter must be one of the following valuse: {summarizationTypes}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The 'summarization_type' parameter must be one of the following valuse: {summarizationTypes}.")
 
         ao = TOM.AlternateOf()
         ao.Summarization = System.Enum.Parse(TOM.SummarizationType, summarization_type)
@@ -1277,10 +1266,7 @@ class TOMWrapper:
         objectType = object.ObjectType
 
         if objectType not in validObjects:
-            print(
-                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}.")
 
         object.Model.Perspectives[perspective_name]
 
@@ -1331,15 +1317,12 @@ class TOMWrapper:
         objectType = object.ObjectType
 
         if objectType not in validObjects:
-            print(
-                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}.")
+
         try:
             object.Model.Perspectives[perspective_name]
         except:
-            print(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
-            return
+            raise ValueError(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
 
         # try:
         if objectType == TOM.ObjectType.Table:
@@ -1393,15 +1376,12 @@ class TOMWrapper:
         objectType = object.ObjectType
 
         if objectType not in validObjects:
-            print(
-                f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Only the following object types are valid for perspectives: {validObjects}.")
+
         try:
             object.Model.Perspectives[perspective_name]
         except:
-            print(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
-            return
+            raise ValueError(f"{icons.red_dot} The '{perspective_name}' perspective does not exist.")
 
         # try:
         if objectType == TOM.ObjectType.Table:
@@ -1474,8 +1454,7 @@ class TOMWrapper:
         ]  # , 'Level'
 
         if object.ObjectType not in validObjects:
-            print(f"{icons.red_dot} Translations can only be set to {validObjects}.")
-            return
+            raise ValueError(f"{icons.red_dot} Translations can only be set to {validObjects}.")
 
         mapping = {
             "Name": TOM.TranslatedProperty.Caption,
@@ -1484,14 +1463,13 @@ class TOMWrapper:
         }
 
         prop = mapping.get(property)
+        if prop == None:
+            raise ValueError(f"{icons.red_dot} Invalid property value. Please choose from the following: ['Name', 'Description', Display Folder].")
 
         try:
             object.Model.Cultures[language]
         except:
-            print(
-                f"{icons.red_dot} The '{language}' translation language does not exist in the semantic model."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{language}' translation language does not exist in the semantic model.")
 
         object.Model.Cultures[language].ObjectTranslations.SetTranslation(
             object, prop, value
@@ -1955,11 +1933,8 @@ class TOMWrapper:
         t = self.model.Tables[table_name]
         c = t.Columns[column_name]
         if c.DataType != TOM.DataType.DateTime:
-            print(
-                f"{icons.red_dot} The column specified in the 'column_name' parameter in this function must be of DateTime data type."
-            )
-            return
-
+            raise ValueError(f"{icons.red_dot} The column specified in the 'column_name' parameter in this function must be of DateTime data type.")
+            
         daxQuery = f"""
         define measure '{table_name}'[test] = 
         var mn = MIN('{table_name}'[{column_name}])
@@ -1978,10 +1953,7 @@ class TOMWrapper:
         )
         value = df["1"].iloc[0]
         if value != "1":
-            print(
-                f"{icons.red_dot} The '{column_name}' within the '{table_name}' table does not contain contiguous date values."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{column_name}' within the '{table_name}' table does not contain contiguous date values.")
 
         # Mark as a date table
         t.DataCategory = "Time"
@@ -2176,10 +2148,7 @@ class TOMWrapper:
         # https://github.com/m-kovalsky/Tabular/blob/master/KPI%20Graphics.md
 
         if measure_name == target:
-            print(
-                f"{icons.red_dot} The 'target' parameter cannot be the same measure as the 'measure_name' parameter."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The 'target' parameter cannot be the same measure as the 'measure_name' parameter.")
 
         if status_graphic is None:
             status_graphic = "Three Circles Colored"
@@ -2192,43 +2161,31 @@ class TOMWrapper:
             status_type = status_type.title().replace(" ", "")
 
         if status_type not in valid_status_types:
-            print(
-                f"{icons.red_dot} '{status_type}' is an invalid status_type. Please choose from these options: {valid_status_types}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} '{status_type}' is an invalid status_type. Please choose from these options: {valid_status_types}.")
 
         if status_type in ["Linear", "LinearReversed"]:
             if upper_bound is not None or lower_mid_bound is not None:
-                print(
-                    f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are not used in the 'Linear' and 'LinearReversed' status types. Make sure these parameters are set to None."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are not used in the 'Linear' and 'LinearReversed' status types. Make sure these parameters are set to None.")
+
             elif upper_bound <= lower_bound:
-                print(f"{icons.red_dot} The upper_bound must be greater than the lower_bound.")
-                return
+                raise ValueError(f"{icons.red_dot} The upper_bound must be greater than the lower_bound.")
 
         if status_type in ["Centered", "CenteredReversed"]:
             if upper_mid_bound is None or lower_mid_bound is None:
-                print(
-                    f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are necessary in the 'Centered' and 'CenteredReversed' status types."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} The 'upper_mid_bound' and 'lower_mid_bound' parameters are necessary in the 'Centered' and 'CenteredReversed' status types.")
             elif upper_bound <= upper_mid_bound:
-                print(f"{icons.red_dot} The upper_bound must be greater than the upper_mid_bound.")
+                raise ValueError(f"{icons.red_dot} The upper_bound must be greater than the upper_mid_bound.")
             elif upper_mid_bound <= lower_mid_bound:
-                print(f"{icons.red_dot} The upper_mid_bound must be greater than the lower_mid_bound.")
+                raise ValueError(f"{icons.red_dot} The upper_mid_bound must be greater than the lower_mid_bound.")
             elif lower_mid_bound <= lower_bound:
-                print(f"{icons.red_dot} The lower_mid_bound must be greater than the lower_bound.")
+                raise ValueError(f"{icons.red_dot} The lower_mid_bound must be greater than the lower_bound.")
 
         try:
             table_name = next(
                 m.Parent.Name for m in self.all_measures() if m.Name == measure_name
             )
         except:
-            print(
-                f"{icons.red_dot} The '{measure_name}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{measure_name}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'.")            
 
         graphics = [
             "Cylinder",
@@ -2251,10 +2208,7 @@ class TOMWrapper:
         ]
 
         if status_graphic not in graphics:
-            print(
-                f"{icons.red_dot} The '{status_graphic}' status graphic is not valid. Please choose from these options: {graphics}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{status_graphic}' status graphic is not valid. Please choose from these options: {graphics}.")
 
         measure_target = True
 
@@ -2270,10 +2224,8 @@ class TOMWrapper:
                     if m.Name == target
                 )
             except:
-                print(
-                    f"{icons.red_dot} The '{target}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'."
-                )
-
+                raise ValueError(f"{icons.red_dot} The '{target}' measure does not exist in the '{self._dataset}' semantic model within the '{self._workspace}'.")
+            
         if measure_target:
             expr = f"var x = [{measure_name}]/[{target}]\nreturn"
         else:
@@ -2396,10 +2348,7 @@ class TOMWrapper:
         )
 
         if value not in values:
-            print(
-                f"{icons.red_dot} '{value}' is not a valid value for the SummarizeBy property. These are the valid values: {values}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} '{value}' is not a valid value for the SummarizeBy property. These are the valid values: {values}.")
 
         self.model.Tables[table_name].Columns[column_name].SummarizeBy = (
             System.Enum.Parse(TOM.AggregateFunction, value)
@@ -2428,10 +2377,7 @@ class TOMWrapper:
         dlValues = ["Automatic", "DirectLakeOnly", "DirectQueryOnly"]
 
         if direct_lake_behavior not in dlValues:
-            print(
-                f"{icons.red_dot} The 'direct_lake_behavior' parameter must be one of these values: {dlValues}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The 'direct_lake_behavior' parameter must be one of these values: {dlValues}.")
 
         self.model.DirectLakeBehavior = System.Enum.Parse(
             TOM.DirectLakeBehavior, direct_lake_behavior
@@ -2529,13 +2475,10 @@ class TOMWrapper:
         import Microsoft.AnalysisServices.Tabular as TOM
 
         if isinstance(objects, str):
-            print(f"{icons.red_dot} The 'objects' parameter must be a list of columns/measures.")
-            return
+            raise ValueError(f"{icons.red_dot} The 'objects' parameter must be a list of columns/measures.")
+
         if len(objects) == 1:
-            print(
-                f"{icons.red_dot} There must be more than one object (column/measure) within the objects parameter."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} There must be more than one object (column/measure) within the objects parameter.")
 
         expr = ""
         i = 0
@@ -2571,10 +2514,7 @@ class TOMWrapper:
                     )
                     success = True
             if not success:
-                print(
-                    f"{icons.red_dot} The '{obj}' object was not found in the '{self._dataset}' semantic model."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} The '{obj}' object was not found in the '{self._dataset}' semantic model.")
             else:
                 i += 1
 
@@ -3244,26 +3184,16 @@ class TOMWrapper:
         rolling_window_granularity = rolling_window_granularity.capitalize()
 
         if incremental_granularity not in incGran:
-            print(
-                f"{icons.red_dot} Invalid 'incremental_granularity' value. Please choose from the following options: {incGran}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'incremental_granularity' value. Please choose from the following options: {incGran}.")
+ 
         if rolling_window_granularity not in incGran:
-            print(
-                f"{icons.red_dot} Invalid 'rolling_window_granularity' value. Please choose from the following options: {incGran}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'rolling_window_granularity' value. Please choose from the following options: {incGran}.")
 
         if rolling_window_periods < 1:
-            print(
-                f"{icons.red_dot} Invalid 'rolling_window_periods' value. Must be a value greater than 0."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'rolling_window_periods' value. Must be a value greater than 0.")
+            
         if incremental_periods < 1:
-            print(
-                f"{icons.red_dot} Invalid 'incremental_periods' value. Must be a value greater than 0."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'incremental_periods' value. Must be a value greater than 0.")
 
         t = self.model.Tables[table_name]
 
@@ -3271,10 +3201,7 @@ class TOMWrapper:
             dc = t.Columns[detect_data_changes_column]
 
             if dc.DataType != TOM.DataType.DateTime:
-                print(
-                    f"{icons.red_dot} Invalid 'detect_data_changes_column' parameter. This column must be of DateTime data type."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} Invalid 'detect_data_changes_column' parameter. This column must be of DateTime data type.")
 
         rp = TOM.BasicRefreshPolicy()
         rp.IncrementalPeriods = incremental_periods
@@ -3354,26 +3281,16 @@ class TOMWrapper:
         rolling_window_granularity = rolling_window_granularity.capitalize()
 
         if incremental_granularity not in incGran:
-            print(
-                f"{icons.red_dot} Invalid 'incremental_granularity' value. Please choose from the following options: {incGran}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'incremental_granularity' value. Please choose from the following options: {incGran}.")
+            
         if rolling_window_granularity not in incGran:
-            print(
-                f"{icons.red_dot} Invalid 'rolling_window_granularity' value. Please choose from the following options: {incGran}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'rolling_window_granularity' value. Please choose from the following options: {incGran}.")
 
         if rolling_window_periods < 1:
-            print(
-                f"{icons.red_dot} Invalid 'rolling_window_periods' value. Must be a value greater than 0."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'rolling_window_periods' value. Must be a value greater than 0.")
+
         if incremental_periods < 1:
-            print(
-                f"{icons.red_dot} Invalid 'incremental_periods' value. Must be a value greater than 0."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'incremental_periods' value. Must be a value greater than 0.")
 
         date_format = "%m/%d/%Y"
 
@@ -3388,10 +3305,7 @@ class TOMWrapper:
         end_day = date_obj_end.day
 
         if date_obj_end <= date_obj_start:
-            print(
-                f"{icons.red_dot} Invalid 'start_date' or 'end_date'. The 'end_date' must be after the 'start_date'."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid 'start_date' or 'end_date'. The 'end_date' must be after the 'start_date'.")
 
         t = self.model.Tables[table_name]
 
@@ -3400,20 +3314,14 @@ class TOMWrapper:
         dType = c.DataType
 
         if dType != TOM.DataType.DateTime:
-            print(
-                f"{icons.red_dot} The {fcName} column is of '{dType}' data type. The column chosen must be of DateTime data type."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The {fcName} column is of '{dType}' data type. The column chosen must be of DateTime data type.")
 
         if detect_data_changes_column is not None:
             dc = t.Columns[detect_data_changes_column]
             dcType = dc.DataType
 
             if dcType != TOM.DataType.DateTime:
-                print(
-                    f"{icons.red_dot} Invalid 'detect_data_changes_column' parameter. This column must be of DateTime data type."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} Invalid 'detect_data_changes_column' parameter. This column must be of DateTime data type.")
 
         # Start changes:
 
@@ -3421,10 +3329,8 @@ class TOMWrapper:
         i = 0
         for p in t.Partitions:
             if p.SourceType != TOM.PartitionSourceType.M:
-                print(
-                    f"{icons.red_dot} Invalid partition source type. Incremental refresh can only be set up if the table's partition is an M-partition."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} Invalid partition source type. Incremental refresh can only be set up if the table's partition is an M-partition.")
+
             elif i == 0:
                 text = p.Expression
                 text = text.rstrip()
@@ -3440,8 +3346,7 @@ class TOMWrapper:
 
                     print(text_before_last_match)
                 else:
-                    print(f"{icons.red_dot} Invalid M-partition expression.")
-                    return
+                    raise ValueError(f"{icons.red_dot} Invalid M-partition expression.")
 
                 endExpr = f'#"Filtered Rows IR" = Table.SelectRows({obj}, each [{column_name}] >= RangeStart and [{column_name}] <= RangeEnd)\n#"Filtered Rows IR"'
                 finalExpr = text_before_last_match + endExpr
@@ -3537,15 +3442,9 @@ class TOMWrapper:
         ht = self.is_hybrid_table(table_name=table_name)
 
         if not ht:
-            print(
-                f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to `hybrid tables <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to `hybrid tables <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}.")
         if p.Mode != TOM.ModeType.DirectQuery:
-            print(
-                f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to the DirectQuery partition of a `hybrid table <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The `data coverage definition <https://learn.microsoft.com/analysis-services/tom/table-partitions?view=asallproducts-allversions>`_ property is only applicable to the DirectQuery partition of a `hybrid table <https://learn.microsoft.com/power-bi/connect-data/service-dataset-modes-understand#hybrid-tables>`_. See the documentation: {doc}.")
 
         dcd = TOM.DataCoverageDefinition()
         dcd.Expression = expression
@@ -3572,10 +3471,7 @@ class TOMWrapper:
         value = value.capitalize()
 
         if value not in values:
-            print(
-                f"{icons.red_dot} Invalid encoding hint value. Please choose from these options: {values}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid encoding hint value. Please choose from these options: {values}.")
 
         self.model.Tables[table_name].Columns[column_name].EncodingHint = (
             System.Enum.Parse(TOM.EncodingHintType, value)
@@ -3617,10 +3513,7 @@ class TOMWrapper:
             value = "Boolean"
 
         if value not in values:
-            print(
-                f"{icons.red_dot} Invalid data type. Please choose from these options: {values}."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} Invalid data type. Please choose from these options: {values}.")
 
         self.model.Tables[table_name].Columns[column_name].DataType = System.Enum.Parse(
             TOM.DataType, value
@@ -3652,10 +3545,7 @@ class TOMWrapper:
         for t in time_intel:
             t = t.capitalize()
             if t not in [time_intel_options]:
-                print(
-                    f"{icons.red_dot} The '{t}' time intelligence variation is not supported. Valid options: {time_intel_options}."
-                )
-                return
+                raise ValueError(f"{icons.red_dot} The '{t}' time intelligence variation is not supported. Valid options: {time_intel_options}.")
 
         # Validate measure and extract table name
         for m in self.all_measures():
@@ -3663,17 +3553,11 @@ class TOMWrapper:
                 table_name = m.Parent.Name
 
         if table_name is None:
-            print(
-                f"{icons.red_dot} The '{measure_name}' is not a valid measure in the '{self._dataset}' semantic model within the '{self._workspace}' workspace."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{measure_name}' is not a valid measure in the '{self._dataset}' semantic model within the '{self._workspace}' workspace.")
 
         # Validate date table
         if not self.is_date_table(date_table):
-            print(
-                f"{icons.red_dot} The '{date_table}' table is not a valid date table in the '{self._dataset}' wemantic model within the '{self._workspace}' workspace."
-            )
-            return
+            raise ValueError(f"{icons.red_dot} The '{date_table}' table is not a valid date table in the '{self._dataset}' wemantic model within the '{self._workspace}' workspace.")
 
         # Extract date key from date table
         for c in self.all_columns():
@@ -3691,6 +3575,80 @@ class TOMWrapper:
                     expression=expr,
                 )
 
+    def update_m_partition(self, table_name: str, partition_name: str, expression: Optional[str | None] = None, mode: Optional[str | None] = None, description: Optional[str | None] = None):
+
+        """
+        Updates an M partition for a table within a semantic model.
+
+        Parameters
+        ----------
+        table_name : str
+            Name of the table.       
+        partition_name : str
+            Name of the partition.
+        expression : str, default=None
+            The `M expression <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.mpartitionsource.expression?view=analysisservices-dotnet>`_ containing the logic for the partition.
+            Defaults to None which keeps the existing setting.
+        mode : str, default=None
+            The query `mode <https://learn.microsoft.com/dotnet/api/microsoft.analysisservices.tabular.modetype?view=analysisservices-dotnet>`_ of the partition.
+            Defaults to None which keeps the existing setting.
+        description : str, default=None
+            The description of the partition.
+            Defaults to None which keeps the existing setting.
+        """
+
+        import Microsoft.AnalysisServices.Tabular as TOM
+        import System
+
+        p = self.model.Tables[table_name].Partitions[partition_name]
+        if p.SourceType != TOM.PartitionSourceType.M:
+            raise ValueError(f"Invalid partition source type. This function is only for M partitions.")
+        if expression is not None:
+            p.Source.Expression = expression
+        if mode is not None:
+            p.Mode = System.Enum.Parse(TOM.ModeType, mode)
+        if description is not None:
+            p.Description = description
+
+    def set_sort_by_column(self, table_name: str, column_name: str, sort_by_column: str):
+
+        """
+        Sets the sort by column for a column in a semantic model.
+
+        Parameters
+        ----------
+        table_name : str
+            Name of the table.       
+        column_name : str
+            Name of the column.
+        sort_by_column : str
+            Name of the column to use for sorting. Must be of integer (Int64) data type.
+        """
+
+        import Microsoft.AnalysisServices.Tabular as TOM
+
+        sbc = self.model.Tables[table_name].Columns[sort_by_column]
+
+        if sbc.DataType != TOM.DataType.Int64:
+            raise ValueError(f"Invalid sort by column data type. The sort by column must be of 'Int64' data type.")
+        
+        self.model.Tables[table_name].Columns[column_name].SortByColumn = sbc
+
+    def remove_sort_by_column(self, table_name: str, column_name: str):
+
+        """
+        Removes the sort by column for a column in a semantic model.
+
+        Parameters
+        ----------
+        table_name : str
+            Name of the table.       
+        column_name : str
+            Name of the column.
+        """
+
+        self.model.Tables[table_name].Columns[column_name].SortByColumn = None
+
     def close(self):
         if not self._readonly and self.model is not None:
             self.model.SaveChanges()
@@ -3742,4 +3700,4 @@ def connect_semantic_model(
     try:
         yield tw
     finally:
-        tw.close()
+        tw.close()

semantic_link_labs-0.4.2.dist-info/RECORD

@@ -1,53 +0,0 @@
-sempy_labs/__init__.py,sha256=aKnIa8tgtzqT939USn5rjCYnMNRu-Aku4mJSEFG75mc,4126
-sempy_labs/_ai.py,sha256=WXWnVJ9g5Xq5ctiMWFNXbrv2WdAhKv5EsO6tCBy8ceE,17930
-sempy_labs/_clear_cache.py,sha256=yahzQ-QojCtAReFT3zK9lrr5LJhkONUr49GC1qXf6Uw,1476
-sempy_labs/_connections.py,sha256=DNgiMbswZM-vv6qnEnZ2RhIuo1HhGobh47X2UYh2br8,7396
-sempy_labs/_dax.py,sha256=u4qVxsu2dVaOJmso-ErScNZ5yI4lGQTlon_jmrAzvGs,2148
-sempy_labs/_generate_semantic_model.py,sha256=PgqqAk3ptVTXHlW6lU5dqGNZUAOjA3xrqmvZX2GlXx8,9273
-sempy_labs/_helper_functions.py,sha256=mzzMFv6SKottNGBXjBe2-cCTgTQXDf6fXT7MmQ05DLA,14313
-sempy_labs/_icons.py,sha256=mREeT-3eJCAbuKwaYf1IZGWYssy6WQ-mBCZ6nFnKGPU,196
-sempy_labs/_list_functions.py,sha256=mxacAOu2MwBBLqOTbwb_Zqmx6liSItbc8fhQgkxkgqQ,53459
-sempy_labs/_model_auto_build.py,sha256=xv4n4pjBAFAxz9Otu0ggx9QJsgRHzOFf_h4Fyou9p8E,5149
-sempy_labs/_model_bpa.py,sha256=6fvUeZ0isLpmeTF4XC6lK9C5NreIJhoAgWpYIoD236s,63250
-sempy_labs/_model_dependencies.py,sha256=e0QhwQs4KuWllbrYdGQnqQ5YwbbC-KKYxvsqT5x7Y6I,13194
-sempy_labs/_one_lake_integration.py,sha256=RRjyDFitYzsC9vvovlYmvame9lRlV0myABAcFZxYffw,6210
-sempy_labs/_query_scale_out.py,sha256=5X6Q8-hskf6VY_VY02VdyMlmBuV77bHWTTKqMdbGLBg,15296
-sempy_labs/_refresh_semantic_model.py,sha256=YUtSnMyln7_8iPY3owG5uwfm8RqRdCPIKh0fTChuiIM,6805
-sempy_labs/_translations.py,sha256=zW2HmJPqDs5p0Mj-1dTIlgee1rSmfZYMcQoPdNsZCmM,18044
-sempy_labs/_vertipaq.py,sha256=18YT-3zDZnsY9DhPh9iQIjuCW8T91zZjliW8cUtbEAY,33385
-sempy_labs/directlake/__init__.py,sha256=HbfHvDvGE4H-xSbV6JO7TUb4HoLGJf2AeuqeQxIuuJ4,1689
-sempy_labs/directlake/_directlake_schema_compare.py,sha256=1N2NHL9XwjdLz-SPFpGAGkGGFsaEAqAfEdNzfUgli-E,4748
-sempy_labs/directlake/_directlake_schema_sync.py,sha256=Fkg8qJdiPF4ppgG2ED9lN40MbobIleT_W5wCTv190rw,5166
-sempy_labs/directlake/_fallback.py,sha256=StqIL9WS6NWHMIBkgqM14my37Foz_zzkCryZtn_Qjj4,2091
-sempy_labs/directlake/_get_directlake_lakehouse.py,sha256=vEY1QBU7gAdoVQIGl59T_1TTYuXbHgk3pZA41EkVkl8,2358
-sempy_labs/directlake/_get_shared_expression.py,sha256=IyjBSIvmhb5Nri1Xf8QoK8owGFQ2znKP60N0U1VDLg0,2012
-sempy_labs/directlake/_guardrails.py,sha256=NJxT4AStorzNimYIRkLW2iu3T2f_QfGZOhIRdW4glVI,2330
-sempy_labs/directlake/_list_directlake_model_calc_tables.py,sha256=a5YOj3FrMj6DGmnNi9iSriredtti8_802L_Da3pBmrI,2079
-sempy_labs/directlake/_show_unsupported_directlake_objects.py,sha256=9e5RSge91Cg_9qGCUqRlIhq2xvPA_ut_bE20SwZHk50,3386
-sempy_labs/directlake/_update_directlake_model_lakehouse_connection.py,sha256=Qq6iYTvMnimNNa67y3Q_Qpigpez49euK2fNXc05Xg4w,3224
-sempy_labs/directlake/_update_directlake_partition_entity.py,sha256=Egr_NH7XoDDEDc8tz2e3JJ5UKXU0H0EgxTAIcpGr5_M,3207
-sempy_labs/directlake/_warm_cache.py,sha256=fkAw7Lpnoh6dnkdFqtKUeH4fhi6Qzk4ydzHQI-KTqEM,8204
-sempy_labs/lakehouse/__init__.py,sha256=i6VRx4dR1SIN-1GxioiNwhC4FxbozRCIz5TfXjb9rKc,587
-sempy_labs/lakehouse/_get_lakehouse_columns.py,sha256=Ot49AuYtoNwsp-gHWqBplclrSD2rscudwXf_PyFU0mY,2578
-sempy_labs/lakehouse/_get_lakehouse_tables.py,sha256=eUeRloAXC5DUEiPNIwcjyRQRnJID_iDzMqIGZM5QJT0,9094
-sempy_labs/lakehouse/_lakehouse.py,sha256=gkLBpxizTAm-ti8OXqbI9VUgurIG4VjxljxKO3xTtE0,2856
-sempy_labs/lakehouse/_shortcuts.py,sha256=k6p4FMW-tLjGR9vRql7vBQf_bDmNYlax6sf47TUIb34,6910
-sempy_labs/migration/__init__.py,sha256=l5v8pC2INdNwbAKVmvWpuVxs6lpb6omim_4BPOmNo4E,1042
-sempy_labs/migration/_create_pqt_file.py,sha256=MNFxF7XVQBT_-iklsvgm41vG2fyZ0WS42jJ9iFrZVRc,9195
-sempy_labs/migration/_migrate_calctables_to_lakehouse.py,sha256=ajFvHauFdEsbgxvn9JXj2kiXaRtJLEjwX4hWQG7FQy0,20609
-sempy_labs/migration/_migrate_calctables_to_semantic_model.py,sha256=Co2f579vSwkWZ95SlBStS-XJ73YwgcdfAMlJbUv_pkk,6343
-sempy_labs/migration/_migrate_model_objects_to_semantic_model.py,sha256=iCfbyJuharFnHvwviuoRM_caQX8AKmaX47HYafI6Wtg,23955
-sempy_labs/migration/_migrate_tables_columns_to_semantic_model.py,sha256=qohJC6ARjM8NiMH7nZEKqUEXMrh-IqhdeUzgrBNZ1DQ,7028
-sempy_labs/migration/_migration_validation.py,sha256=IdSNuK2EVz-egX7glvcocvRlWZrnKj5_nOz-l20yZdk,2370
-sempy_labs/migration/_refresh_calc_tables.py,sha256=MjtBBoDA8W6J-6HPD736Voocp5AK2E1glXCy79C57ts,5985
-sempy_labs/report/__init__.py,sha256=fkjbkAXZuH7VnAn-k3iB4dngWZKaX-k0bxS6mBa9iAs,846
-sempy_labs/report/_generate_report.py,sha256=D1u_XzbvgYzUO4NXU5k9huMNh0n7bEjreW4SSoaa2vE,8532
-sempy_labs/report/_report_functions.py,sha256=Ctx9kCTOC40ibBvkzGt2DAZG9GNa_iE8_T4ruERsk7A,30016
-sempy_labs/report/_report_rebind.py,sha256=sWaj6aw8sh0njZ0__ULeGD4CZrg7oPLKtOlv4ETKGOk,4635
-sempy_labs/tom/__init__.py,sha256=hFwkmWk5AZ7GK1LWqoqaK1g4gDmu9mZMkfLQvLsR_eE,130
-sempy_labs/tom/_model.py,sha256=hRnIL1rkdYBTFt3hg2zcsEmvsoMhUCAeepmFyzyfzhA,135257
-semantic_link_labs-0.4.2.dist-info/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-semantic_link_labs-0.4.2.dist-info/METADATA,sha256=d4DjYbKoZum30lR9bqhV-X1CHR5DZCfsdnay1UOz-w4,764
-semantic_link_labs-0.4.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-semantic_link_labs-0.4.2.dist-info/top_level.txt,sha256=kiQX1y42Dbein1l3Q8jMUYyRulDjdlc2tMepvtrvixQ,11
-semantic_link_labs-0.4.2.dist-info/RECORD,,