semantic-link-labs 0.9.3__py3-none-any.whl → 0.9.5__py3-none-any.whl

sempy_labs/_eventhouses.py

@@ -1,18 +1,25 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
     resolve_item_id,
     _create_dataframe,
+    _conv_b64,
+    _decode_b64,
+    delete_item,
+    create_item,
+    get_item_definition,
 )
 from uuid import UUID
+import sempy_labs._icons as icons
 
 
 def create_eventhouse(
-    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
+    name: str,
+    definition: Optional[dict],
+    description: Optional[str] = None,
+    workspace: Optional[str | UUID] = None,
 ):
     """
     Creates a Fabric eventhouse.
@@ -23,6 +30,8 @@ def create_eventhouse(
     ----------
     name: str
         Name of the eventhouse.
+    definition : dict
+        The definition (EventhouseProperties.json) of the eventhouse.
     description : str, default=None
         A description of the environment.
     workspace : str | uuid.UUID, default=None
@@ -31,25 +40,29 @@ def create_eventhouse(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventhouses",
-        method="post",
-        status_codes=[201, 202],
-        payload=payload,
-        lro_return_status_code=True,
+    if definition is not None and not isinstance(definition, dict):
+        raise ValueError(f"{icons.red_dot} The definition must be a dictionary.")
+
+    definition_payload = (
+        {
+            "parts": [
+                {
+                    "path": "EventhouseProperties.json",
+                    "payload": _conv_b64(definition),
+                    "payloadType": "InlineBase64",
+                }
+            ]
+        }
+        if definition is not None
+        else None
     )
-    _print_success(
-        item_name=name,
-        item_type="eventhouse",
-        workspace_name=workspace_name,
-        action="created",
+
+    create_item(
+        name=name,
+        type="Eventhouse",
+        workspace=workspace,
+        description=description,
+        definition=definition_payload,
     )
 
 
@@ -113,13 +126,39 @@ def delete_eventhouse(name: str, workspace: Optional[str | UUID] = None):
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = resolve_item_id(item=name, type="Eventhouse", workspace=workspace)
-
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name,
-        item_type="eventhouse",
-        workspace_name=workspace_name,
-        action="deleted",
+    delete_item(item=name, type="Eventhouse", workspace=workspace)
+
+
+def get_eventhouse_definition(
+    eventhouse: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    return_dataframe: bool = False,
+) -> dict | pd.DataFrame:
+    """
+    Gets the eventhouse definition.
+
+    This is a wrapper function for the following API: `Items - Get Eventhouse Definition <https://learn.microsoft.com/rest/api/fabric/eventhouse/items/get-eventhouse-definition>`_.
+
+    Parameters
+    ----------
+    eventhouse : str
+        Name of the eventhouse.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID in which the eventhouse resides.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    return_dataframe : bool, default=False
+        If True, returns a dataframe. If False, returns a json dictionary.
+
+    Returns
+    -------
+    dict | pandas.DataFrame
+        The eventhouse definition in .json format or as a pandas dataframe.
+    """
+
+    return get_item_definition(
+        item=eventhouse,
+        type="Eventhouse",
+        workspace=workspace,
+        return_dataframe=return_dataframe,
     )

sempy_labs/_eventstreams.py

@@ -1,14 +1,14 @@
-import sempy.fabric as fabric
 import pandas as pd
 from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
-    resolve_item_id,
+    delete_item,
     _create_dataframe,
+    create_item,
 )
 from uuid import UUID
+import sempy_labs._icons as icons
 
 
 def list_eventstreams(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
@@ -74,29 +74,14 @@ def create_eventstream(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventstreams",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="eventstream",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="Eventstream", workspace=workspace
     )
 
 
-def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None):
+def delete_eventstream(
+    eventstream: str | UUID, workspace: Optional[str | UUID] = None, **kwargs
+):
     """
     Deletes a Fabric eventstream.
 
@@ -104,7 +89,7 @@ def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None)
 
     Parameters
     ----------
-    name: str | uuid.UUID
+    eventstream: str | uuid.UUID
         Name or ID of the eventstream.
     workspace : str | uuid.UUID, default=None
         The Fabric workspace name or ID.
