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

sempy_labs/_sqldatabase.py

@@ -1,70 +1,69 @@
-import sempy.fabric as fabric
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
     _update_dataframe_datatypes,
+    create_item,
+    delete_item,
 )
 import pandas as pd
 from typing import Optional
-import sempy_labs._icons as icons
 from uuid import UUID
 
-## Still debugging the creation of an sql database
-# def create_warehouse(
-#     warehouse: str,
-#     description: Optional[str] = None,
-#     case_insensitive_collation: bool = False,
-#     workspace: Optional[str | UUID] = None,
-# ):
-#     """
-#     Creates a Fabric warehouse.
-
-#     This is a wrapper function for the following API: `Items - Create Warehouse <https://learn.microsoft.com/rest/api/fabric/warehouse/items/create-warehouse>`_.
-
-#     Parameters
-#     ----------
-#     warehouse: str
-#         Name of the warehouse.
-#     description : str, default=None
-#         A description of the warehouse.
-#     case_insensitive_collation: bool, default=False
-#         If True, creates the warehouse with case-insensitive collation.
-#     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)
-
-#     payload = {"displayName": warehouse}
-
-#     if description:
-#         payload["description"] = description
-#     if case_insensitive_collation:
-#         payload.setdefault("creationPayload", {})
-#         payload["creationPayload"][
-#             "defaultCollation"
-#         ] = "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
-
-#     _base_api(
-#         request=f"/v1/workspaces/{workspace_id}/warehouses",
-#         payload=payload,
-#         method="post",
-#         lro_return_status_code=True,
-#         status_codes=[201, 202],
-#     )
-
-#     print(
-#         f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace_name}' workspace."
-#     )
-
-
-def _list_sql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+
+def create_sql_database(
+    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
+):
+    """
+    Creates a SQL database.
+
+    This is a wrapper function for the following API: `Items - Create SQL Database <https://learn.microsoft.com/rest/api/fabric/sqldatabase/items/create-sql-database>`_.
+
+    Parameters
+    ----------
+    name: str
+        Name of the SQL database.
+    description : str, default=None
+        A description of the SQL 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.
+    """
+
+    create_item(
+        name=name, description=description, type="SQLDatabase", workspace=workspace
+    )
+
+
+def delete_sql_database(
+    sql_database: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Deletes a SQL Database.
+
+    This is a wrapper function for the following API: `Items - Delete SQL Database <https://learn.microsoft.com/rest/api/fabric/sqldatabase/items/delete-sql-database>`_.
+
+    Parameters
+    ----------
+    sql_database: str | uuid.UUID
+        Name of the SQL 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.
     """
-    Shows the databses within a workspace.
 
+    delete_item(item=sql_database, type="SQLDatabase", workspace=workspace)
+
+
+def list_sql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Lists all SQL databases in the Fabric workspace.
+
+    This is a wrapper function for the following API: `Items - List SQL Databases <https://learn.microsoft.com/rest/api/fabric/sqldatabase/items/list-sql-databases>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
 
     Parameters
     ----------
@@ -76,45 +75,39 @@ def _list_sql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     Returns
     -------
     pandas.DataFrame
-        A pandas dataframe showing the SQLDabatases within a workspace.
+        A pandas dataframe showing a list of SQL databases in the Fabric workspace.
     """
 
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
     columns = {
         "SQL Database Name": "string",
         "SQL Database Id": "string",
         "Description": "string",
-        "Connection Type": "string",
         "Connection Info": "string",
         "Database Name": "string",
         "Server FQDN": "string",
-        "Provisioning Status": "string",
-        "Created Date": "datetime",
-        "Last Updated Time UTC": "datetime",
     }
     df = _create_dataframe(columns=columns)
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
     responses = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/sqldatabases", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/SQLDatabases",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
         for v in r.get("value", []):
             prop = v.get("properties", {})
-
             new_data = {
                 "SQL Database Name": v.get("displayName"),
                 "SQL Database Id": v.get("id"),
                 "Description": v.get("description"),
-                "Connection Type": v.get("type"),
                 "Connection Info": prop.get("connectionInfo"),
                 "Database Name": prop.get("databaseName"),
                 "Server FQDN": prop.get("serverFqdn"),
-                "Provisioning Status": prop.get("provisioningState"),
-                "Created Date": prop.get("createdDate"),
-                "Last Updated Time UTC": prop.get("lastUpdatedTimeUtc"),
             }
+
             df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
 
     _update_dataframe_datatypes(dataframe=df, column_map=columns)
@@ -122,38 +115,6 @@ def _list_sql_databases(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
-## Still debugging the deletion of an sql database
-# def delete_warehouse(name: str, workspace: Optional[str | UUID] = None):
-#     """
-#     Deletes a Fabric warehouse.
-
-#     This is a wrapper function for the following API: `Items - Delete Warehouse <https://learn.microsoft.com/rest/api/fabric/warehouse/items/delete-warehouse>`_.
-
-#     Parameters
-#     ----------
-#     name: str
-#         Name of the warehouse.
-#     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)
-
-#     item_id = fabric.resolve_item_id(
-#         item_name=name, type="Warehouse", workspace=workspace_id
-#     )
-
-#     _base_api(
-#         request=f"/v1/workspaces/{workspace_id}/warehouses/{item_id}", method="delete"
-#     )
-
-#     print(
-#         f"{icons.green_dot} The '{name}' warehouse within the '{workspace_name}' workspace has been deleted."
-#     )
-
-
 def get_sql_database_tables(
     sql_database: str | UUID, workspace: Optional[str | UUID] = None
 ) -> pd.DataFrame:

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"],
+}

sempy_labs/_vertipaq.py

@@ -15,6 +15,8 @@ from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     _create_spark_session,
+    resolve_workspace_id,
+    resolve_workspace_name,
 )
 from sempy_labs._list_functions import list_relationships, list_tables
 from sempy_labs.lakehouse import lakehouse_attached, get_lakehouse_tables
