semantic-link-labs 0.8.0__py3-none-any.whl → 0.8.2__py3-none-any.whl

sempy_labs/_icons.py

@@ -93,3 +93,24 @@ sku_mapping = {
     "P4": "F512",
     "P5": "F1024",
 }
+refreshTypes = [
+    "full",
+    "automatic",
+    "dataOnly",
+    "calculate",
+    "clearValues",
+    "defragment",
+]
+
+itemTypes = {
+    "DataPipeline": "dataPipelines",
+    "Eventstream": "eventstreams",
+    "KQLDatabase": "kqlDatabases",
+    "KQLQueryset": "kqlQuerysets",
+    "Lakehouse": "lakehouses",
+    "MLExperiment": "mlExperiments",
+    "MLModel": "mlModels",
+    "Notebook": "notebooks",
+    "Warehouse": "warehouses",
+}
+default_schema = "dbo"

sempy_labs/_kql_databases.py

@@ -0,0 +1,134 @@
+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,
+)
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def list_kql_databases(workspace: Optional[str] = None) -> pd.DataFrame:
+    """
+    Shows the KQL databases within a workspace.
+
+    Parameters
+    ----------
+    workspace : str, default=None
+        The Fabric workspace name.
+        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 KQL databases within a workspace.
+    """
+
+    df = pd.DataFrame(
+        columns=[
+            "KQL Database Name",
+            "KQL Database Id",
+            "Description",
+            "Parent Eventhouse Item Id",
+            "Query Service URI",
+            "Ingestion Service URI",
+            "Database Type",
+        ]
+    )
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/workspaces/{workspace_id}/kqlDatabases")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    for r in responses:
+        for v in r.get("value", []):
+            prop = v.get("properties", {})
+
+            new_data = {
+                "KQL Database Name": v.get("displayName"),
+                "KQL Database Id": v.get("id"),
+                "Description": v.get("description"),
+                "Parent Eventhouse Item Id": prop.get("parentEventhouseItemId"),
+                "Query Service URI": prop.get("queryServiceUri"),
+                "Ingestion Service URI": prop.get("ingestionServiceUri"),
+                "Database Type": prop.get("databaseType"),
+            }
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def create_kql_database(
+    name: str, description: Optional[str] = None, workspace: Optional[str] = None
+):
+    """
+    Creates a KQL database.
+
+    Parameters
+    ----------
+    name: str
+        Name of the KQL database.
+    description : str, default=None
+        A description of the environment.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    request_body = {"displayName": name}
+
+    if description:
+        request_body["description"] = description
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"/v1/workspaces/{workspace_id}/kqlDatabases", json=request_body
+    )
+
+    lro(client, response, status_codes=[201, 202])
+
+    print(
+        f"{icons.green_dot} The '{name}' KQL database has been created within the '{workspace}' workspace."
+    )
+
+
+def delete_kql_database(name: str, workspace: Optional[str] = None):
+    """
+    Deletes a KQL database.
+
+    Parameters
+    ----------
+    name: str
+        Name of the KQL database.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    kql_database_id = fabric.resolve_item_id(
+        item_name=name, type="KQLDatabase", workspace=workspace
+    )
+
+    client = fabric.FabricRestClient()
+    response = client.delete(
+        f"/v1/workspaces/{workspace_id}/kqlDatabases/{kql_database_id}"
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{name}' KQL database within the '{workspace}' workspace has been deleted."
+    )

sempy_labs/_kql_querysets.py

@@ -0,0 +1,124 @@
+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,
+)
+from sempy.fabric.exceptions import FabricHTTPException
+
+
+def list_kql_querysets(workspace: Optional[str] = None) -> pd.DataFrame:
+    """
+    Shows the KQL querysets within a workspace.
+
+    Parameters
+    ----------
+    workspace : str, default=None
+        The Fabric workspace name.
+        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 KQL querysets within a workspace.
+    """
+
+    df = pd.DataFrame(
+        columns=[
+            "KQL Queryset Name",
+            "KQL Queryset Id",
+            "Description",
+        ]
+    )
+
+    (workspace, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    client = fabric.FabricRestClient()
+    response = client.get(f"/v1/workspaces/{workspace_id}/kqlQuerysets")
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+
+    responses = pagination(client, response)
+
+    for r in responses:
+        for v in r.get("value", []):
+            new_data = {
+                "KQL Queryset Name": v.get("displayName"),
+                "KQL Queryset Id": v.get("id"),
+                "Description": v.get("description"),
+            }
+            df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def create_kql_queryset(
+    name: str, description: Optional[str] = None, workspace: Optional[str] = None
+):
+    """
+    Creates a KQL queryset.
+
+    Parameters
+    ----------
+    name: str
+        Name of the KQL queryset.
+    description : str, default=None
+        A description of the environment.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    request_body = {"displayName": name}
+
+    if description:
+        request_body["description"] = description
+
+    client = fabric.FabricRestClient()
+    response = client.post(
+        f"/v1/workspaces/{workspace_id}/kqlQuerysets", json=request_body
+    )
+
+    lro(client, response, status_codes=[201, 202])
+
+    print(
+        f"{icons.green_dot} The '{name}' KQL queryset has been created within the '{workspace}' workspace."
+    )
+
+
+def delete_kql_queryset(name: str, workspace: Optional[str] = None):
+    """
+    Deletes a KQL queryset.
+
+    Parameters
+    ----------
+    name: str
+        Name of the KQL queryset.
+    workspace : str, default=None
+        The Fabric workspace name.
+        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, workspace_id) = resolve_workspace_name_and_id(workspace)
+    kql_database_id = fabric.resolve_item_id(
+        item_name=name, type="KQLQueryset", workspace=workspace
+    )
+
+    client = fabric.FabricRestClient()
+    response = client.delete(
+        f"/v1/workspaces/{workspace_id}/kqlQuerysets/{kql_database_id}"
+    )
+
+    if response.status_code != 200:
+        raise FabricHTTPException(response)
+    print(
+        f"{icons.green_dot} The '{name}' KQL queryset within the '{workspace}' workspace has been deleted."
+    )