@@ -112,13 +97,10 @@ def delete_eventstream(name: str | UUID, workspace: Optional[str | UUID] = None)
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = resolve_item_id(item=name, type="Eventstream", workspace=workspace)
-
-    fabric.delete_item(item_id=item_id, workspace=workspace)
-    _print_success(
-        item_name=name,
-        item_type="eventstream",
-        workspace_name=workspace_name,
-        action="deleted",
-    )
+    if "name" in kwargs:
+        eventstream = kwargs["name"]
+        print(
+            f"{icons.warning} The 'name' parameter is deprecated. Please use 'eventstream' instead."
+        )
+
+    delete_item(item=eventstream, type="Eventstream", workspace=workspace)

sempy_labs/_gateways.py

@@ -314,7 +314,7 @@ def create_vnet_gateway(
         The name of the subnet.
     """
 
-    capacity_id = resolve_capacity_id(capacity)
+    capacity_id = resolve_capacity_id(capacity=capacity)
     payload = {
         "type": "VirtualNetwork",
         "displayName": name,
@@ -343,7 +343,7 @@ def create_vnet_gateway(
 
 
 def update_on_premises_gateway(
-    gateway: str,
+    gateway: str | UUID,
     allow_cloud_connection_refresh: Optional[bool] = None,
     allow_custom_connectors: Optional[bool] = None,
     load_balancing_setting: Optional[str] = None,
@@ -396,7 +396,7 @@ def update_on_premises_gateway(
 
 
 def update_vnet_gateway(
-    gateway: str,
+    gateway: str | UUID,
     capacity: str | UUID,
     inactivity_minutes_before_sleep: Optional[int] = None,
     number_of_member_gateways: Optional[int] = None,
@@ -425,7 +425,7 @@ def update_vnet_gateway(
     payload = {}
 
     if capacity is not None:
-        capacity_id = resolve_capacity_id(capacity)
+        capacity_id = resolve_capacity_id(capacity=capacity)
         payload["capacityId"] = capacity_id
     if inactivity_minutes_before_sleep is not None:
         payload["inactivityMinutesBeforeSleep"] = inactivity_minutes_before_sleep

sempy_labs/_generate_semantic_model.py

@@ -5,12 +5,12 @@ import os
 from typing import Optional, List
 from sempy._utils._log import log
 from sempy_labs._helper_functions import (
-    resolve_lakehouse_name,
     resolve_workspace_name_and_id,
     resolve_dataset_name_and_id,
     _conv_b64,
     _decode_b64,
     _base_api,
+    _mount,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
@@ -252,6 +252,7 @@ def deploy_semantic_model(
     target_workspace: Optional[str | UUID] = None,
     refresh_target_dataset: bool = True,
     overwrite: bool = False,
+    perspective: Optional[str] = None,
 ):
     """
     Deploys a semantic model based on an existing semantic model.
@@ -274,6 +275,8 @@ def deploy_semantic_model(
         If set to True, this will initiate a full refresh of the target semantic model in the target workspace.
     overwrite : bool, default=False
         If set to True, overwrites the existing semantic model in the workspace if it exists.
+    perspective : str, default=None
+        Set this to the name of a perspective in the model and it will reduce the deployed model down to the tables/columns/measures/hierarchies within that perspective.
     """
 
     (source_workspace_name, source_workspace_id) = resolve_workspace_name_and_id(
@@ -307,7 +310,21 @@ def deploy_semantic_model(
             f"{icons.warning} The '{target_dataset}' semantic model already exists within the '{target_workspace_name}' workspace. The 'overwrite' parameter is set to False so the source semantic model was not deployed to the target destination."
         )
 
-    bim = get_semantic_model_bim(dataset=source_dataset, workspace=source_workspace_id)
+    if perspective is not None:
+
+        from sempy_labs.tom import connect_semantic_model
+
+        with connect_semantic_model(
+            dataset=source_dataset, workspace=source_workspace, readonly=True
+        ) as tom:
+
+            df_added = tom._reduce_model(perspective_name=perspective)
+            bim = tom.get_bim()
+
+    else:
+        bim = get_semantic_model_bim(
+            dataset=source_dataset, workspace=source_workspace_id
+        )
 
     # Create the semantic model if the model does not exist
     if dfD_filt.empty:
@@ -325,6 +342,9 @@ def deploy_semantic_model(
     if refresh_target_dataset:
         refresh_semantic_model(dataset=target_dataset, workspace=target_workspace_id)
 
+    if perspective is not None:
+        return df_added
+
 
 @log
 def get_semantic_model_bim(
@@ -368,16 +388,16 @@ def get_semantic_model_bim(
                 f"{icons.red_dot} In order to save the model.bim file, a lakehouse must be attached to the notebook. Please attach a lakehouse to this notebook."
             )
 
-        lakehouse = resolve_lakehouse_name()
-        folderPath = "/lakehouse/default/Files"
-        fileExt = ".bim"
-        if not save_to_file_name.endswith(fileExt):
-            save_to_file_name = f"{save_to_file_name}{fileExt}"
-        filePath = os.path.join(folderPath, save_to_file_name)
-        with open(filePath, "w") as json_file:
+        local_path = _mount()
+        save_folder = f"{local_path}/Files"
+        file_ext = ".bim"
+        if not save_to_file_name.endswith(file_ext):
+            save_to_file_name = f"{save_to_file_name}{file_ext}"
+        file_path = os.path.join(save_folder, save_to_file_name)
+        with open(file_path, "w") as json_file:
             json.dump(bimJson, json_file, indent=4)
         print(
-            f"{icons.green_dot} The {fileExt} file for the '{dataset_name}' semantic model has been saved to the '{lakehouse}' in this location: '{filePath}'.\n\n"
+            f"{icons.green_dot} The {file_ext} file for the '{dataset_name}' semantic model has been saved to the lakehouse attached to the notebook within: 'Files/{save_to_file_name}'.\n\n"
         )
 
     return bimJson

sempy_labs/_git.py

@@ -4,6 +4,7 @@ from typing import Optional, List
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
+    _create_dataframe,
 )
 from uuid import UUID
 
@@ -126,7 +127,7 @@ def connect_workspace_to_github(
 
 def disconnect_workspace_from_git(workspace: Optional[str | UUID] = None):
     """
-    Disconnects a workpsace from a git repository.
+    Disconnects a workspace from a git repository.
 
     This is a wrapper function for the following API: `Git - Disconnect <https://learn.microsoft.com/rest/api/fabric/core/git/disconnect>`_.
 
@@ -432,3 +433,91 @@ def update_from_git(
     print(
         f"{icons.green_dot} The '{workspace_name}' workspace has been updated with commits pushed to the connected branch."
     )
+
+
+def get_my_git_credentials(
+    workspace: Optional[str | UUID] = None,
+) -> pd.DataFrame:
+    """
+    Returns the user's Git credentials configuration details.
+
+    This is a wrapper function for the following API: `Git - Get My Git Credentials <https://learn.microsoft.com/rest/api/fabric/core/git/get-my-git-credentials>`_.
+
+    Parameters
+    ----------
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the user's Git credentials configuration details.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+
+    columns = {
+        "Source": "string",
+    }
+
+    df = _create_dataframe(columns)
+
+    response = _base_api(request=f"/v1/workspaces/{workspace_id}/git/myGitCredentials")
+
+    r = response.json()
+    new_data = {
+        "Source": r.get("source"),
+        "Connection Id": r.get("connectionId"),
+    }
+    df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+
+    return df
+
+
+def update_my_git_credentials(
+    source: str,
+    connection_id: Optional[UUID] = None,
+    workspace: Optional[str | UUID] = None,
+):
+    """
+    Updates the user's Git credentials configuration details.
+
+    This is a wrapper function for the following API: `Git - Update My Git Credentials <https://learn.microsoft.com/rest/api/fabric/core/git/update-my-git-credentials>`_.
+
+    Parameters
+    ----------
+    source : str
+        The Git credentials source. Valid options: 'Automatic', 'ConfiguredConnection', 'None'.
+    connection_id : UUID, default=None
+        The object ID of the connection. Valid only for the 'ConfiguredConnection' source.
+    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)
+
+    if source == "ConfiguredConnection" and connection_id is None:
+        raise ValueError(
+            f"{icons.red_dot} The 'ConfiguredConnection' source requires a connection_id."
+        )
+
+    payload = {
+        "source": source,
+    }
+
+    if connection_id is not None:
+        payload["connectionId"] = connection_id
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/git/myGitCredentials",
+        method="patch",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The user's Git credentials have been updated accordingly."
+    )

sempy_labs/_graphQL.py

@@ -5,7 +5,7 @@ from sempy_labs._helper_functions import (
     _base_api,
     _create_dataframe,
     resolve_workspace_name_and_id,
-    _print_success,
+    create_item,
 )
 
 
@@ -73,23 +73,6 @@ def create_graphql_api(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": name}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/GraphQLApis",
-        method="post",
-        status_codes=[201, 202],
-        payload=payload,
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=name,
-        item_type="GraphQL API",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=name, description=description, type="GraphQLApi", workspace=workspace
     )