semantic-link-labs 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

sempy_labs/_managed_private_endpoints.py

@@ -1,13 +1,13 @@
-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,
-    lro,
-    pagination,
+    _is_valid_uuid,
+    _base_api,
+    _print_success,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -54,15 +54,18 @@ def create_managed_private_endpoint(
             )
         request_body["requestMessage"] = request_message
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints",
+        method="post",
+        status_codes=[201, 202],
+        payload=request_body,
+        lro_return_status_code=True,
     )
-
-    lro(client, response, status_codes=[201, 202])
-
-    print(
-        f"{icons.green_dot} The '{name}' managed private endpoint has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=name,
+        item_type="managed private endpoint",
+        workspace_name=workspace_name,
+        action="created",
     )
 
 
@@ -87,26 +90,24 @@ def list_managed_private_endpoints(
         A pandas dataframe showing the managed private endpoints within a workspace.
     """
 
-    df = pd.DataFrame(
-        columns=[
-            "Managed Private Endpoint Name",
-            "Managed Private Endpoint Id",
-            "Target Private Link Resource Id",
-            "Provisioning State",
-            "Connection Status",
-            "Connection Description",
-            "Target Subresource Type",
-        ]
-    )
+    columns = {
+        "Managed Private Endpoint Name": "string",
+        "Managed Private Endpoint Id": "string",
+        "Target Private Link Resource Id": "string",
+        "Provisioning State": "string",
+        "Connection Status": "string",
+        "Connection Description": "string",
+        "Target Subresource Type": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints",
+        uses_pagination=True,
+        status_codes=200,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -126,7 +127,7 @@ def list_managed_private_endpoints(
 
 
 def delete_managed_private_endpoint(
-    managed_private_endpoint: str, workspace: Optional[str | UUID] = None
+    managed_private_endpoint: str | UUID, workspace: Optional[str | UUID] = None
 ):
     """
     Deletes a Fabric managed private endpoint.
@@ -135,8 +136,8 @@ def delete_managed_private_endpoint(
 
     Parameters
     ----------
-    managed_private_endpoint: str
-        Name of the managed private endpoint.
+    managed_private_endpoint: str | uuid.UUID
+        Name or ID of the managed private endpoint.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -145,24 +146,28 @@ def delete_managed_private_endpoint(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    df = list_managed_private_endpoints(workspace=workspace_id)
-    df_filt = df[df["Managed Private Endpoint Name"] == managed_private_endpoint]
+    if _is_valid_uuid(managed_private_endpoint):
+        item_id = managed_private_endpoint
+    else:
+        df = list_managed_private_endpoints(workspace=workspace)
+        df_filt = df[df["Managed Private Endpoint Name"] == managed_private_endpoint]
 
-    if len(df_filt) == 0:
-        raise ValueError(
-            f"{icons.red_dot} The '{managed_private_endpoint}' managed private endpoint does not exist within the '{workspace_name}' workspace."
-        )
+        if df_filt.empty:
+            raise ValueError(
+                f"{icons.red_dot} The '{managed_private_endpoint}' managed private endpoint does not exist within the '{workspace_name}' workspace."
+            )
 
-    item_id = df_filt["Managed Private Endpoint Id"].iloc[0]
+        item_id = df_filt["Managed Private Endpoint Id"].iloc[0]
 
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints/{item_id}"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/managedPrivateEndpoints/{item_id}",
+        method="delete",
+        status_codes=200,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{managed_private_endpoint}' managed private endpoint within the '{workspace_name}' workspace has been deleted."
+    _print_success(
+        item_name=managed_private_endpoint,
+        item_type="managed private endpoint",
+        workspace_name=workspace_name,
+        action="deleted",
     )

sempy_labs/_mirrored_databases.py

@@ -3,11 +3,13 @@ import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    pagination,
-    lro,
     _decode_b64,
+    _update_dataframe_datatypes,
+    _base_api,
+    _print_success,
+    resolve_item_id,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 import sempy_labs._icons as icons
 import base64
 from uuid import UUID
@@ -32,26 +34,24 @@ def list_mirrored_databases(workspace: Optional[str | UUID] = None) -> pd.DataFr
         A pandas dataframe showing the mirrored databases within a workspace.
     """
 
-    df = pd.DataFrame(
-        columns=[
-            "Mirrored Database Name",
-            "Mirrored Database Id",
-            "Description",
-            "OneLake Tables Path",
-            "SQL Endpoint Connection String",
-            "SQL Endpoint Id",
-            "Provisioning Status",
-            "Default Schema",
-        ]
-    )
+    columns = {
+        "Mirrored Database Name": "string",
+        "Mirrored Database Id": "string",
+        "Description": "string",
+        "OneLake Tables Path": "string",
+        "SQL Endpoint Connection String": "string",
+        "SQL Endpoint Id": "string",
+        "Provisioning Status": "string",
+        "Default Schema": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/mirroredDatabases")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases",
+        status_codes=200,
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
@@ -94,21 +94,19 @@ def create_mirrored_database(
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
 
-    request_body = {"displayName": name}
+    payload = {"displayName": name}
 
     if description:
-        request_body["description"] = description
+        payload["description"] = description
 
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases", json=request_body
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases",
+        status_codes=201,
+        method="post",
+        payload=payload,
     )
-
-    if response.status_code != 201:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{name}' mirrored database has been created within the '{workspace_name}' workspace."
+    _print_success(
+        item_name=name, item_type="mirrored database", workspace_name=workspace_name
     )
 
 
@@ -130,27 +128,19 @@ def delete_mirrored_database(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-
-    client = fabric.FabricRestClient()
-    response = client.delete(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}"
-    )
-
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    print(
-        f"{icons.green_dot} The '{mirrored_database}' mirrored database within the '{workspace_name}' workspace has been deleted."
+    fabric.delete_item(item_id=item_id, workspace=workspace)
+    _print_success(
+        item_name=mirrored_database,
+        item_type="mirrored database",
+        workspace_name=workspace,
     )
 
 
 def get_mirroring_status(
-    mirrored_database: str, workspace: Optional[str | UUID] = None
+    mirrored_database: str | UUID, workspace: Optional[str | UUID] = None
 ) -> str:
     """
     Get the status of the mirrored database.
@@ -159,8 +149,8 @@ def get_mirroring_status(
 
     Parameters
     ----------
-    mirrored_database: str
-        Name of the mirrored database.
+    mirrored_database: str | uuid.UUID
+        Name or ID of the mirrored 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
@@ -173,24 +163,19 @@ def get_mirroring_status(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getMirroringStatus"
+    response = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getMirroringStatus",
+        status_codes=200,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     return response.json().get("status", {})
 
 
 def get_tables_mirroring_status(
-    mirrored_database: str, workspace: Optional[str | UUID] = None
+    mirrored_database: str | UUID, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
     """
     Gets the mirroring status of the tables.
@@ -199,8 +184,8 @@ def get_tables_mirroring_status(
 
     Parameters
     ----------
-    mirrored_database: str
-        Name of the mirrored database.
+    mirrored_database: str | uuid.UUID
+        Name or ID of the mirrored 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
@@ -213,31 +198,25 @@ def get_tables_mirroring_status(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getTablesMirroringStatus"
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getTablesMirroringStatus",
+        method="post",
+        status_codes=200,
+        uses_pagination=True,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
-    responses = pagination(client, response)
-
-    df = pd.DataFrame(
-        columns=[
-            "Source Schema Name",
-            "Source Table Name",
-            "Status",
-            "Processed Bytes",
-            "Processed Rows",
-            "Last Sync Date",
-        ]
-    )
+    columns = {
+        "Source Schema Name": "string",
+        "Source Table Name": "string",
+        "Status": "string",
+        "Processed Bytes": "int",
+        "Processed Rows": "int",
+        "Last Sync Date": "datetime",
+    }
+    df = _create_dataframe(columns=columns)
 
     for r in responses:
         for v in r.get("data", []):
@@ -253,14 +232,14 @@ def get_tables_mirroring_status(
 
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
-    int_cols = ["Processed Bytes", "Processed Rows"]
-    df[int_cols] = df[int_cols].astype(int)
-    df["Last Sync Date"] = pd.to_datetime(df["Last Sync Date"])
+    _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
     return df
 
 
-def start_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = None):
+def start_mirroring(
+    mirrored_database: str | UUID, workspace: Optional[str | UUID] = None
+):
     """
     Starts the mirroring for a database.
 
@@ -268,8 +247,8 @@ def start_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = No
 
     Parameters
     ----------
-    mirrored_database: str
-        Name of the mirrored database.
+    mirrored_database: str | uuid.UUID
+        Name or ID of the mirrored 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
@@ -277,25 +256,23 @@ def start_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = No
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/startMirroring"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/startMirroring",
+        method="post",
+        status_codes=200,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} Mirroring has started for the '{mirrored_database}' database within the '{workspace_name}' workspace."
     )
 
 
-def stop_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = None):
+def stop_mirroring(
+    mirrored_database: str | UUID, workspace: Optional[str | UUID] = None
+):
     """
     Stops the mirroring for a database.
 
@@ -303,8 +280,8 @@ def stop_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = Non
 
     Parameters
     ----------
-    mirrored_database: str
-        Name of the mirrored database.
+    mirrored_database: str | uuid.UUID
+        Name or ID of the mirrored 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
@@ -312,26 +289,24 @@ def stop_mirroring(mirrored_database: str, workspace: Optional[str | UUID] = Non
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/stopMirroring"
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/stopMirroring",
+        method="post",
+        status_codes=200,
     )
 
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-
     print(
         f"{icons.green_dot} Mirroring has stopped for the '{mirrored_database}' database within the '{workspace_name}' workspace."
     )
 
 
 def get_mirrored_database_definition(
-    mirrored_database: str, workspace: Optional[str | UUID] = None, decode: bool = True
+    mirrored_database: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    decode: bool = True,
 ) -> str:
     """
     Obtains the mirrored database definition.
@@ -340,8 +315,8 @@ def get_mirrored_database_definition(
 
     Parameters
     ----------
-    mirrored_database : str
-        The name of the mirrored database.
+    mirrored_database : str | uuid.UUID
+        The name or ID of the mirrored database.
     workspace : str | uuid.UUID, default=None
         The name or ID of the workspace.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -357,15 +332,16 @@ def get_mirrored_database_definition(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
-    client = fabric.FabricRestClient()
-    response = client.post(
-        f"v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getDefinition",
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/getDefinition",
+        method="post",
+        status_codes=200,
+        lro_return_json=True,
     )
 
-    result = lro(client, response).json()
     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]
@@ -379,7 +355,7 @@ def get_mirrored_database_definition(
 
 
 def update_mirrored_database_definition(
-    mirrored_database: str,
+    mirrored_database: str | UUID,
     mirrored_database_content: dict,
     workspace: Optional[str | UUID] = None,
 ):
@@ -388,8 +364,8 @@ def update_mirrored_database_definition(
 
     Parameters
     ----------
-    mirrored_database : str
-        The name of the mirrored database to be created.
+    mirrored_database : str | uuid.UUID
+        The name or ID of the mirrored database to be updated.
     mirrored_database_content : dict
         The mirrored database definition (not in Base64 format).
     workspace : str | uuid.UUID, default=None
@@ -399,11 +375,10 @@ def update_mirrored_database_definition(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    client = fabric.FabricRestClient()
-    payload = base64.b64encode(mirrored_database_content)
-    item_id = fabric.resolve_item_id(
-        item_name=mirrored_database, type="MirroredDatabase", workspace=workspace_id
+    item_id = resolve_item_id(
+        item=mirrored_database, type="MirroredDatabase", workspace=workspace
     )
+    payload = base64.b64encode(mirrored_database_content)
 
     request_body = {
         "displayName": mirrored_database,
@@ -419,13 +394,14 @@ def update_mirrored_database_definition(
         },
     }
 
-    response = client.post(
-        f"v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/updateDefinition",
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredDatabases/{item_id}/updateDefinition",
+        method="post",
         json=request_body,
+        status_codes=None,
+        lro_return_status_code=True,
     )
 
-    lro(client, response, return_status_code=True)
-
     print(
         f"{icons.green_dot} The '{mirrored_database}' mirrored database was updated within the '{workspace_name}' workspace."
     )

sempy_labs/_mirrored_warehouses.py

@@ -1,11 +1,10 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
-    pagination,
+    _base_api,
+    _create_dataframe,
 )
-from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
 
 
@@ -28,21 +27,22 @@ def list_mirrored_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataF
         A pandas dataframe showing the mirrored warehouses within a workspace.
     """
 
-    df = pd.DataFrame(
-        columns=["Mirrored Warehouse Name", "Mirrored Warehouse Id", "Description"]
-    )
+    columns = {
+        "Mirrored Warehouse Name": "string",
+        "Mirrored Warehouse Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    client = fabric.FabricRestClient()
-    response = client.get(f"/v1/workspaces/{workspace_id}/mirroredWarehouses")
-    if response.status_code != 200:
-        raise FabricHTTPException(response)
-    responses = pagination(client, response)
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mirroredWarehouses",
+        status_codes=200,
+        uses_pagination=True,
+    )
 
     for r in responses:
         for v in r.get("value", []):
-
             new_data = {
                 "Mirrored Warehouse Name": v.get("displayName"),
                 "Mirrored Warehouse Id": v.get("id"),