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

sempy_labs/_delta_analyzer.py

@@ -52,6 +52,7 @@ def delta_analyzer(
     workspace: Optional[str | UUID] = None,
     column_stats: bool = True,
     skip_cardinality: bool = True,
+    schema: Optional[str] = None,
 ) -> Dict[str, pd.DataFrame]:
     """
     Analyzes a delta table and shows the results in dictionary containing a set of 5 dataframes. If 'export' is set to True, the results will be saved to delta tables in the lakehouse attached to the notebook.
@@ -85,6 +86,8 @@ def delta_analyzer(
         If True, collects data about column chunks and columns. If False, skips that step and only returns the other 3 dataframes.
     skip_cardinality : bool, default=True
         If True, skips the cardinality calculation for each column. If False, calculates the cardinality for each column.
+    schema : str, default=None
+        The name of the schema to which the table belongs (for schema-enabled lakehouses). If None, the default schema is used.
 
     Returns
     -------
@@ -96,25 +99,21 @@ def delta_analyzer(
     if not skip_cardinality:
         column_stats = True
 
-    # display_toggle = notebookutils.common.configs.pandas_display
-
-    # Turn off notebookutils display
-    # if display_toggle is True:
-    #    notebookutils.common.configs.pandas_display = False
-
     prefix = "SLL_DeltaAnalyzer_"
     now = datetime.now()
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace=workspace)
     (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
         lakehouse=lakehouse, workspace=workspace
     )
-    path = create_abfss_path(lakehouse_id, workspace_id, table_name)
-    local_path = _mount(lakehouse=lakehouse, workspace=workspace)
-    table_path = f"{local_path}/Tables/{table_name}"
-    delta_table_path = create_abfss_path(lakehouse_id, workspace_id, table_name)
 
-    # Set back to original value
-    # notebookutils.common.configs.pandas_display = display_toggle
+    delta_table_path = create_abfss_path(
+        lakehouse_id, workspace_id, table_name, schema=schema
+    )
+    local_path = _mount(lakehouse=lakehouse, workspace=workspace)
+    if schema is not None:
+        table_path = f"{local_path}/Tables/{schema}/{table_name}"
+    else:
+        table_path = f"{local_path}/Tables/{table_name}"
 
     parquet_file_df_columns = {
         # "Dataset": "string",
@@ -183,7 +182,7 @@ def delta_analyzer(
     # min_reader_version = table_details.get("minReaderVersion")
     # min_writer_version = table_details.get("minWriterVersion")
 
-    latest_files = _read_delta_table(path).inputFiles()
+    latest_files = _read_delta_table(delta_table_path).inputFiles()
     # file_paths = [f.split("/")[-1] for f in latest_files]
     all_parquet_files = get_parquet_file_infos(delta_table_path)
     common_file_paths = set(
@@ -430,6 +429,7 @@ def get_delta_table_history(
     table_name: str,
     lakehouse: Optional[str | UUID] = None,
     workspace: Optional[str | UUID] = None,
+    schema: Optional[str] = None,
 ) -> pd.DataFrame:
     """
     Returns the history of a delta table as a pandas dataframe.