@@ -33,9 +35,11 @@ def vertipaq_analyzer(
     export: Optional[str] = None,
     read_stats_from_data: bool = False,
     **kwargs,
-):
+) -> dict[str, pd.DataFrame]:
     """
-    Displays an HTML visualization of the Vertipaq Analyzer statistics from a semantic model.
+    Displays an HTML visualization of the `Vertipaq Analyzer <https://www.sqlbi.com/tools/vertipaq-analyzer/>`_ statistics from a semantic model.
+
+    `Vertipaq Analyzer <https://www.sqlbi.com/tools/vertipaq-analyzer/>`_ is an open-sourced tool built by SQLBI. It provides a detailed analysis of the VertiPaq engine, which is the in-memory engine used by Power BI and Analysis Services Tabular models.
 
     Parameters
     ----------
@@ -51,6 +55,11 @@ def vertipaq_analyzer(
         Default value: None.
     read_stats_from_data : bool, default=False
         Setting this parameter to true has the function get Column Cardinality and Missing Rows using DAX (Direct Lake semantic models achieve this using a Spark query to the lakehouse).
+
+    Returns
+    -------
+    dict[str, pandas.DataFrame]
+        A dictionary of pandas dataframes showing the vertipaq analyzer statistics.
     """
 
     from sempy_labs.tom import connect_semantic_model
@@ -189,8 +198,10 @@ def vertipaq_analyzer(
                 & (~dfC["Column Name"].str.startswith("RowNumber-"))
             ]
 
