semantic-link-labs 0.11.2__py3-none-any.whl → 0.12.0__py3-none-any.whl

sempy_labs/lakehouse/_materialized_lake_views.py

@@ -0,0 +1,76 @@
+from typing import Optional
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+    resolve_lakehouse_name_and_id,
+    _base_api,
+)
+from uuid import UUID
+from sempy._utils._log import log
+import sempy_labs._icons as icons
+import time
+from sempy_labs._job_scheduler import (
+    _get_item_job_instance,
+)
+import pandas as pd
+
+
+@log
+def refresh_materialized_lake_views(
+    lakehouse: Optional[str | UUID] = None, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Run on-demand Refresh MaterializedLakeViews job instance.
+
+    This is a wrapper function for the following API: `Background Jobs - Run On Demand Refresh Materialized Lake Views <https://learn.microsoft.com/rest/api/fabric/lakehouse/background-jobs/run-on-demand-refresh-materialized-lake-views>`_.
+
+    Parameters
+    ----------
+    lakehouse : str | uuid.UUID, default=None
+        The Fabric lakehouse name or ID.
+        Defaults to None which resolves to the lakehouse attached to the notebook.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID used by the lakehouse.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A DataFrame containing the job instance details of the refresh materialized lake views operation.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
+        lakehouse=lakehouse, workspace=workspace_id
+    )
+
+    response = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/lakehouses/{lakehouse_id}/jobs/instances?jobType=RefreshMaterializedLakeViews",
+        method="post",
+        status_codes=[202],
+    )
+
+    print(
+        f"{icons.in_progress} The refresh materialized lake views job for the '{lakehouse_name}' lakehouse within the '{workspace_name}' workspace has been initiated."
+    )
+
+    status_url = response.headers.get("Location").split("fabric.microsoft.com")[1]
+    status = None
+    while status not in ["Completed", "Failed"]:
+        response = _base_api(request=status_url)
+        status = response.json().get("status")
+        time.sleep(3)
+
+    df = _get_item_job_instance(url=status_url)
+
+    if status == "Completed":
+        print(
+            f"{icons.green_dot} The refresh materialized lake views job for the '{lakehouse_name}' lakehouse within the '{workspace_name}' workspace has succeeded."
+        )
+    else:
+        print(status)
+        print(
+            f"{icons.red_dot} The refresh materialized lake views job for the '{lakehouse_name}' lakehouse within the '{workspace_name}' workspace has failed."
+        )
+
+    return df

sempy_labs/lakehouse/_shortcuts.py

