semantic-link-labs 0.9.4__py3-none-any.whl → 0.9.5__py3-none-any.whl

sempy_labs/_list_functions.py

@@ -2,8 +2,6 @@ import sempy.fabric as fabric
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     create_relationship_name,
-    resolve_lakehouse_id,
-    resolve_item_type,
     format_dax_object_name,
     resolve_dataset_name_and_id,
     _update_dataframe_datatypes,
@@ -534,7 +532,6 @@ def list_columns(
     from sempy_labs.directlake._get_directlake_lakehouse import (
         get_direct_lake_lakehouse,
     )
-    from pyspark.sql import SparkSession
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
@@ -604,57 +601,6 @@ def list_columns(
     return dfC
 
 
-def list_dashboards(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
-    """
-    Shows a list of the dashboards within a workspace.
-
-    Parameters
-    ----------
-    workspace : str | uuid.UUID, default=None
-        The Fabric workspace name or ID.
-        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 pandas dataframe showing the dashboards within a workspace.
-    """
-
-    columns = {
-        "Dashboard ID": "string",
-        "Dashboard Name": "string",
-        "Read Only": "bool",
-        "Web URL": "string",
-        "Embed URL": "string",
-        "Data Classification": "string",
-        "Users": "string",
-        "Subscriptions": "string",
-    }
-    df = _create_dataframe(columns=columns)
-
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    response = _base_api(request=f"/v1.0/myorg/groups/{workspace_id}/dashboards")
-
-    for v in response.json().get("value", []):
-        new_data = {
-            "Dashboard ID": v.get("id"),
-            "Dashboard Name": v.get("displayName"),
-            "Read Only": v.get("isReadOnly"),
-            "Web URL": v.get("webUrl"),
-            "Embed URL": v.get("embedUrl"),
-            "Data Classification": v.get("dataClassification"),
-            "Users": v.get("users"),
-            "Subscriptions": v.get("subscriptions"),
-        }
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    _update_dataframe_datatypes(dataframe=df, column_map=columns)
-
-    return df
-
-
 def list_lakehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
     Shows the lakehouses within a workspace.
@@ -1189,11 +1135,15 @@ def list_semantic_model_objects(
 
 
 def list_shortcuts(
-    lakehouse: Optional[str] = None, workspace: Optional[str | UUID] = None
+    lakehouse: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
+    path: Optional[str] = None,
 ) -> pd.DataFrame:
     """
     Shows all shortcuts which exist in a Fabric lakehouse and their properties.
 
+    *** NOTE: This function has been moved to the lakehouse subpackage. Please repoint your code to use that location. ***
+
     Parameters
     ----------
     lakehouse : str, default=None
@@ -1203,6 +1153,9 @@ def list_shortcuts(
         The name or ID of the Fabric workspace in which lakehouse 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.
+    path: str, default=None
+        The path within lakehouse where to look for shortcuts. If provied, must start with either "Files" or "Tables". Examples: Tables/FolderName/SubFolderName; Files/FolderName/SubFolderName.
+        Defaults to None which will retun all shortcuts on the given lakehouse
 
     Returns
     -------
@@ -1210,109 +1163,13 @@ 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)
-
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-    else:
-        lakehouse_id = resolve_lakehouse_id(lakehouse, workspace_id)
+    from sempy_labs.lakehouse._shortcuts import list_shortcuts
 
-    columns = {
-        "Shortcut Name": "string",
-        "Shortcut Path": "string",
-        "Source Type": "string",
-        "Source Workspace Id": "string",
-        "Source Workspace Name": "string",
-        "Source Item Id": "string",
-        "Source Item Name": "string",
-        "Source Item Type": "string",
-        "OneLake Path": "string",
-        "Connection Id": "string",
-        "Location": "string",
-        "Bucket": "string",
-        "SubPath": "string",
-    }
-    df = _create_dataframe(columns=columns)
-
-    responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/items/{lakehouse_id}/shortcuts",
-        uses_pagination=True,
+    print(
+        f"{icons.warning} This function has been moved to the lakehouse subpackage. Please repoint your code to use that location."
     )
 
-    sources = [
-        "s3Compatible",
-        "googleCloudStorage",
-        "externalDataShare",
-        "amazonS3",
-        "adlsGen2",
-        "dataverse",
-    ]
-    sources_locpath = ["s3Compatible", "googleCloudStorage", "amazonS3", "adlsGen2"]
-
-    for r in responses:
-        for i in r.get("value", []):
-            tgt = i.get("target", {})
-            one_lake = tgt.get("oneLake", {})
-            connection_id = next(
-                (
-                    tgt.get(source, {}).get("connectionId")
-                    for source in sources
-                    if tgt.get(source)
-                ),
-                None,
-            )
-            location = next(
-                (
-                    tgt.get(source, {}).get("location")
-                    for source in sources_locpath
-                    if tgt.get(source)
-                ),
-                None,
-            )
-            sub_path = next(
-                (
-                    tgt.get(source, {}).get("subpath")
-                    for source in sources_locpath
-                    if tgt.get(source)
-                ),
-                None,
-            )
-            source_workspace_id = one_lake.get("workspaceId")
-            source_item_id = one_lake.get("itemId")
-            source_workspace_name = (
-                fabric.resolve_workspace_name(source_workspace_id)
-                if source_workspace_id is not None
-                else None
-            )
-
-            new_data = {
-                "Shortcut Name": i.get("name"),
-                "Shortcut Path": i.get("path"),
-                "Source Type": tgt.get("type"),
-                "Source Workspace Id": source_workspace_id,
-                "Source Workspace Name": source_workspace_name,
-                "Source Item Id": source_item_id,
-                "Source Item Name": (
-                    fabric.resolve_item_name(
-                        source_item_id, workspace=source_workspace_name
-                    )
-                    if source_item_id is not None
-                    else None
-                ),
-                "Source Item Type": (
-                    resolve_item_type(source_item_id, workspace=source_workspace_name)
-                    if source_item_id is not None
-                    else None
-                ),
-                "OneLake Path": one_lake.get("path"),
-                "Connection Id": connection_id,
-                "Location": location,
-                "Bucket": tgt.get("s3Compatible", {}).get("bucket"),
-                "SubPath": sub_path,
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
+    return list_shortcuts(lakehouse=lakehouse, workspace=workspace, path=path)
 
 
 def list_capacities() -> pd.DataFrame:

sempy_labs/_mirrored_databases.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
@@ -6,9 +5,11 @@ from sempy_labs._helper_functions import (
     _decode_b64,
     _update_dataframe_datatypes,
     _base_api,
-    _print_success,
     resolve_item_id,
     _create_dataframe,
+    delete_item,
+    create_item,
+    get_item_definition,
 )
 import sempy_labs._icons as icons
 import base64
@@ -92,21 +93,8 @@ def create_mirrored_database(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases",
-        status_codes=201,
-        method="post",
-        payload=payload,
-    )
-    _print_success(
-        item_name=name, item_type="mirrored database", workspace_name=workspace_name
+    create_item(
+        name=name, description=description, type="MirroredDatabase", workspace=workspace
     )
 
 
@@ -128,15 +116,7 @@ def delete_mirrored_database(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    item_id = resolve_item_id(
-        item=mirrored_database, type="MirroredDatabase", workspace=workspace
-    )
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=mirrored_database,
-        item_type="mirrored database",
-        workspace_name=workspace,
-    )
+    delete_item(item=mirrored_database, type="MirroredDatabase", workspace=workspace)
 
 
 def get_mirroring_status(
@@ -307,7 +287,7 @@ def get_mirrored_database_definition(
     mirrored_database: str | UUID,
     workspace: Optional[str | UUID] = None,
     decode: bool = True,
-) -> str:
+) -> dict:
     """
     Obtains the mirrored database definition.
 
@@ -327,31 +307,17 @@ def get_mirrored_database_definition(
 
     Returns
     -------
-    str
+    dict
         The mirrored database definition.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = resolve_item_id(
-        item=mirrored_database, type="MirroredDatabase", workspace=workspace
+    return get_item_definition(
+        item=mirrored_database,
+        type="MirroredDatabase",
+        workspace=workspace,
+        return_dataframe=False,
+        decode=decode,
     )
-    result = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getDefinition",
-        method="post",
-        status_codes=200,
-        lro_return_json=True,
-    )
-
-    df_items = pd.json_normalize(result["definition"]["parts"])
-    df_items_filt = df_items[df_items["path"] == "mirroredDatabase.json"]
-    payload = df_items_filt["payload"].iloc[0]
-
-    if decode:
-        result = _decode_b64(payload)
-    else:
-        result = payload
-
-    return result
 
 
 def update_mirrored_database_definition(

sempy_labs/_ml_experiments.py

@@ -1,12 +1,11 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
-    resolve_item_id,
+    delete_item,
     _create_dataframe,
+    create_item,
 )
 from uuid import UUID
 
@@ -81,25 +80,8 @@ def create_ml_experiment(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/mlExperiments",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="ML experiment",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="MLExperiment", workspace=workspace
     )
 
 
@@ -119,11 +101,4 @@ def delete_ml_experiment(name: str, workspace: Optional[str | UUID] = None):
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    item_id = resolve_item_id(item=name, type="MLExperiment", workspace=workspace)
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name,
-        item_type="ML Experiment",
-        workspace_name=workspace,
-        action="deleted",
-    )
+    delete_item(item=name, type="MLExperiment", workspace=workspace)

sempy_labs/_ml_models.py

@@ -1,12 +1,11 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    resolve_item_id,
-    _print_success,
+    delete_item,
     _create_dataframe,
+    create_item,
 )
 from uuid import UUID
 
@@ -81,26 +80,7 @@ def create_ml_model(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/mlModels",
-        method="post",
-        status_codes=[201, 202],
-        payload=payload,
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="ML Model",
-        workspace_name=workspace_name,
-        action="created",
-    )
+    create_item(name=name, description=description, type="MLModel", workspace=workspace)
 
 
 def delete_ml_model(name: str | UUID, workspace: Optional[str | UUID] = None):
@@ -119,8 +99,4 @@ def delete_ml_model(name: str | UUID, workspace: Optional[str | UUID] = None):
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    item_id = resolve_item_id(item=name, type="MLModel", workspace=workspace)
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name, item_type="ML Model", workspace_name=workspace, action="deleted"
-    )
+    delete_item(item=name, type="MLModel", workspace=workspace)

sempy_labs/_model_bpa.py

@@ -43,6 +43,8 @@ def run_model_bpa(
     """
     Displays an HTML visualization of the results of the Best Practice Analyzer scan for a semantic model.
 
+    The Best Practice Analyzer rules are based on the rules defined `here <https://github.com/microsoft/Analysis-Services/tree/master/BestPracticeRules>`_. The framework for the Best Practice Analyzer and rules are based on the foundation set by `Tabular Editor <https://github.com/TabularEditor/TabularEditor>`_.
+
     Parameters
     ----------
     dataset : str | uuid.UUID

sempy_labs/_mounted_data_factories.py

@@ -0,0 +1,119 @@
+import pandas as pd
+import json
+from typing import Optional
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    resolve_item_id,
+    _decode_b64,
+    delete_item,
+    get_item_definition,
+)
+
+from uuid import UUID
+
+
+def list_mounted_data_factories(
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
+    """
+    Shows a list of mounted data factories from the specified workspace.
+
+    This is a wrapper function for the following API: `Items - List Mounted Data Factories <https://learn.microsoft.com/rest/api/fabric/mounteddatafactory/items/list-mounted-data-factories>`_.
+
+    Parameters
+    ----------
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        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 pandas dataframe showing a list of mounted data factories from the specified workspace.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    columns = {
+        "Mounted Data Factory Name": "str",
+        "Mounted Data Factory Id": "str",
+        "Description": "str",
+    }
+
+    df = _create_dataframe(columns=columns)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mountedDataFactories",
+        uses_pagination=True,
+    )
+
+    for r in responses:
+        for v in r.get("value", []):
+            new_data = {
+                "Mounted Data Factory Name": v.get("displayName"),
+                "Mounted Data Factory Id": v.get("id"),
+                "Description": v.get("description"),
+            }
+
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+def get_mounted_data_factory_definition(
+    mounted_data_factory: str | UUID, workspace: Optional[str | UUID] = None
+) -> dict:
+    """
+    Returns the specified MountedDataFactory public definition.
+
+    This is a wrapper function for the following API: `Items - Get Mounted Data Factory Definition <https://learn.microsoft.com/rest/api/fabric/mounteddatafactory/items/get-mounted-data-factory-definition>`_.
+
+    Parameters
+    ----------
+    mounted_data_factory : str | uuid.UUID
+        The name or ID of the mounted data factory.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        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
+    -------
+    dict
+        The 'mountedDataFactory-content.json' file from the mounted data factory definition.
+    """
+
+    return get_item_definition(
+        item=mounted_data_factory,
+        type="MountedDataFactory",
+        workspace=workspace,
+        return_dataframe=False,
+    )
+
+
+def delete_mounted_data_factory(
+    mounted_data_factory: str | UUID, workspace: Optional[str | UUID]
+):
+    """
+    Deletes the specified mounted data factory.
+
+    This is a wrapper function for the following API: `Items - Delete Mounted Data Factory <https://learn.microsoft.com/rest/api/fabric/mounteddatafactory/items/delete-mounted-data-factory>`_.
+
+    Parameters
+    ----------
+    mounted_data_factory : str | uuid.UUID
+        The name or ID of the mounted data factory.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    delete_item(
+        item=mounted_data_factory, type="MountedDataFactory", workspace=workspace
+    )

sempy_labs/_notebooks.py

@@ -10,6 +10,7 @@ from sempy_labs._helper_functions import (
     _decode_b64,
     _base_api,
     resolve_item_id,
+    create_item,
 )
 from sempy.fabric.exceptions import FabricHTTPException
 import os
@@ -183,35 +184,24 @@ def create_notebook(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     notebook_payload = base64.b64encode(notebook_content).decode("utf-8")
-
-    payload = {
-        "displayName": name,
-        "definition": {
-            "format": "ipynb",
-            "parts": [
-                {
-                    "path": f"{_notebook_prefix}.{type}",
-                    "payload": notebook_payload,
-                    "payloadType": "InlineBase64",
-                }
-            ],
-        },
+    definition_payload = {
+        "format": "ipynb",
+        "parts": [
+            {
+                "path": f"{_notebook_prefix}.{type}",
+                "payload": notebook_payload,
+                "payloadType": "InlineBase64",
+            }
+        ],
     }
-    if description is not None:
-        payload["description"] = description
 
-    _base_api(
-        request=f"v1/workspaces/{workspace_id}/notebooks",
-        payload=payload,
-        method="post",
-        lro_return_status_code=True,
-        status_codes=[201, 202],
-    )
-
-    print(
-        f"{icons.green_dot} The '{name}' notebook was created within the '{workspace_name}' workspace."
+    create_item(
+        name=name,
+        type="Notebook",
+        workspace=workspace,
+        description=description,
+        definition=definition_payload,
     )
 
 

sempy_labs/_sql.py

@@ -45,18 +45,19 @@ class ConnectBase:
         (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
         # Resolve the appropriate ID and name (warehouse or lakehouse)
-        if endpoint_type == "warehouse":
-            (resource_name, resource_id) = resolve_item_name_and_id(
-                item=item, type=endpoint_type.capitalize(), workspace=workspace_id
-            )
         if endpoint_type == "sqldatabase":
             # SQLDatabase is has special case for resolving the name and id
             (resource_name, resource_id) = resolve_item_name_and_id(
                 item=item, type="SQLDatabase", workspace=workspace_id
             )
-        else:
+        elif endpoint_type == "lakehouse":
             (resource_name, resource_id) = resolve_lakehouse_name_and_id(
-                lakehouse=item, workspace=workspace_id
+                lakehouse=item,
+                workspace=workspace_id,
+            )
+        else:
+            (resource_name, resource_id) = resolve_item_name_and_id(
+                item=item, workspace=workspace_id, type=endpoint_type.capitalize()
             )
 
         # Get the TDS endpoint

sempy_labs/_utils.py

@@ -0,0 +1,42 @@
+item_types = {
+    "Dashboard": ["Dashboard", "dashboards"],
+    "DataPipeline": ["Data Pipeline", "dataPipelines", "pipeline-content.json"],
+    "Datamart": ["Datamart", "datamarts"],
+    "Environment": ["Environment", "environments"],
+    "Eventhouse": ["Eventhouse", "eventhouses", "EventhouseProperties.json"],
+    "Eventstream": ["Eventstream", "eventstreams", "eventstream.json"],
+    "GraphQLApi": ["GraphQL Api", "GraphQLApis"],
+    "KQLDashboard": ["KQL Dashboard", "kqlDashboards", "RealTimeDashboard.json"],
+    "KQLDatabase": [
+        "KQL Database",
+        "kqlDatabases",
+    ],  # "DatabaseProperties.json", "DatabaseSchema.kql"
+    "KQLQueryset": ["KQL Queryset", "kqlQuerysets", "RealTimeQueryset.json"],
+    "Lakehouse": ["Lakehouse", "lakehouses"],
+    "MLExperiment": ["ML Experiment", "mlExperiments"],
+    "MLModel": ["ML Model", "mlModels"],
+    "MirroredDatabase": [
+        "Mirrored Database",
+        "mirroredDatabases",
+        "mirroredDatabase.json",
+    ],
+    "MirroredWarehouse": ["Mirrored Warehouse", "mirroredWarehouses"],
+    "MountedDataFactory": [
+        "Mounted Data Factory",
+        "mountedDataFactories",
+        "mountedDataFactory-content.json",
+    ],
+    "Notebook": ["Notebook", "notebooks"],
+    "PaginatedReport": ["Paginated Report", "paginatedReports"],
+    "Reflex": ["Reflex", "reflexes", "ReflexEntities.json"],
+    "Report": ["Report", "reports", "report.json"],
+    "SQLDatabase": ["SQL Database", "sqlDatabases"],
+    "SQLEndpoint": ["SQL Endpoint", "sqlEndpoints"],
+    "SemanticModel": ["Semantic Model", "semanticModels", "model.bim"],
+    "SparkJobDefinition": [
+        "Spark Job Definition",
+        "sparkJobDefinitions",
+        "SparkJobDefinitionV1.json",
+    ],
+    "Warehouse": ["Warehouse", "warehouses"],
+}