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

sempy_labs/_clear_cache.py

@@ -1,7 +1,6 @@
-import sempy
 import sempy.fabric as fabric
-from ._helper_functions import resolve_dataset_id
-from typing import List, Optional, Union
+from ._helper_functions import resolve_dataset_id, is_default_semantic_model
+from typing import Optional
 import sempy_labs._icons as icons
 
 
@@ -21,14 +20,19 @@ def clear_cache(dataset: str, workspace: Optional[str] = None):
     """
 
     workspace = fabric.resolve_workspace_name(workspace)
+    if is_default_semantic_model(dataset=dataset, workspace=workspace):
+        raise ValueError(
+            f"{icons.red_dot} Cannot run XMLA operations against a default semantic model. Please choose a different semantic model. "
+            "See here for more information: https://learn.microsoft.com/fabric/data-warehouse/semantic-models"
+        )
 
-    datasetID = resolve_dataset_id(dataset=dataset, workspace=workspace)
+    dataset_id = resolve_dataset_id(dataset=dataset, workspace=workspace)
 
     xmla = f"""
-            <ClearCache xmlns="http://schemas.microsoft.com/analysisservices/2003/engine">  
-                <Object>  
-                    <DatabaseID>{datasetID}</DatabaseID>  
-                </Object>  
+            <ClearCache xmlns="http://schemas.microsoft.com/analysisservices/2003/engine">
+                <Object>
+                    <DatabaseID>{dataset_id}</DatabaseID>
+                </Object>
             </ClearCache>
             """
     fabric.execute_xmla(dataset=dataset, xmla_command=xmla, workspace=workspace)

sempy_labs/_connections.py

@@ -1,8 +1,6 @@
-import sempy
 import sempy.fabric as fabric
 import pandas as pd
-from typing import List, Optional, Union
-import sempy_labs._icons as icons
+from sempy.fabric.exceptions import FabricHTTPException
 
 
 def create_connection_cloud(
@@ -56,29 +54,32 @@ def create_connection_cloud(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    return df
 
 
 def create_connection_on_prem(
@@ -131,30 +132,33 @@ def create_connection_on_prem(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Gateway ID": o.get("gatewayId"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Gateway ID": o.get("gatewayId"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
 
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    return df
 
 
 def create_connection_vnet(
@@ -209,27 +213,30 @@ def create_connection_vnet(
         },
     }
 
-    response = client.post(f"/v1/connections", json=request_body)
-
-    if response.status_code == 200:
-        o = response.json()
-        new_data = {
-            "Connection Id": o.get("id"),
-            "Connection Name": o.get("name"),
-            "Gateway ID": o.get("gatewayId"),
-            "Connectivity Type": o.get("connectivityType"),
-            "Connection Type": o.get("connectionDetails",{}).get("type"),
-            "Connection Path": o.get("connectionDetails",{}).get("path"),
-            "Privacy Level": o.get("privacyLevel"),
-            "Credential Type": o.get("credentialDetails",{}).get("credentialType"),
-            "Single Sign On Type": o.get("credentialDetails",{}).get("singleSignOnType"),
-            "Connection Encryption": o.get("credentialDetails",{}).get("connectionEncryption"),
-            "Skip Test Connection": o.get("credentialDetails",{}).get("skipTestConnection"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-        df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
-
-        return df
-    else:
-        print(f"{icons.red_dot} {response.status_code}")
+    response = client.post("/v1/connections", json=request_body)
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    o = response.json()
+    new_data = {
+        "Connection Id": o.get("id"),
+        "Connection Name": o.get("name"),
+        "Gateway ID": o.get("gatewayId"),
+        "Connectivity Type": o.get("connectivityType"),
+        "Connection Type": o.get("connectionDetails", {}).get("type"),
+        "Connection Path": o.get("connectionDetails", {}).get("path"),
+        "Privacy Level": o.get("privacyLevel"),
+        "Credential Type": o.get("credentialDetails", {}).get("credentialType"),
+        "Single Sign On Type": o.get("credentialDetails", {}).get("singleSignOnType"),
+        "Connection Encryption": o.get("credentialDetails", {}).get(
+            "connectionEncryption"
+        ),
+        "Skip Test Connection": o.get("credentialDetails", {}).get(
+            "skipTestConnection"
+        ),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    df["Skip Test Connection"] = df["Skip Test Connection"].astype(bool)
+
+    return df

sempy_labs/_dax.py

@@ -1,8 +1,10 @@
-import sempy
 import sempy.fabric as fabric
 import pandas as pd
-from sempy_labs._helper_functions import resolve_dataset_id
-from typing import List, Optional, Union
+from sempy_labs._helper_functions import (
+    resolve_dataset_id,
+    resolve_workspace_name_and_id,
+)
+from typing import Optional
 from sempy._utils._log import log
 
 
@@ -40,17 +42,13 @@ def evaluate_dax_impersonation(
 
     # https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/execute-queries-in-group
 
-    if workspace is None:
-        workspace_id = fabric.get_workspace_id()
-        workspace = fabric.resolve_workspace_name(workspace_id)
-    else:
-        workspace_id = fabric.resolve_workspace_id(workspace)
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     dataset_id = resolve_dataset_id(dataset=dataset, workspace=workspace)
 
     request_body = {
         "queries": [{"query": dax_query}],
-        "impersonatedUserName": user_name
+        "impersonatedUserName": user_name,
     }
 
     client = fabric.PowerBIRestClient()

sempy_labs/_generate_semantic_model.py

@@ -1,11 +1,15 @@
-import sempy
 import sempy.fabric as fabric
 import pandas as pd
-import json, base64, time, os
-from typing import List, Optional, Union
+import json
+import os
+from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_lakehouse_name,
     resolve_workspace_name_and_id,
+    resolve_dataset_id,
+    _conv_b64,
+    _decode_b64,
+    lro,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
@@ -31,13 +35,14 @@ def create_blank_semantic_model(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    if workspace is None:
-        workspace = fabric.resolve_workspace_name()
+    workspace = fabric.resolve_workspace_name(workspace)
 
     min_compat = 1500
 
     if compatibility_level < min_compat:
-        raise ValueError(f"{icons.red_dot} Compatiblity level must be at least {min_compat}.")
+        raise ValueError(
+            f"{icons.red_dot} Compatiblity level must be at least {min_compat}."
+        )
 
     tmsl = f"""
   {{
@@ -84,30 +89,22 @@ def create_semantic_model_from_bim(
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    objectType = "SemanticModel"
-
-    dfI = fabric.list_items(workspace=workspace, type=objectType)
+    dfI = fabric.list_items(workspace=workspace, type="SemanticModel")
     dfI_filt = dfI[(dfI["Display Name"] == dataset)]
 
     if len(dfI_filt) > 0:
-        raise ValueError(f"{icons.red_dot} '{dataset}' already exists as a semantic model in the '{workspace}' workspace.")
+        raise ValueError(
+            f"{icons.red_dot} '{dataset}' already exists as a semantic model in the '{workspace}' workspace."
+        )
 
     client = fabric.FabricRestClient()
     defPBIDataset = {"version": "1.0", "settings": {}}
 
-    def conv_b64(file):
-
-        loadJson = json.dumps(file)
-        f = base64.b64encode(loadJson.encode("utf-8")).decode("utf-8")
-
-        return f
-
-    payloadPBIDefinition = conv_b64(defPBIDataset)
-    payloadBim = conv_b64(bim_file)
+    payloadPBIDefinition = _conv_b64(defPBIDataset)
+    payloadBim = _conv_b64(bim_file)
 
     request_body = {
         "displayName": dataset,
-        "type": objectType,
         "definition": {
             "parts": [
                 {
@@ -124,83 +121,82 @@ def create_semantic_model_from_bim(
         },
     }
 
-    response = client.post(f"/v1/workspaces/{workspace_id}/items", json=request_body)
+    response = client.post(
+        f"/v1/workspaces/{workspace_id}/semanticModels",
+        json=request_body,
+    )
 
-    if response.status_code == 201:
-        print(
-            f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace}' workspace."
-        )
-        print(response.json())
-    elif response.status_code == 202:
-        operationId = response.headers["x-ms-operation-id"]
-        response = client.get(f"/v1/operations/{operationId}")
-        response_body = json.loads(response.content)
-        while response_body["status"] != "Succeeded":
-            time.sleep(3)
-            response = client.get(f"/v1/operations/{operationId}")
-            response_body = json.loads(response.content)
-        response = client.get(f"/v1/operations/{operationId}/result")
-        print(
-            f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace}' workspace."
-        )
-        print(response.json())
+    lro(client, response, status_codes=[201, 202])
+
+    print(
+        f"{icons.green_dot} The '{dataset}' semantic model has been created within the '{workspace}' workspace."
+    )
 
 
 def deploy_semantic_model(
-    dataset: str,
-    new_dataset: Optional[str] = None,
-    workspace: Optional[str] = None,
-    new_dataset_workspace: Optional[str] = None,
+    source_dataset: str,
+    source_workspace: Optional[str] = None,
+    target_dataset: Optional[str] = None,
+    target_workspace: Optional[str] = None,
+    refresh_target_dataset: Optional[bool] = True,
 ):
     """
     Deploys a semantic model based on an existing semantic model.
 
     Parameters
     ----------
-    dataset : str
+    source_dataset : str
         Name of the semantic model to deploy.
-    new_dataset: str
-        Name of the new semantic model to be created.
-    workspace : str, default=None
+    source_workspace : str, default=None
         The Fabric workspace name.
         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, default=None
+    target_dataset: str
+        Name of the new semantic model to be created.
+    target_workspace : str, default=None
         The Fabric workspace name in which the new semantic model will be deployed.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
+    refresh_target_dataset : bool, default=True
+        If set to True, this will initiate a full refresh of the target semantic model in the target workspace.
 
     Returns
     -------
 
     """
 
-    workspace = fabric.resolve_workspace_name(workspace)
+    from sempy_labs import refresh_semantic_model
 
-    if new_dataset_workspace is None:
-        new_dataset_workspace = workspace
+    source_workspace = fabric.resolve_workspace_name(source_workspace)
 
-    if new_dataset is None:
-        new_dataset = dataset
+    if target_workspace is None:
+        target_workspace = source_workspace
 
-    if new_dataset == dataset and new_dataset_workspace == workspace:
-        print(
-            f"The 'dataset' and 'new_dataset' parameters have the same value. And, the 'workspace' and 'new_dataset_workspace' parameters have the same value. At least one of these must be different. Please update the parameters."
+    if target_dataset is None:
+        target_dataset = source_dataset
+
+    if target_dataset == source_dataset and target_workspace == source_workspace:
+        raise ValueError(
+            f"{icons.red_dot} The 'dataset' and 'new_dataset' parameters have the same value. And, the 'workspace' and 'new_dataset_workspace' "
+            f"parameters have the same value. At least one of these must be different. Please update the parameters."
         )
-        return
 
-    bim = get_semantic_model_bim(dataset=dataset, workspace=workspace)
+    bim = get_semantic_model_bim(dataset=source_dataset, workspace=source_workspace)
 
     create_semantic_model_from_bim(
-        dataset=new_dataset, bim_file=bim, workspace=new_dataset_workspace
+        dataset=target_dataset, bim_file=bim, workspace=target_workspace
     )
 
+    if refresh_target_dataset:
+        refresh_semantic_model(dataset=target_dataset, workspace=target_workspace)
+
 
 def get_semantic_model_bim(
     dataset: str,
     workspace: Optional[str] = None,
     save_to_file_name: Optional[str] = None,
-):
+    lakehouse_workspace: Optional[str] = None,
+) -> dict:
     """
     Extracts the Model.bim file for a given semantic model.
 
@@ -209,66 +205,55 @@ def get_semantic_model_bim(
     dataset : str
         Name of the semantic model.
     workspace : str, default=None
-        The Fabric workspace name.
+        The Fabric workspace name in which the semantic model resides.
         Defaults to None which resolves to the workspace of the attached lakehouse
         or if no lakehouse attached, resolves to the workspace of the notebook.
     save_to_file_name : str, default=None
         If specified, saves the Model.bim as a file in the lakehouse attached to the notebook.
+    lakehouse_workspace : str, default=None
+        The Fabric workspace name in which the lakehouse attached to the workspace resides.
+        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
     -------
-    str
+    dict
         The Model.bim file for the semantic model.
     """
 
     (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    objType = "SemanticModel"
+    fmt = "TMSL"
     client = fabric.FabricRestClient()
-    itemList = fabric.list_items(workspace=workspace, type=objType)
-    itemListFilt = itemList[(itemList["Display Name"] == dataset)]
-    itemId = itemListFilt["Id"].iloc[0]
+    dataset_id = resolve_dataset_id(dataset=dataset, workspace=workspace)
     response = client.post(
-        f"/v1/workspaces/{workspace_id}/items/{itemId}/getDefinition"
+        f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/getDefinition?format={fmt}",
     )
-
-    if response.status_code == 200:
-        res = response.json()
-    elif response.status_code == 202:
-        operationId = response.headers["x-ms-operation-id"]
-        response = client.get(f"/v1/operations/{operationId}")
-        response_body = json.loads(response.content)
-        while response_body["status"] != "Succeeded":
-            time.sleep(3)
-            response = client.get(f"/v1/operations/{operationId}")
-            response_body = json.loads(response.content)
-        response = client.get(f"/v1/operations/{operationId}/result")
-        res = response.json()
-    df_items = pd.json_normalize(res["definition"]["parts"])
+    result = lro(client, response).json()
+    df_items = pd.json_normalize(result["definition"]["parts"])
     df_items_filt = df_items[df_items["path"] == "model.bim"]
     payload = df_items_filt["payload"].iloc[0]
-    bimFile = base64.b64decode(payload).decode("utf-8")
+    bimFile = _decode_b64(payload)
     bimJson = json.loads(bimFile)
 
     if save_to_file_name is not None:
-        lakeAttach = lakehouse_attached()
-        if lakeAttach is False:
-            print(
-                f"In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
+        if not lakehouse_attached():
+            raise ValueError(
+                f"{icons.red_dot} In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
             )
-            return
 
         lakehouse_id = fabric.get_lakehouse_id()
-        lakehouse = resolve_lakehouse_name(lakehouse_id, workspace)
+        lake_workspace = fabric.resolve_workspace_name()
+        lakehouse = resolve_lakehouse_name(lakehouse_id, lake_workspace)
         folderPath = "/lakehouse/default/Files"
         fileExt = ".bim"
         if not save_to_file_name.endswith(fileExt):
-            save_to_file_name = save_to_file_name + fileExt
+            save_to_file_name = f"{save_to_file_name}{fileExt}"
         filePath = os.path.join(folderPath, save_to_file_name)
         with open(filePath, "w") as json_file:
             json.dump(bimJson, json_file, indent=4)
         print(
-            f"The .bim file for the '{dataset}' semantic model has been saved to the '{lakehouse}' in this location: '{filePath}'.\n\n"
+            f"{icons.green_dot} The .bim file for the '{dataset}' semantic model has been saved to the '{lakehouse}' in this location: '{filePath}'.\n\n"
         )
 
     return bimJson