-            object_workspace = fabric.resolve_workspace_name(lakehouse_workspace_id)
-            current_workspace_id = fabric.get_workspace_id()
+            object_workspace = resolve_workspace_name(
+                workspace_id=lakehouse_workspace_id
+            )
+            current_workspace_id = resolve_workspace_id()
             if current_workspace_id != lakehouse_workspace_id:
                 lakeTables = get_lakehouse_tables(
                     lakehouse=lakehouse_name, workspace=object_workspace
@@ -502,6 +513,14 @@ def vertipaq_analyzer(
 
     if export is None:
         visualize_vertipaq(dfs)
+        return {
+            "Model Summary": export_Model,
+            "Tables": export_Table,
+            "Partitions": export_Part,
+            "Columns": export_Col,
+            "Relationships": export_Rel,
+            "Hierarchies": export_Hier,
+        }
 
     # Export vertipaq to delta tables in lakehouse
     if export in ["table", "zip"]:
@@ -511,22 +530,15 @@ def vertipaq_analyzer(
             )
 
     if export == "table":
-        lakehouse_id = fabric.get_lakehouse_id()
-        lake_workspace = fabric.resolve_workspace_name()
-        lakehouse = resolve_lakehouse_name(
-            lakehouse_id=lakehouse_id, workspace=lake_workspace
-        )
         lakeTName = "vertipaqanalyzer_model"
 
-        lakeT = get_lakehouse_tables(lakehouse=lakehouse, workspace=lake_workspace)
+        lakeT = get_lakehouse_tables()
         lakeT_filt = lakeT[lakeT["Table Name"] == lakeTName]
 
         if len(lakeT_filt) == 0:
             runId = 1
         else:
-            max_run_id = _get_column_aggregate(
-                lakehouse=lakehouse, table_name=lakeTName
-            )
+            max_run_id = _get_column_aggregate(table_name=lakeTName)
             runId = max_run_id + 1
 
         dfMap = {

sempy_labs/_warehouses.py

@@ -1,9 +1,9 @@
-import sempy.fabric as fabric
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
     _update_dataframe_datatypes,
+    delete_item,
 )
 import pandas as pd
 from typing import Optional
@@ -16,7 +16,7 @@ def create_warehouse(
     description: Optional[str] = None,
     case_insensitive_collation: bool = False,
     workspace: Optional[str | UUID] = None,
-):
+) -> UUID:
     """
     Creates a Fabric warehouse.
 
@@ -34,6 +34,11 @@ def create_warehouse(
         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
+    -------
+    uuid.UUID
+        The ID of the created warehouse.
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
@@ -48,7 +53,7 @@ def create_warehouse(
             "defaultCollation"
         ] = "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
 
-    _base_api(
+    response = _base_api(
         request=f"/v1/workspaces/{workspace_id}/warehouses",
         payload=payload,
         method="post",
@@ -60,6 +65,8 @@ def create_warehouse(
         f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace_name}' workspace."
     )
 
+    return response.get("id")
+
 
 def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     """
@@ -67,6 +74,8 @@ def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Warehouses <https://learn.microsoft.com/rest/api/fabric/warehouse/items/list-warehouses>`_.
 
+    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
@@ -93,7 +102,9 @@ def list_warehouses(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}/warehouses", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/warehouses",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -115,7 +126,7 @@ def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
-def delete_warehouse(name: str, workspace: Optional[str | UUID] = None):
+def delete_warehouse(name: str | UUID, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric warehouse.
 
@@ -123,27 +134,15 @@ def delete_warehouse(name: str, workspace: Optional[str | UUID] = None):
 
     Parameters
     ----------
-    name: str
-        Name of the warehouse.
+    name: str | uuid.UUID
+        Name or ID of the warehouse.
     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)
-
-    item_id = fabric.resolve_item_id(
-        item_name=name, type="Warehouse", workspace=workspace_id
-    )
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/warehouses/{item_id}", method="delete"
-    )
-
-    print(
-        f"{icons.green_dot} The '{name}' warehouse within the '{workspace_name}' workspace has been deleted."
-    )
+    delete_item(item=name, type="Warehouse", workspace=workspace)
 
 
 def get_warehouse_tables(

sempy_labs/_workloads.py

@@ -6,9 +6,10 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
 )
