semantic-link-labs 0.12.1__py3-none-any.whl → 0.12.3__py3-none-any.whl

sempy_labs/_get_connection_string.py

@@ -0,0 +1,84 @@
+from sempy_labs._helper_functions import (
+    resolve_item_id,
+    _base_api,
+    resolve_workspace_id,
+)
+from typing import Optional, Literal
+import sempy_labs._icons as icons
+from uuid import UUID
+from sempy._utils._log import log
+
+
+@log
+def get_connection_string(
+    item: str | UUID,
+    type: Literal["Lakehouse", "Warehouse", "SQLEndpoint"],
+    workspace: Optional[str | UUID] = None,
+    guest_tenant_id: Optional[UUID] = None,
+    private_link_type: Optional[str] = None,
+) -> str:
+    """
+    Returns the SQL connection string of the specified item.
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The name or ID of the item (Lakehouse or MirroredDatabase).
+    type : Literal['Lakehouse', 'Warehouse', 'SQLEndpoint']
+        The type of the item. Must be 'Lakehouse' or 'MirroredDatabase'.
+    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.
+    guest_tenant_id : uuid.UUID, default=None
+        The guest tenant ID if the end user's tenant is different from the warehouse tenant.
+    private_link_type : str, default=None
+        Indicates the type of private link this connection string uses. Must be either 'Workspace' or 'None' or left as None.
+
+    Returns
+    -------
+    str
+        Returns the SQL connection string of the specified item.
+    """
+    workspace_id = resolve_workspace_id(workspace)
+    item_id = resolve_item_id(item=item, type=type, workspace=workspace)
+
+    type_dict = {
+        "Warehouse": "warehouses",
+        "SQLEndpoint": "sqlEndpoints",
+    }
+    type_for_url = type_dict.get(type)
+
+    if type == "Lakehouse":
+        response = _base_api(
+            f"/v1/workspaces/{workspace_id}/lakehouses/{item_id}", client="fabric_sp"
+        ).json()
+        return (
+            response.get("properties", {})
+            .get("sqlEndpointProperties", {})
+            .get("connectionString", {})
+        )
+    if type in ["SQLEndpoint", "Warehouse"]:
+        url = f"/v1/workspaces/{workspace_id}/{type_for_url}/{item_id}/connectionString"
+    else:
+        raise ValueError(
+            f"{icons.red_dot} The type must be 'Lakehouse', 'Warehouse' or 'SQLEndpoint'."
+        )
+
+    if private_link_type is not None and private_link_type not in ["Workspace", "None"]:
+        raise ValueError(
+            f"{icons.red_dot} private_link_type must be 'Workspace' or 'None' or left as None."
+        )
+
+    if guest_tenant_id or private_link_type:
+        params = []
+        if guest_tenant_id:
+            params.append(f"guestTenantId={guest_tenant_id}")
+        if private_link_type:
+            params.append(f"privateLinkType={private_link_type}")
+        param_str = "?" + "&".join(params)
+        url += param_str
+
+    response = _base_api(request=url, client="fabric_sp")
+
+    return response.json().get("connectionString")

sempy_labs/_helper_functions.py

