semantic-link-labs 0.8.11__py3-none-any.whl → 0.9.1__py3-none-any.whl

sempy_labs/_job_scheduler.py

@@ -1,15 +1,19 @@
 import sempy.fabric as fabric
+from sempy._utils._log import log
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_item_name_and_id,
     pagination,
+    lro,
 )
 from sempy.fabric.exceptions import FabricHTTPException
 from uuid import UUID
+import sempy_labs._icons as icons
 
 
+@log
 def list_item_job_instances(
     item: str | UUID, type: Optional[str] = None, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:
@@ -23,7 +27,7 @@ def list_item_job_instances(
     item : str | uuid.UUID
         The item name or ID
     type : str, default=None
-        The item type. If specifying the item name as the item, the item type is required.
+        The item `type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_. If specifying the item name as the item, the item type is required.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID used by the lakehouse.
         Defaults to None which resolves to the workspace of the attached lakehouse
@@ -57,7 +61,8 @@ def list_item_job_instances(
             "Job Type",
             "Invoke Type",
             "Status",
-            "Root Activity Id" "Start Time UTC",
+            "Root Activity Id",
+            "Start Time UTC",
             "End Time UTC",
             "Failure Reason",
         ]
@@ -71,6 +76,7 @@ def list_item_job_instances(
     dfs = []
     for r in responses:
         for v in r.get("value", []):
+            fail = v.get("failureReason", {})
             new_data = {
                 "Job Instance Id": v.get("id"),
                 "Item Name": item_name,
@@ -82,7 +88,7 @@ def list_item_job_instances(
                 "Root Activity Id": v.get("rootActivityId"),
                 "Start Time UTC": v.get("startTimeUtc"),
                 "End Time UTC": v.get("endTimeUtc"),
-                "Failure Reason": v.get("failureReason"),
+                "Error Message": fail.get("message") if fail is not None else "",
             }
             dfs.append(pd.DataFrame(new_data, index=[0]))
 
@@ -90,3 +96,132 @@ def list_item_job_instances(
         df = pd.concat(dfs, ignore_index=True)
 
     return df
+
+
+@log
+def list_item_schedules(
+    item: str | UUID,
+    type: Optional[str] = None,
+    job_type: str = "DefaultJob",
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
+    """
+    Get scheduling settings for one specific item.
+
+    This is a wrapper function for the following API: `Job Scheduler - List Item Schedules <https://learn.microsoft.com/rest/api/fabric/core/job-scheduler/list-item-schedules>`_.
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The item name or ID
+    type : str, default=None
+        The item `type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_. If specifying the item name as the item, the item type is required.
+    job_type : str, default="DefaultJob"
+        The job type.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID used by the lakehouse.
+        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
+        Shows a list of scheduling settings for one specific item.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=type, workspace=workspace
+    )
+
+    df = pd.DataFrame(
+        columns=[
+            "Job Schedule Id",
+            "Enabled",
+            "Created Date Time",
+            "Start Date Time",
+            "End Date Time",
+            "Local Time Zone Id",
+            "Type",
+            "Interval",
+            "Weekdays",
+            "Times",
+            "Owner Id",
+            "Owner Type",
+        ]
+    )
+
+    client = fabric.FabricRestClient()
+    response = client.get(
+        f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/{job_type}/schedules"
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    for v in response.json().get("value", []):
+        config = v.get("configuration", {})
+        own = v.get("owner", {})
+        new_data = {
+            "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"),
+        }
+
+        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    df["Enabled"] = df["Enabled"].astype(bool)
+    df["Created Date Time"] = pd.to_datetime(df["Created Date Time"])
+    df["Start Date Time"] = pd.to_datetime(df["Start Date Time"])
+
+    return df
+
+
+@log
+def run_on_demand_item_job(
+    item: str | UUID,
+    type: Optional[str] = None,
+    job_type: str = "DefaultJob",
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Run on-demand item job instance.
+
+    This is a wrapper function for the following API: `Job Scheduler - Run On Demand Item Job <https://learn.microsoft.com/rest/api/fabric/core/job-scheduler/run-on-demand-item-job>`_.
+
+    Parameters
+    ----------
+    item : str | uuid.UUID
+        The item name or ID
+    type : str, default=None
+        The item `type <https://learn.microsoft.com/rest/api/fabric/core/items/list-items?tabs=HTTP#itemtype>`_. If specifying the item name as the item, the item type is required.
+    job_type : str, default="DefaultJob"
+        The job type.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID used by the lakehouse.
+        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)
+    (item_name, item_id) = resolve_item_name_and_id(
+        item=item, type=type, workspace=workspace
+    )
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"v1/workspaces/{workspace_id}/items/{item_id}/jobs/instances?jobType={job_type}"
+    )
+
+    lro(client, response, return_status_code=True)
+
+    print(f"{icons.green_dot} The '{item_name}' {type.lower()} has been executed.")

sempy_labs/_list_functions.py

@@ -1337,41 +1337,50 @@ def list_reports_using_semantic_model(
         A pandas dataframe showing the reports which use a given semantic model.
     """
 
-    df = pd.DataFrame(
-        columns=[
-            "Report Name",
-            "Report Id",
-            "Report Workspace Name",
-            "Report Workspace Id",
-        ]
-    )
+    # df = pd.DataFrame(
+    #    columns=[
+    #        "Report Name",
+    #        "Report Id",
+    #        "Report Workspace Name",
+    #        "Report Workspace Id",
+    #    ]
+    # )
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
     (dataset_name, dataset_id) = resolve_dataset_name_and_id(dataset, workspace_id)
 
-    client = fabric.PowerBIRestClient()
-    response = client.get(
-        f"metadata/relations/downstream/dataset/{dataset_id}?apiVersion=3"
-    )
-
-    response_json = response.json()
-
-    for i in response_json.get("artifacts", []):
-        object_workspace_id = i.get("workspace", {}).get("objectId")
-        object_type = i.get("typeName")
-
-        if object_type == "Report":
-            new_data = {
-                "Report Name": i.get("displayName"),
-                "Report Id": i.get("objectId"),
-                "Report Workspace Name": fabric.resolve_workspace_name(
-                    object_workspace_id
-                ),
-                "Report Workspace Id": object_workspace_id,
-            }
-            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
-
-    return df
+    dfR = fabric.list_reports(workspace=workspace_id)
+    dfR_filt = dfR[
+        (dfR["Dataset Id"] == dataset_id)
+        & (dfR["Dataset Workspace Id"] == workspace_id)
+    ][["Name", "Id"]]
+    dfR_filt.rename(columns={"Name": "Report Name", "Id": "Report Id"}, inplace=True)
+    dfR_filt["Report Worskpace Name"] = workspace_name
+    dfR_filt["Report Workspace Id"] = workspace_id
+
+    return dfR_filt
+
+    # client = fabric.PowerBIRestClient()
+    # response = client.get(
+    #    f"metadata/relations/downstream/dataset/{dataset_id}?apiVersion=3"
+    # )
+
+    # response_json = response.json()
+
+    # for i in response_json.get("artifacts", []):
+    #    object_workspace_id = i.get("workspace", {}).get("objectId")
+    #    object_type = i.get("typeName")
+
+    #    if object_type == "Report":
+    #        new_data = {
+    #            "Report Name": i.get("displayName"),
+    #            "Report Id": i.get("objectId"),
+    #            "Report Workspace Name": fabric.resolve_workspace_name(
+    #                object_workspace_id
+    #            ),
+    #            "Report Workspace Id": object_workspace_id,
+    #        }
+    #        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
 
 def list_report_semantic_model_objects(