@@ -445,6 +445,8 @@ def get_delta_table_history(
         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.
+    schema : str, default=None
+        The name of the schema to which the table belongs (for schema-enabled lakehouses). If None, the default schema is used.
 
     Returns
     -------
@@ -461,7 +463,7 @@ def get_delta_table_history(
     (lakehouse_name, lakehouse_id) = resolve_lakehouse_name_and_id(
         lakehouse=lakehouse, workspace=workspace
     )
-    path = create_abfss_path(lakehouse_id, workspace_id, table_name)
+    path = create_abfss_path(lakehouse_id, workspace_id, table_name, schema)
 
     from delta import DeltaTable
 

sempy_labs/_environments.py

@@ -4,8 +4,10 @@ from typing import Optional
 from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
-    _print_success,
     _create_dataframe,
+    resolve_item_id,
+    delete_item,
+    create_item,
 )
 from uuid import UUID
 
@@ -32,25 +34,11 @@ def create_environment(
         or if no lakehouse attached, resolves to the workspace of the notebook.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-
-    payload = {"displayName": environment}
-
-    if description:
-        payload["description"] = description
-
-    _base_api(
-        request="/v1/workspaces/{workspace_id}/environments",
-        method="post",
-        payload=payload,
-        status_codes=[201, 202],
-        lro_return_status_code=True,
-    )
-    _print_success(
-        item_name=environment,
-        item_type="environment",
-        workspace_name=workspace_name,
-        action="created",
+    create_item(
+        name=environment,
+        description=description,
+        type="Environment",
+        workspace=workspace,
     )
 
 
@@ -60,6 +48,8 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Environments <https://learn.microsoft.com/rest/api/fabric/environment/items/list-environments>`_.
 
+    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
@@ -83,7 +73,9 @@ def list_environments(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}/environments", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/environments",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -98,7 +90,7 @@ def list_environments(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
     return df
 
 
-def delete_environment(environment: str, workspace: Optional[str | UUID] = None):
+def delete_environment(environment: str | UUID, workspace: Optional[str | UUID] = None):
     """
     Deletes a Fabric environment.
 
@@ -106,61 +98,48 @@ def delete_environment(environment: str, workspace: Optional[str | UUID] = None)
 
     Parameters
     ----------
-    environment: str
-        Name of the environment.
+    environment: str | uuid.UUID
+        Name or ID of the environment.
     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.
     """
 
-    from sempy_labs._helper_functions import resolve_environment_id
-
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace_id
-    )
-
-    _base_api(
-        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}",
-        method="delete",
-    )
-    _print_success(
-        item_name=environment,
-        item_type="environment",
-        workspace_name=workspace_name,
-        action="deleted",
-    )
+    delete_item(item=environment, type="Environment", workspace=workspace)
 
 
-def publish_environment(environment: str, workspace: Optional[str | UUID] = None):
+def publish_environment(
+    environment: str | UUID, workspace: Optional[str | UUID] = None
+):
     """
     Publishes a Fabric environment.
 
     This is a wrapper function for the following API: `Spark Libraries - Publish Environment <https://learn.microsoft.com/rest/api/fabric/environment/spark-libraries/publish-environment>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
-    environment: str
-        Name of the environment.
+    environment: str | uuid.UUID
+        Name or ID of the environment.
     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.
     """
 
-    from sempy_labs._helper_functions import resolve_environment_id
-
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    environment_id = resolve_environment_id(
-        environment=environment, workspace=workspace_id
+    item_id = resolve_item_id(
+        item=environment, type="Environment", workspace=workspace_id
     )
 
     _base_api(
-        request=f"/v1/workspaces/{workspace_id}/environments/{environment_id}/staging/publish",
+        request=f"/v1/workspaces/{workspace_id}/environments/{item_id}/staging/publish",
         method="post",
         lro_return_status_code=True,
         status_codes=None,
+        client="fabric_sp",
     )
 
     print(

sempy_labs/_eventhouses.py

@@ -1,14 +1,15 @@
-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
@@ -39,18 +40,11 @@ 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
-
-    if definition is not None:
-        if not isinstance(definition, dict):
-            raise ValueError(f"{icons.red_dot} The definition must be a dictionary.")
+    if definition is not None and not isinstance(definition, dict):
+        raise ValueError(f"{icons.red_dot} The definition must be a dictionary.")
 
-        payload["definition"] = {
+    definition_payload = (
+        {
             "parts": [
                 {
                     "path": "EventhouseProperties.json",
@@ -59,19 +53,16 @@ def create_eventhouse(
                 }
             ]
         }
-
-    _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
+        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,
     )
 
 
@@ -81,6 +72,8 @@ def list_eventhouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
 
     This is a wrapper function for the following API: `Items - List Eventhouses <https://learn.microsoft.com/rest/api/fabric/environment/items/list-eventhouses>`_.
 
+    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
@@ -104,7 +97,9 @@ def list_eventhouses(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}/eventhouses", uses_pagination=True
+        request=f"/v1/workspaces/{workspace_id}/eventhouses",
+        uses_pagination=True,
+        client="fabric_sp",
     )
 
     for r in responses:
@@ -135,16 +130,7 @@ 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(
@@ -174,21 +160,9 @@ def get_eventhouse_definition(
         The eventhouse definition in .json format or as a pandas dataframe.
     """
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = resolve_item_id(item=eventhouse, type="Eventhouse", workspace=workspace)
-
-    result = _base_api(
-        request=f"/v1/workspaces/{workspace_id}/eventhouses/{item_id}/getDefinition",
-        method="post",
-        status_codes=None,
-        lro_return_json=True,
+    return get_item_definition(
+        item=eventhouse,
+        type="Eventhouse",
+        workspace=workspace,
+        return_dataframe=return_dataframe,
     )
-
-    df = pd.json_normalize(result["definition"]["parts"])
-
-    if return_dataframe:
-        return df
-    else:
-        df_filt = df[df["path"] == "EventhouseProperties.json"]
-        payload = df_filt["payload"].iloc[0]
-        return _decode_b64(payload)

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/_external_data_shares.py

@@ -1,4 +1,3 @@
-import sempy.fabric as fabric
 from uuid import UUID
 import pandas as pd
 from typing import Optional, List
@@ -7,6 +6,7 @@ from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _base_api,
     _create_dataframe,
+    resolve_item_id,
 )
 
 
@@ -39,9 +39,7 @@ def create_external_data_share(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     if isinstance(paths, str):
         paths = [paths]
@@ -85,9 +83,7 @@ def revoke_external_data_share(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     _base_api(
         request=f"/v1/workspaces/{workspace_id}/items/{item_id}/externalDataShares/{external_data_share_id}/revoke",
@@ -124,9 +120,7 @@ def list_external_data_shares_in_item(
     """
 
     (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
-    item_id = fabric.resolve_item_id(
-        item_name=item_name, type=item_type, workspace=workspace_id
-    )
+    item_id = resolve_item_id(item=item_name, type=item_type, workspace=workspace_id)
 
     columns = {
         "External Data Share Id": "string",

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,13 +5,13 @@ 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,
+    resolve_workspace_id,
 )
 from sempy_labs.lakehouse._lakehouse import lakehouse_attached
 import sempy_labs._icons as icons
@@ -286,7 +286,7 @@ def deploy_semantic_model(
 
     if target_workspace is None:
         target_workspace_name = source_workspace_name
-        target_workspace_id = fabric.resolve_workspace_id(target_workspace_name)
+        target_workspace_id = resolve_workspace_id(workspace=target_workspace_name)
     else:
         (target_workspace_name, target_workspace_id) = resolve_workspace_name_and_id(
             target_workspace

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."
+    )