@@ -2,6 +2,7 @@ import sempy.fabric as fabric
 import pandas as pd
 from .._helper_functions import (
     resolve_lakehouse_name_and_id,
+    resolve_workspace_id,
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
@@ -268,6 +269,8 @@ def reset_shortcut_cache(workspace: Optional[str | UUID] = None):
 
     This is a wrapper function for the following API: `OneLake Shortcuts - Reset Shortcut Cache <https://learn.microsoft.com/rest/api/fabric/core/onelake-shortcuts/reset-shortcut-cache>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     workspace : str | uuid.UUID, default=None
@@ -281,6 +284,7 @@ def reset_shortcut_cache(workspace: Optional[str | UUID] = None):
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/onelake/resetShortcutCache",
         method="post",
+        client="fabric_sp",
         lro_return_status_code=True,
         status_codes=None,
     )
@@ -318,7 +322,7 @@ def list_shortcuts(
         A pandas dataframe showing all the shortcuts which exist in the specified lakehouse.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
     (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
         lakehouse=lakehouse, workspace=workspace_id
     )
@@ -383,7 +387,9 @@ def list_shortcuts(
             source_item_id = tgt.get(sources.get(tgt_type), {}).get("itemId")
             bucket = tgt.get(sources.get(tgt_type), {}).get("bucket")
             source_workspace_name = (
-                resolve_workspace_name(workspace_id=source_workspace_id)
+                resolve_workspace_name(
+                    workspace_id=source_workspace_id, throw_error=False
+                )
                 if source_workspace_id is not None
                 else None
             )

sempy_labs/migration/_migrate_calctables_to_lakehouse.py

@@ -2,28 +2,29 @@ import sempy
 import sempy.fabric as fabric
 import pandas as pd
 import re
-from ..lakehouse._get_lakehouse_tables import get_lakehouse_tables
-from .._helper_functions import (
-    resolve_lakehouse_name,
-    resolve_lakehouse_id,
+from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
+from sempy_labs._helper_functions import (
     retry,
     generate_guid,
     save_as_delta_table,
+    resolve_lakehouse_name_and_id,
+    resolve_workspace_name_and_id,
 )
-from ..tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from uuid import UUID
 
 
 @log
 def migrate_calc_tables_to_lakehouse(
     dataset: str,
     new_dataset: str,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
-    lakehouse: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    new_dataset_workspace: Optional[str | UUID] = None,
+    lakehouse: Optional[str | UUID] = None,
+    lakehouse_workspace: Optional[str | UUID] = None,
 ):
     """
     Creates delta tables in your lakehouse based on the DAX expression of a calculated table in an import/DirectQuery semantic model.
@@ -35,18 +36,18 @@ def migrate_calc_tables_to_lakehouse(
         Name of the import/DirectQuery semantic model.
     new_dataset : str
         Name of the Direct Lake semantic model.
-    workspace : str, default=None
+    workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the import/DirectQuery semantic model exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    new_dataset_workspace : str
+    new_dataset_workspace : str | uuid.UUID
         The Fabric workspace name in which the Direct Lake semantic model will be created.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    lakehouse : str, default=None
+    lakehouse : str | uuid.UUID, default=None
         The Fabric lakehouse used by the Direct Lake semantic model.
         Defaults to None which resolves to the lakehouse attached to the notebook.
-    lakehouse_workspace : str, default=None
+    lakehouse_workspace : str | uuid.UUID, default=None
         The Fabric workspace used by the lakehouse.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
@@ -57,22 +58,16 @@ def migrate_calc_tables_to_lakehouse(
             f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
         )
 
-    workspace = fabric.resolve_workspace_name(workspace)
-
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
-
-    if lakehouse_workspace is None:
-        lakehouse_workspace = new_dataset_workspace
-        lakehouse_workspace_id = fabric.resolve_workspace_id(lakehouse_workspace)
-    else:
-        lakehouse_workspace_id = fabric.resolve_workspace_id(lakehouse_workspace)
-
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
-    else:
-        lakehouse_id = resolve_lakehouse_id(lakehouse, lakehouse_workspace)
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (new_dataset_workspace_name, new_dataset_workspace_id) = (
+        resolve_workspace_name_and_id(new_dataset_workspace)
+    )
+    (lakehouse_workspace_id, lakehouse_workspace_name) = resolve_workspace_name_and_id(
+        lakehouse_workspace
+    )
+    (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
+        lakehouse, lakehouse_workspace
+    )
 
     dfP = fabric.list_partitions(dataset=dataset, workspace=workspace)
     dfP_filt = dfP[(dfP["Source Type"] == "Calculated")]
@@ -90,7 +85,7 @@ def migrate_calc_tables_to_lakehouse(
 
         if dtName in lakeTables["Table Name"].values:
             print(
-                f"{icons.red_dot} The '{tName}' table already exists as '{dtName}' in the '{lakehouse}' lakehouse in the '{workspace}' workspace."
+                f"{icons.red_dot} The '{tName}' table already exists as '{dtName}' in the '{lakehouse_name}' lakehouse in the '{lakehouse_workspace_name}' workspace."
             )
             killFunction = True
 
@@ -99,7 +94,7 @@ def migrate_calc_tables_to_lakehouse(
 
     if len(dfP_filt) == 0:
         print(
-            f"{icons.yellow_dot} The '{dataset}' semantic model in the '{workspace}' workspace has no calculated tables."
+            f"{icons.yellow_dot} The '{dataset}' semantic model in the '{workspace_name}' workspace has no calculated tables."
         )
         return
 
@@ -175,7 +170,6 @@ def migrate_calc_tables_to_lakehouse(
                                             if str(c.Type) == "Calculated"
                                             and c.Name == new_column_name
                                         )
-
                                     if dataType == "Int64":
                                         df[new_column_name] = df[
                                             new_column_name
@@ -197,7 +191,7 @@ def migrate_calc_tables_to_lakehouse(
 
                                 save_as_delta_table(
                                     dataframe=df,
-                                    table_name=delta_table_name,
+                                    delta_table_name=delta_table_name,
                                     lakehouse=lakehouse,
                                     workspace=lakehouse_workspace,
                                     write_mode="overwrite",
@@ -231,20 +225,21 @@ def migrate_calc_tables_to_lakehouse(
 
                                 print(
                                     f"{icons.green_dot} Calculated table '{t.Name}' has been created as delta table '{delta_table_name.lower()}' "
-                                    f"in the '{lakehouse}' lakehouse within the '{lakehouse_workspace}' workspace."
+                                    f"in the '{lakehouse_name}' lakehouse within the '{lakehouse_workspace_name}' workspace."
                                 )
-                            except Exception:
+                            except Exception as e:
                                 print(
                                     f"{icons.red_dot} Failed to create calculated table '{t.Name}' as a delta table in the lakehouse."
                                 )
+                                print(e)
 
 
 @log
 def migrate_field_parameters(
     dataset: str,
     new_dataset: str,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    new_dataset_workspace: Optional[str | UUID] = None,
 ):
     """
     Migrates field parameters from one semantic model to another.
@@ -255,11 +250,11 @@ def migrate_field_parameters(
         Name of the import/DirectQuery semantic model.
     new_dataset : str
         Name of the Direct Lake semantic model.
-    workspace : str, default=None
+    workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the import/DirectQuery semantic model exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    new_dataset_workspace : str
+    new_dataset_workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the Direct Lake semantic model will be created.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
@@ -270,15 +265,11 @@ def migrate_field_parameters(
     sempy.fabric._client._utils._init_analysis_services()
     import Microsoft.AnalysisServices.Tabular as TOM
 
-    if workspace is None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
-
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
-
     icons.sll_tags.append("DirectLakeMigration")
     fabric.refresh_tom_cache(workspace=workspace)
+    (new_dataset_workspace_name, new_dataset_workspace_id) = (
+        resolve_workspace_name_and_id(new_dataset_workspace)
+    )
 
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     dfC["Column Object"] = format_dax_object_name(dfC["Table Name"], dfC["Column Name"])
@@ -399,7 +390,7 @@ def migrate_field_parameters(
                 tom.model.Tables[tName].Columns["Value3"].Name = col3
 
                 print(
-                    f"{icons.green_dot} The '{tName}' table has been added as a field parameter to the '{new_dataset}' semantic model in the '{new_dataset_workspace}' workspace."
+                    f"{icons.green_dot} The '{tName}' table has been added as a field parameter to the '{new_dataset}' semantic model in the '{new_dataset_workspace_name}' workspace."
                 )
             except Exception:
                 print(

sempy_labs/migration/_migrate_calctables_to_semantic_model.py

@@ -1,25 +1,25 @@
 import sempy.fabric as fabric
 import re
-from ..lakehouse._get_lakehouse_tables import get_lakehouse_tables
-from .._helper_functions import (
-    resolve_lakehouse_name,
+from sempy_labs.lakehouse._get_lakehouse_tables import get_lakehouse_tables
+from sempy_labs._helper_functions import (
     format_dax_object_name,
     retry,
 )
-from ..tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from uuid import UUID
 
 
 @log
 def migrate_calc_tables_to_semantic_model(
     dataset: str,
     new_dataset: str,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
-    lakehouse: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    new_dataset_workspace: Optional[str | UUID] = None,
+    lakehouse: Optional[str | UUID] = None,
+    lakehouse_workspace: Optional[str | UUID] = None,
 ):
     """
     Creates new tables in the Direct Lake semantic model based on the lakehouse tables created using the 'migrate_calc_tables_to_lakehouse' function.
@@ -30,18 +30,18 @@ def migrate_calc_tables_to_semantic_model(
         Name of the import/DirectQuery semantic model.
     new_dataset : str
         Name of the Direct Lake semantic model.
-    workspace : str, default=None
+    workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the import/DirectQuery semantic model exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    new_dataset_workspace : str
+    new_dataset_workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the Direct Lake semantic model will be created.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    lakehouse : str, default=None
+    lakehouse : str | uuid.UUID, default=None
         The Fabric lakehouse used by the Direct Lake semantic model.
         Defaults to None which resolves to the lakehouse attached to the notebook.
-    lakehouse_workspace : str, default=None
+    lakehouse_workspace : str | uuid.UUID, default=None
         The Fabric workspace used by the lakehouse.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
@@ -52,18 +52,8 @@ def migrate_calc_tables_to_semantic_model(
             f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
         )
 
-    workspace = fabric.resolve_workspace_name(workspace)
     fabric.refresh_tom_cache(workspace=workspace)
 
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
-
-    if lakehouse_workspace is None:
-        lakehouse_workspace = new_dataset_workspace
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
-
     icons.sll_tags.append("DirectLakeMigration")
 
     # Get calc tables but not field parameters

sempy_labs/migration/_migrate_model_objects_to_semantic_model.py

@@ -1,23 +1,24 @@
 import sempy
 import sempy.fabric as fabric
 import re
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     create_relationship_name,
     retry,
     format_dax_object_name,
 )
-from ..tom import connect_semantic_model
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from uuid import UUID
 
 
 @log
 def migrate_model_objects_to_semantic_model(
     dataset: str,
     new_dataset: str,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    new_dataset_workspace: Optional[str | UUID] = None,
 ):
     """
     Adds the rest of the model objects (besides tables/columns) and their properties to a Direct Lake semantic model based on an import/DirectQuery semantic model.
@@ -28,11 +29,11 @@ def migrate_model_objects_to_semantic_model(
         Name of the import/DirectQuery semantic model.
     new_dataset : str
         Name of the Direct Lake semantic model.
-    workspace : str, default=None
+    workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the import/DirectQuery semantic model exists.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
-    new_dataset_workspace : str
+    new_dataset_workspace : str | uuid.UUID, default=None
         The Fabric workspace name in which the Direct Lake semantic model will be created.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
@@ -47,12 +48,7 @@ def migrate_model_objects_to_semantic_model(
             f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
         )
 
-    workspace = fabric.resolve_workspace_name(workspace)
     fabric.refresh_tom_cache(workspace=workspace)
-
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
-
     icons.sll_tags.append("DirectLakeMigration")
 
     dfT = fabric.list_tables(dataset=dataset, workspace=workspace)

sempy_labs/migration/_migrate_tables_columns_to_semantic_model.py

@@ -1,22 +1,23 @@
 import sempy.fabric as fabric
 import pandas as pd
-from ..directlake._generate_shared_expression import generate_shared_expression
-from .._helper_functions import resolve_lakehouse_name, retry
-from ..lakehouse._lakehouse import lakehouse_attached
-from ..tom import connect_semantic_model
+from sempy_labs.directlake._generate_shared_expression import generate_shared_expression
+from sempy_labs._helper_functions import retry
+from sempy_labs.lakehouse._lakehouse import lakehouse_attached
+from sempy_labs.tom import connect_semantic_model
 from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
+from uuid import UUID
 
 
 @log
 def migrate_tables_columns_to_semantic_model(
     dataset: str,
     new_dataset: str,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
-    lakehouse: Optional[str] = None,
-    lakehouse_workspace: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    new_dataset_workspace: Optional[str | UUID] = None,
+    lakehouse: Optional[str | UUID] = None,
+    lakehouse_workspace: Optional[str | UUID] = None,
 ):
     """
     Adds tables/columns to the new Direct Lake semantic model based on an import/DirectQuery semantic model.
@@ -49,18 +50,6 @@ def migrate_tables_columns_to_semantic_model(
             f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters are both set to '{dataset}'. These parameters must be set to different values."
         )
 
-    workspace = fabric.resolve_workspace_name(workspace)
-
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
-
-    if lakehouse_workspace is None:
-        lakehouse_workspace = new_dataset_workspace
-
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, lakehouse_workspace)
-
     icons.sll_tags.append("DirectLakeMigration")
 
     # Check that lakehouse is attached to the notebook
@@ -72,11 +61,13 @@ def migrate_tables_columns_to_semantic_model(
             "\nLearn more here: https://learn.microsoft.com/fabric/data-engineering/lakehouse-notebook-explore#add-or-remove-a-lakehouse"
         )
     shEx = generate_shared_expression(
-        item_name=lakehouse, item_type="Lakehouse", workspace=lakehouse_workspace
+        item_name=lakehouse,
+        item_type="Lakehouse",
+        workspace=lakehouse_workspace,
+        use_sql_endpoint=False,
     )
 
     fabric.refresh_tom_cache(workspace=workspace)
-
     dfC = fabric.list_columns(dataset=dataset, workspace=workspace)
     dfT = fabric.list_tables(dataset=dataset, workspace=workspace)
     dfT.rename(columns={"Type": "Table Type"}, inplace=True)
@@ -136,7 +127,7 @@ def migrate_tables_columns_to_semantic_model(
             tDC = r["Data Category"]
             tHid = bool(r["Hidden"])
             tDesc = r["Description"]
-            ent_name = tName.replace(" ", "_")
+            ent_name = tName  # .replace(" ", "_")
             for char in icons.special_characters:
                 ent_name = ent_name.replace(char, "")
 

sempy_labs/ml_model/__init__.py

@@ -0,0 +1,23 @@
+from ._functions import (
+    list_ml_models,
+    create_ml_model,
+    delete_ml_model,
+    activate_ml_model_endpoint_version,
+    deactivate_all_ml_model_endpoint_versions,
+    deactivate_ml_model_endpoint_version,
+    list_ml_model_endpoint_versions,
+    score_ml_model_endpoint,
+    score_ml_model_endpoint_version,
+)
+
+__all__ = [
+    "list_ml_models",
+    "create_ml_model",
+    "delete_ml_model",
+    "activate_ml_model_endpoint_version",
+    "deactivate_all_ml_model_endpoint_versions",
+    "deactivate_ml_model_endpoint_version",
+    "list_ml_model_endpoint_versions",
+    "score_ml_model_endpoint",
+    "score_ml_model_endpoint_version",
+]