@@ -303,6 +303,7 @@ def create_item(
         payload=payload,
         status_codes=[201, 202],
         lro_return_status_code=True,
+        client="fabric_sp",
     )
     print(
         f"{icons.green_dot} The '{name}' {item_type} has been successfully created within the '{workspace_name}' workspace."
@@ -407,7 +408,8 @@ def copy_item(
         # Get the existing source model
         if type == "Report" and keep_existing_bindings:
             result = _base_api(
-                request=f"v1.0/myorg/groups/{target_workspace_id}/reports/{target_item_id}"
+                request=f"v1.0/myorg/groups/{target_workspace_id}/reports/{target_item_id}",
+                client="fabric_sp",
             ).json()
             dataset_id = result.get("datasetId")
             dataset_workspace_id = result.get("datasetWorkspaceId")
@@ -524,6 +526,7 @@ def get_item_definition(
         method="post",
         status_codes=None,
         lro_return_json=True,
+        client="fabric_sp",
     )
 
     if return_dataframe:
@@ -546,6 +549,7 @@ def get_item_definition(
             definition["definition"]["parts"].append(
                 {"path": path, "payload": decoded_payload}
             )
+        return definition
     else:
         return result
 
@@ -574,6 +578,7 @@ def _get_item_definition(
         method="post",
         status_codes=None,
         lro_return_json=True,
+        client="fabric_sp",
     )
 
     if return_dataframe:
@@ -2758,3 +2763,14 @@ def remove_json_value(path: str, payload: dict, json_path: str, verbose: bool =
                     print(f"{icons.green_dot} Removed index [{index}] from '{path}'.")
 
     return payload
+
+
+def _get_url_prefix() -> str:
+
+    client = fabric.PowerBIRestClient()
+    response = client.get("/v1.0/myorg/capacities")
+    if response.status_code != 200:
+        raise FabricHTTPException("Failed to retrieve URL prefix.")
+    context = response.json().get("@odata.context")
+
+    return context.split("/v1.0")[0]

sempy_labs/_job_scheduler.py

@@ -8,6 +8,7 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_id,
+    resolve_item_id,
 )
 from uuid import UUID
 import sempy_labs._icons as icons
@@ -113,7 +114,7 @@ def _get_item_job_instance(url: str) -> pd.DataFrame:
     }
     df = _create_dataframe(columns=columns)
 
-    response = _base_api(request=url)
+    response = _base_api(request=url, client="fabric_sp")
 
     rows = []
     for v in response.json().get("value", []):
@@ -171,11 +172,9 @@ def list_item_schedules(
     """
 
     workspace_id = resolve_workspace_id(workspace)
-    (item_name, item_id) = resolve_item_name_and_id(
-        item=item, type=type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item, type=type, workspace=workspace_id)
 
-    columns = {
+    base_columns = {
         "Job Schedule Id": "string",
         "Enabled": "bool",
         "Created Date Time": "datetime",
@@ -183,48 +182,75 @@ def list_item_schedules(
         "End Date Time": "string",
         "Local Time Zone Id": "string",
         "Type": "string",
-        "Interval": "string",
-        "Weekdays": "string",
-        "Times": "string",
         "Owner Id": "string",
         "Owner Type": "string",
-        "Recurrence": "int",
+    }
+
+    optional_columns = {
+        "Occurrence Day of Month": "int_fillna",
+        "Occurrence Week Index": "string",
+        "Occurrence Weekday": "string",
         "Occurrence Type": "string",
-        "Occurrence Day of Month": "int",
+        "Interval": "int_fillna",
+        "Times": "string",
+        "Recurrence": "int_fillna",
+        "Weekdays": "string",
     }
-    df = _create_dataframe(columns=columns)
 
     response = _base_api(
-        request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/{job_type}/schedules"
+        request=f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/{job_type}/schedules",
+        client="fabric_sp",
     )
 
     rows = []
     for v in response.json().get("value", []):
         config = v.get("configuration", {})
         own = v.get("owner", {})
-        rows.append(
-            {
-                "Job Schedule Id": v.get("id"),
-                "Enabled": v.get("enabled"),
-                "Created Date Time": v.get("createdDateTime"),
-                "Start Date Time": config.get("startDateTime"),
-                "End Date Time": config.get("endDateTime"),
-                "Local Time Zone Id": config.get("localTimeZoneId"),
-                "Type": config.get("type"),
-                "Interval": config.get("interval"),
-                "Weekdays": config.get("weekdays"),
-                "Times": config.get("times"),
-                "Owner Id": own.get("id"),
-                "Owner Type": own.get("type"),
-                "Recurrence": config.get("recurrence"),
-                "Occurrence Type": config.get("occurence", {}).get("occurrenceType"),
-                "Occurrence Day of Month": config.get("occurrence", {}).get(
-                    "dayOfMonth"
-                ),
-            }
-        )
+        occurrence = config.get("occurrence", {})
+        type = config.get("type")
+
+        row = {
+            "Job Schedule Id": v.get("id"),
+            "Enabled": v.get("enabled"),
+            "Created Date Time": v.get("createdDateTime"),
+            "Start Date Time": config.get("startDateTime"),
+            "End Date Time": config.get("endDateTime"),
+            "Local Time Zone Id": config.get("localTimeZoneId"),
+            "Type": type,
+            "Owner Id": own.get("id"),
+            "Owner Type": own.get("type"),
+        }
+
+        if type == "Cron":
+            row["Interval"] = config.get("interval")
+        elif type == "Daily":
+            row["Times"] = config.get("times")
+        elif type == "Weekly":
+            row["Times"] = config.get("times")
+            row["Weekdays"] = config.get("weekdays")
+        elif type == "Monthly":
+            occurrence_type = occurrence.get("occurrenceType")
+            row["Times"] = config.get("times")
+            row["Recurrence"] = config.get("recurrence")
+            row["Occurrence Type"] = occurrence_type
+
+            if occurrence_type == "OrdinalWeekday":
+                row["Occurrence Week Index"] = occurrence.get("weekIndex")
+                row["Occurrence Weekday"] = occurrence.get("weekday")
+            elif occurrence_type == "DayOfMonth":
+                row["Occurrence Day of Month"] = occurrence.get("dayOfMonth")
+
+        rows.append(row)
+
+    # Build final column map based on what was actually present
+    columns = base_columns.copy()
 
     if rows:
+        # Find which optional columns were actually included in rows
+        all_used_columns = set().union(*(r.keys() for r in rows))
+        for col in all_used_columns:
+            if col in optional_columns:
+                columns[col] = optional_columns[col]
         df = pd.DataFrame(rows, columns=list(columns.keys()))
         _update_dataframe_datatypes(dataframe=df, column_map=columns)
 
@@ -267,6 +293,7 @@ def run_on_demand_item_job(
         method="post",
         lro_return_status_code=True,
         status_codes=202,
+        client="fabric_sp",
     )
 
     print(f"{icons.green_dot} The '{item_name}' {type.lower()} has been executed.")
@@ -334,6 +361,7 @@ def create_item_schedule_cron(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -403,6 +431,7 @@ def create_item_schedule_daily(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(
@@ -492,6 +521,7 @@ def create_item_schedule_weekly(
         method="post",
         payload=payload,
         status_codes=201,
+        client="fabric_sp",
     )
 
     print(

sempy_labs/_labels.py

@@ -5,6 +5,9 @@ from typing import Optional, Union
 from uuid import UUID
 from sempy.fabric.exceptions import FabricHTTPException
 from sempy._utils._log import log
+from sempy_labs._helper_functions import (
+    _get_url_prefix,
+)
 
 
 @log
@@ -87,12 +90,7 @@ def list_item_labels(workspace: Optional[Union[str, UUID]] = None) -> pd.DataFra
     if artifact_ids:
         payload["artifacts"] = [{"artifactId": i} for i in artifact_ids]
 
-    client = fabric.PowerBIRestClient()
-    response = client.get("/v1.0/myorg/capacities")
-    if response.status_code != 200:
-        raise FabricHTTPException("Failed to retrieve URL prefix.")
-    context = response.json().get("@odata.context")
-    prefix = context.split("/v1.0")[0]
+    prefix = _get_url_prefix()
 
     response = requests.post(
         f"{prefix}/metadata/informationProtection/artifacts",

sempy_labs/_model_dependencies.py

@@ -334,7 +334,10 @@ def measure_dependency_tree(
 
     # Visualize the tree structure using RenderTree
     for pre, _, node in RenderTree(node_dict[measure_name]):
-        if icons.table_icon in node.custom_property:
+        if (
+            hasattr(node, "custom_property")
+            and icons.table_icon in node.custom_property
+        ):
             print(f"{pre}{node.custom_property}'{node.name}'")
         else:
-            print(f"{pre}{node.custom_property}[{node.name}]")
+            print(f"{pre}'{node.name}'")

sempy_labs/_semantic_models.py

@@ -348,3 +348,121 @@ def list_semantic_model_datasources(
         df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df
+
+
+@log
+def bind_semantic_model_connection(
+    dataset: str | UUID,
+    connection_id: UUID,
+    connectivity_type: str,
+    connection_type: str,
+    connection_path: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Binds a semantic model data source reference to a data connection.
+    This API can also be used to unbind data source references.
+
+    This is a wrapper function for the following API: `Items - Bind Semantic Model Connection <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    dataset : str | uuid.UUID
+        Name or ID of the semantic model.
+    connection_id : uuid.UUID
+        The object ID of the connection.
+    connectivity_type : str
+        The connectivity type of the connection. Additional connectivity types may be added over time.
+    connection_type : str
+        The `type <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection?tabs=HTTP#connectivitytype>`_ of the connection.
+    connection_path : str
+        The path of the connection.
+    workspace : str | uuid.UUID, default=None
+        The 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)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(
+        dataset=dataset, workspace=workspace_id
+    )
+
+    payload = {
+        "connectionBinding": {
+            "id": str(connection_id),
+            "connectivityType": connectivity_type,
+            "connectionDetails": {
+                "type": connection_type,
+                "path": connection_path,
+            },
+        }
+    }
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/bindConnection",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} Connection '{connection_id}' has been bound to the '{dataset_name}' semantic model within the '{workspace_name}' workspace."
+    )
+
+
+@log
+def unbind_semantic_model_connection(
+    dataset: str | UUID,
+    connection_type: str,
+    connection_path: str,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Unbinds a semantic model data source reference to a data connection.
+
+    This is a wrapper function for the following API: `Items - Bind Semantic Model Connection <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    dataset : str | uuid.UUID
+        Name or ID of the semantic model.
+    connection_type : str
+        The `type <https://learn.microsoft.com/rest/api/fabric/semanticmodel/items/bind-semantic-model-connection?tabs=HTTP#connectivitytype>`_ of the connection.
+    connection_path : str
+        The path of the connection.
+    workspace : str | uuid.UUID, default=None
+        The 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)
+    (dataset_name, dataset_id) = resolve_dataset_name_and_id(
+        dataset=dataset, workspace=workspace_id
+    )
+
+    payload = {
+        "connectionBinding": {
+            "connectivityType": "None",
+            "connectionDetails": {
+                "type": connection_type,
+                "path": connection_path,
+            },
+        }
+    }
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/semanticModels/{dataset_id}/bindConnection",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{dataset_name}' semantic model within the '{workspace_name}' workspace has been unbound from its connection."
+    )

sempy_labs/_sql_endpoints.py

@@ -66,7 +66,8 @@ def refresh_sql_endpoint_metadata(
     item: str | UUID,
     type: Literal["Lakehouse", "MirroredDatabase"],
     workspace: Optional[str | UUID] = None,
-    tables: dict[str, list[str]] = None,
+    timeout_unit: Literal["Seconds", "Minutes", "Hours", "Days"] = "Minutes",
+    timeout_value: int = 15,
 ) -> pd.DataFrame:
     """
     Refreshes the metadata of a SQL endpoint.
@@ -85,15 +86,10 @@ def refresh_sql_endpoint_metadata(
         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.
-    tables : dict[str, list[str]], default=None
-        A dictionary where the keys are schema names and the values are lists of table names.
-        If empty, all table metadata will be refreshed.
-
-        Example:
-        {
-            "dbo": ["DimDate", "DimGeography"],
-            "sls": ["FactSales", "FactBudget"],
-        }
+    timeout_unit : Literal['Seconds', 'Minutes', 'Hours', 'Days'], default='Minutes'
+        The unit of time for the request duration before timing out. Additional duration types may be added over time.
+    timeout_value : int, default=15
+        The number of time units in the request duration.
 
     Returns
     -------
@@ -132,14 +128,10 @@ def refresh_sql_endpoint_metadata(
     else:
         raise ValueError("Invalid type. Must be 'Lakehouse' or 'MirroredDatabase'.")
 
-    payload = {}
-    if tables:
-        payload = {
-            "tableDefinitions": [
-                {"schema": schema, "tableNames": tables}
-                for schema, tables in tables.items()
-            ]
-        }
+    payload = None
+    timeout_unit = timeout_unit.capitalize()
+    if timeout_unit != "Minutes" and timeout_value != 15:
+        payload = {"timeout": {"timeUnit": timeout_unit, "value": timeout_value}}
 
     result = _base_api(
         request=f"v1/workspaces/{workspace_id}/sqlEndpoints/{sql_endpoint_id}/refreshMetadata",
@@ -195,10 +187,8 @@ def refresh_sql_endpoint_metadata(
         df = df[column_order]
 
         printout = f"{icons.green_dot} The metadata of the SQL endpoint for the '{item_name}' {type.lower()} within the '{workspace_name}' workspace has been refreshed"
-        if tables:
-            print(f"{printout} for the following tables: {tables}.")
-        else:
-            print(f"{printout} for all tables.")
+        print(f"{printout} for all tables.")
+        _update_dataframe_datatypes(df, columns)
     else:
         # If the target item has no tables to refresh the metadata for
         df = pd.DataFrame(columns=columns.keys())
@@ -206,6 +196,4 @@ def refresh_sql_endpoint_metadata(
             f"{icons.yellow_dot} The SQL endpoint '{item_name}' {type.lower()} within the '{workspace_name}' workspace has no tables to refresh..."
         )
 
-    _update_dataframe_datatypes(df, columns)
-
     return df

sempy_labs/_warehouses.py

@@ -1,4 +1,4 @@
-from ._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,

sempy_labs/admin/__init__.py

@@ -94,6 +94,10 @@ from ._tenant_keys import (
     list_tenant_keys,
     rotate_tenant_key,
 )
+from ._sharing_links import (
+    remove_all_sharing_links,
+    remove_sharing_links,
+)
 
 __all__ = [
     "list_items",
@@ -155,4 +159,6 @@ __all__ = [
     "delete_tag",
     "list_tenant_keys",
     "rotate_tenant_key",
+    "remove_all_sharing_links",
+    "remove_sharing_links",
 ]

sempy_labs/admin/_sharing_links.py

@@ -0,0 +1,110 @@
+from sempy._utils._log import log
+from sempy_labs._helper_functions import (
+    _base_api,
+    _is_valid_uuid,
+)
+import sempy_labs._icons as icons
+from typing import List
+
+
+@log
+def remove_all_sharing_links(sharing_link_type: str = "OrgLink"):
+    """
+    Deletes all organization sharing links for all Fabric items in the tenant. This action cannot be undone.
+
+    This is a wrapper function for the following API: `Sharing Links - Remove All Sharing Links <https://learn.microsoft.com/rest/api/fabric/admin/sharing-links/remove-all-sharing-links>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    sharing_link_type : str, default='OrgLink'
+        Specifies the type of sharing link that is required to be deleted. Additional sharing link types may be added over time.
+    """
+
+    payload = {"sharingLinkType": sharing_link_type}
+
+    _base_api(
+        request="/v1/admin/items/removeAllSharingLinks",
+        client="fabric_sp",
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} All organization sharing links for all Fbric items in the tenant have been deleted."
+    )
+
+
+@log
+def remove_sharing_links(items: List[dict], sharing_link_type: str = "OrgLink"):
+    """
+    Deletes all organization sharing links for the specified Fabric items. This action cannot be undone.
+
+    This is a wrapper function for the following API: `Sharing Links - Bulk Remove Sharing Links <https://learn.microsoft.com/rest/api/fabric/admin/sharing-links/bulk-remove-sharing-links>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    items : List[dict]
+        A list of dictionaries, each representing an item. The 'item' and 'workspace' accepts either name or ID. Examples:
+
+        [
+            {
+                "item": "MyReport",
+                "type": "Report",
+                "workspace": "Workpsace 1",
+            },
+            {
+                "item": "MyReport2",
+                "type": "Report",
+                "workspace": "Workspace 2",
+            },
+        ]
+
+        [
+            {
+                "item": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
+                "type": "Report",
+                "workspace": "Workspace 1",
+            },
+            {
+                "item": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
+                "type": "Notebook",
+                "workspace": "476fcafe-b514-495d-b13f-ca9a4f0b1d8f",
+            },
+        ]
+
+    sharing_link_type : str, default='OrgLink'
+        Specifies the type of sharing link that is required to be deleted. Additional sharing link types may be added over time.
+    """
+
+    from sempy_labs.admin._items import _resolve_item_id
+
+    payload = {"items": [], "sharingLinkType": sharing_link_type}
+
+    for i in items:
+        item = i.get("item")
+        type = i.get("type")
+        workspace = i.get("workspace")
+        if _is_valid_uuid(item):
+            payload["items"].append({"id": item, "type": type})
+        else:
+            item_id = _resolve_item_id(item=item, type=type, workspace=workspace)
+            payload["items"].append({"id": item_id, "type": type})
+
+    _base_api(
+        request="/v1/admin/items/bulkRemoveSharingLinks",
+        client="fabric_sp",
+        method="post",
+        payload=payload,
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+    )
+
+    print(
+        f"{icons.green_dot} Organizational sharing links for all specified items have been deleted."
+    )