+from uuid import UUID
 
 
-def list_workloads(capacity_name: str) -> pd.DataFrame:
+def list_workloads(capacity: str | UUID, **kwargs) -> pd.DataFrame:
     """
     Returns the current state of the specified capacity workloads.
     If a workload is enabled, the percentage of maximum memory that the workload can consume is also returned.
@@ -17,8 +18,8 @@ def list_workloads(capacity_name: str) -> pd.DataFrame:
 
     Parameters
     ----------
-    capacity_name : str
-        The capacity name.
+    capacity : str | uuid.UUID
+        The capacity name or ID.
 
     Returns
     -------
@@ -28,6 +29,12 @@ def list_workloads(capacity_name: str) -> pd.DataFrame:
 
     from sempy_labs._helper_functions import resolve_capacity_id
 
+    if "capacity_name" in kwargs:
+        capacity = kwargs["capacity_name"]
+        print(
+            f"{icons.warning} The 'capacity_name' parameter is deprecated. Please use 'capacity' instead."
+        )
+
     columns = {
         "Workload Name": "string",
         "State": "string",
@@ -35,7 +42,7 @@ def list_workloads(capacity_name: str) -> pd.DataFrame:
     }
     df = _create_dataframe(columns=columns)
 
-    capacity_id = resolve_capacity_id(capacity_name=capacity_name)
+    capacity_id = resolve_capacity_id(capacity=capacity)
 
     response = _base_api(request=f"/v1.0/myorg/capacities/{capacity_id}/Workloads")
 
@@ -53,10 +60,11 @@ def list_workloads(capacity_name: str) -> pd.DataFrame:
 
 
 def patch_workload(
-    capacity_name: str,
+    capacity: str | UUID,
     workload_name: str,
     state: Optional[str] = None,
     max_memory_percentage: Optional[int] = None,
+    **kwargs,
 ):
     """
     Changes the state of a specific workload to Enabled or Disabled.
@@ -66,8 +74,8 @@ def patch_workload(
 
     Parameters
     ----------
-    capacity_name : str
-        The capacity name.
+    capacity : str | uuid.UUID
+        The capacity name or ID.
     workload_name : str
         The workload name.
     state : str, default=None
@@ -78,7 +86,13 @@ def patch_workload(
 
     from sempy_labs._helper_functions import resolve_capacity_id
 
-    capacity_id = resolve_capacity_id(capacity_name=capacity_name)
+    if "capacity_name" in kwargs:
+        capacity = kwargs["capacity_name"]
+        print(
+            f"{icons.warning} The 'capacity_name' parameter is deprecated. Please use 'capacity' instead."
+        )
+
+    capacity_id = resolve_capacity_id(capacity=capacity)
 
     states = ["Disabled", "Enabled", "Unsupported"]
     state = state.capitalize()
@@ -119,5 +133,5 @@ def patch_workload(
     _base_api(request=url, method="patch", payload=payload)
 
     print(
-        f"The '{workload_name}' workload within the '{capacity_name}' capacity has been updated accordingly."
+        f"The '{workload_name}' workload within the '{capacity}' capacity has been updated accordingly."
     )

sempy_labs/_workspace_identity.py

@@ -13,6 +13,8 @@ def provision_workspace_identity(workspace: Optional[str | UUID] = None):
 
     This is a wrapper function for the following API: `Workspaces - Provision Identity <https://learn.microsoft.com/rest/api/fabric/core/workspaces/provision-identity>`_.
 
+    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
@@ -28,6 +30,7 @@ def provision_workspace_identity(workspace: Optional[str | UUID] = None):
         method="post",
         lro_return_status_code=True,
         status_codes=None,
+        client="fabric_sp",
     )
 
     print(
@@ -41,6 +44,8 @@ def deprovision_workspace_identity(workspace: Optional[str | UUID] = None):
 
     This is a wrapper function for the following API: `Workspaces - Derovision Identity <https://learn.microsoft.com/rest/api/fabric/core/workspaces/deprovision-identity>`_.
 
+    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
@@ -56,6 +61,7 @@ def deprovision_workspace_identity(workspace: Optional[str | UUID] = None):
         method="post",
         lro_return_status_code=True,
         status_codes=None,
+        client="fabric_sp",
     )
 
     print(