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

sempy_labs/_kql_databases.py

@@ -1,13 +1,14 @@
-import sempy.fabric as fabric
 import pandas as pd
-import sempy_labs._icons as icons
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
+    delete_item,
+    create_item,
 )
 from uuid import UUID
+import sempy_labs._icons as icons
 
 
 def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
@@ -16,6 +17,8 @@ def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List KQL Databases <https://learn.microsoft.com/rest/api/fabric/kqldatabase/items/list-kql-databases>`_.
 
+    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
@@ -43,7 +46,9 @@ def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"v1/workspaces/{workspace_id}/kqlDatabases", uses_pagination=True
+        request=f"v1/workspaces/{workspace_id}/kqlDatabases",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -64,7 +69,7 @@ def list_kql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
-def create_kql_database(
+def _create_kql_database(
     name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
 ):
     """
@@ -84,27 +89,16 @@ def create_kql_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}/kqlDatabases",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-
-    print(
-        f"{icons.green_dot} The '{name}' KQL database has been created within the '{workspace_name}' workspace."
+    create_item(
+        name=name, description=description, type="KQLDatabase", workspace=workspace
     )
 
 
-def delete_kql_database(name: str, workspace: Optional[str | UUID] = None):
+def delete_kql_database(
+    kql_database: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    **kwargs,
+):
     """
     Deletes a KQL database.
 
@@ -112,23 +106,18 @@ def delete_kql_database(name: str, workspace: Optional[str | UUID] = None):
 
     Parameters
     ----------
-    name: str
-        Name of the KQL database.
+    kql_database: str | uuid.UUID
+        Name or ID of the KQL database.
     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.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    kql_database_id = fabric.resolve_item_id(
-        item_name=name, type="KQLDatabase", workspace=workspace_id
-    )
+    if "name" in kwargs:
+        kql_database = kwargs["name"]
+        print(
+            f"{icons.warning} The 'name' parameter is deprecated. Please use 'kql_database' instead."
+        )
 
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/kqlDatabases/{kql_database_id}",
-        method="delete",
-    )
-    print(
-        f"{icons.green_dot} The '{name}' KQL database within the '{workspace_name}' workspace has been deleted."
-    )
+    delete_item(item=kql_database, type="KQLDatabase", workspace=workspace)

sempy_labs/_kql_querysets.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 import pandas as pd
 import sempy_labs._icons as icons
 from typing import Optional
@@ -6,6 +5,8 @@ from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
+    delete_item,
+    create_item,
 )
 from uuid import UUID
 
@@ -74,27 +75,14 @@ def create_kql_queryset(
         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}/kqlQuerysets",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-
-    print(
-        f"{icons.green_dot} The '{name}' KQL queryset has been created within the '{workspace_name}' workspace."
+    create_item(
+        name=name, description=description, type="KQLQueryset", workspace=workspace
     )
 
 
-def delete_kql_queryset(name: str, workspace: Optional[str | UUID] = None):
+def delete_kql_queryset(
+    kql_queryset: str | UUID, workspace: Optional[str | UUID] = None, **kwargs
+):
     """
     Deletes a KQL queryset.
 
@@ -102,23 +90,18 @@ def delete_kql_queryset(name: str, workspace: Optional[str | UUID] = None):
 
     Parameters
     ----------
-    name: str
-        Name of the KQL queryset.
+    kql_queryset: str | uuid.UUID
+        Name or ID of the KQL queryset.
     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.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    kql_database_id = fabric.resolve_item_id(
-        item_name=name, type="KQLQueryset", workspace=workspace_id
-    )
+    if "name" in kwargs:
+        kql_queryset = kwargs["name"]
+        print(
+            f"{icons.warning} The 'name' parameter is deprecated. Please use 'kql_queryset' instead."
+        )
 
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/kqlQuerysets/{kql_database_id}",
-        method="delete",
-    )
-    print(
-        f"{icons.green_dot} The '{name}' KQL queryset within the '{workspace_name}' workspace has been deleted."
-    )
+    delete_item(item=kql_queryset, type="KQLQueryset", workspace=workspace)

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,61 +601,12 @@ 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.
 
+    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
@@ -687,7 +635,9 @@ def list_lakehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/lakehouses", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/lakehouses",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -1189,11 +1139,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 +1157,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,145 +1167,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)
+    from sempy_labs.lakehouse._shortcuts import list_shortcuts
 
-    if lakehouse is None:
-        lakehouse_id = fabric.get_lakehouse_id()
-    else:
-        lakehouse_id = resolve_lakehouse_id(lakehouse, workspace_id)
-
-    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
-
-
-def list_capacities() -> pd.DataFrame:
-    """
-    Shows the capacities and their properties.
-
-    Returns
-    -------
-    pandas.DataFrame
-        A pandas dataframe showing the capacities and their properties
-    """
-
-    columns = {
-        "Id": "string",
-        "Display Name": "string",
-        "Sku": "string",
-        "Region": "string",
-        "State": "string",
-        "Admins": "string",
-    }
-    df = _create_dataframe(columns=columns)
-
-    response = _base_api(request="/v1.0/myorg/capacities")
-
-    for i in response.json().get("value", []):
-        new_data = {
-            "Id": i.get("id").lower(),
-            "Display Name": i.get("displayName"),
-            "Sku": i.get("sku"),
-            "Region": i.get("region"),
-            "State": i.get("state"),
-            "Admins": [i.get("admins", [])],
-        }
-        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_reports_using_semantic_model(

sempy_labs/_managed_private_endpoints.py

@@ -23,6 +23,8 @@ def create_managed_private_endpoint(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - Create Workspace Managed Private Endpoint <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/create-workspace-managed-private-endpoint>`.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     name: str
@@ -60,6 +62,7 @@ def create_managed_private_endpoint(
         status_codes=[201, 202],
         payload=request_body,
         lro_return_status_code=True,
+        client="fabric_sp",
     )
     _print_success(
         item_name=name,
@@ -77,6 +80,8 @@ def list_managed_private_endpoints(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - List Workspace Managed Private Endpoints <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/list-workspace-managed-private-endpoints>`.
 
+    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
@@ -106,7 +111,7 @@ def list_managed_private_endpoints(
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints",
         uses_pagination=True,
-        status_codes=200,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -134,6 +139,8 @@ def delete_managed_private_endpoint(
 
     This is a wrapper function for the following API: `Managed Private Endpoints - Delete Workspace Managed Private Endpoint <https://learn.microsoft.com/rest/api/fabric/core/managed-private-endpoints/delete-workspace-managed-private-endpoint>`.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     managed_private_endpoint: str | uuid.UUID
@@ -162,7 +169,7 @@ def delete_managed_private_endpoint(
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints/{item_id}",
         method="delete",
-        status_codes=200,
+        client="fabric_sp",
     )
 
     _print_success(

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
@@ -21,6 +22,8 @@ def list_mirrored_databases(workspace: Optional[str | UUID] = None) -> pd.DataFr
 
     This is a wrapper function for the following API: `Items - List Mirrored Databases <https://learn.microsoft.com/rest/api/fabric/mirroredwarehouse/items/list-mirrored-databases>`_.
 
+    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
@@ -49,8 +52,8 @@ def list_mirrored_databases(workspace: Optional[str | UUID] = None) -> pd.DataFr
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     responses = _base_api(
         request=f"/v1/workspaces/{workspace_id}/mirroredDatabases",
-        status_codes=200,
         uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -92,21 +95,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 +118,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 +289,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 +309,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(