semantic-link-labs 0.12.8__py3-none-any.whl

sempy_labs/variable_library/__init__.py

@@ -0,0 +1,19 @@
+from ._functions import (
+    get_variable_library,
+    list_variables,
+    list_variable_libraries,
+    delete_variable_library,
+    get_variable_library_definition,
+    get_variable_values,
+    get_variable_value,
+)
+
+__all__ = [
+    "get_variable_library",
+    "list_variables",
+    "list_variable_libraries",
+    "delete_variable_library",
+    "get_variable_library_definition",
+    "get_variable_values",
+    "get_variable_value",
+]

sempy_labs/variable_library/_functions.py

@@ -0,0 +1,403 @@
+from sempy_labs._helper_functions import (
+    resolve_item_id,
+    resolve_workspace_id,
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    delete_item,
+    _decode_b64,
+)
+import pandas as pd
+from typing import Any, Optional, List, Union
+from uuid import UUID
+from sempy._utils._log import log
+import json
+import sempy_labs._icons as icons
+
+
+@log
+def get_variable_library(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Returns properties of the specified variable library.
+
+    This is a wrapper function for the following API: `Items - Get Variable Library <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/get-variable-library>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the properties of the variable library.
+    """
+
+    columns = {
+        "Variable Library Name": "string",
+        "Variable Library Id": "string",
+        "Description": "string",
+        "Active Value Set Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+    variable_library_id = resolve_item_id(
+        item=variable_library, type="VariableLibrary", workspace=workspace
+    )
+
+    response = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/variableLibraries/{variable_library_id}",
+        client="fabric_sp",
+    )
+
+    result = response.json()
+    prop = result.get("properties", {})
+
+    if prop:
+        df = pd.DataFrame(
+            [
+                {
+                    "Variable Library Name": result.get("displayName"),
+                    "Variable Library Id": result.get("id"),
+                    "Description": result.get("description"),
+                    "Active Value Set Name": prop.get("activeValueSetName"),
+                }
+            ],
+            columns=list(columns.keys()),
+        )
+
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def list_variable_libraries(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the variable libraries within a workspace.
+
+    This is a wrapper function for the following API: `Items - List Variable Libraries <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/list-variable-libraries>`_.
+
+    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
+        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
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the variable libraries within a workspace.
+    """
+
+    columns = {
+        "Variable Library Name": "string",
+        "Variable Library Id": "string",
+        "Description": "string",
+        "Active Value Set Name": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/VariableLibraries",
+        uses_pagination=True,
+        client="fabric_sp",
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            prop = v.get("properties", {})
+
+            rows.append(
+                {
+                    "Variable Library Name": v.get("displayName"),
+                    "Variable Library Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Active Value Set Name": prop.get("activeValueSetName"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def delete_variable_library(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Deletes a variable library.
+
+    This is a wrapper function for the following API: `Items - Delete Variable Library https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/delete-variable-library>`_.
+
+    Parameters
+    ----------
+    navariable_libraryme: str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    """
+
+    delete_item(item=variable_library, type="VariableLibrary", workspace=workspace)
+
+
+@log
+def get_variable_library_definition(
+    variable_library: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    decode: bool = True,
+    return_dataframe: bool = False,
+) -> dict | pd.DataFrame:
+    """
+    Gets the definition of a variable library.
+
+    This is a wrapper function for the following API: `Items - Get Variable Library Definition <https://learn.microsoft.com/rest/api/fabric/variablelibrary/items/delete-variable-library>`_.
+
+    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
+        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
+    -------
+    dict | pandas.DataFrame
+        A dictionary showing the definition or a pandas dataframe showing the definition.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    variable_library_id = resolve_item_id(
+        item=variable_library, type="VariableLibrary", workspace=workspace
+    )
+
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/variableLibraries/{variable_library_id}/getDefinition",
+        method="post",
+        client="fabric_sp",
+        status_codes=None,
+        lro_return_json=True,
+    )
+
+    if decode:
+        definition = {"definition": {"parts": []}}
+
+        for part in result.get("definition", {}).get("parts", []):
+            path = part.get("path")
+            payload = _decode_b64(part.get("payload"))
+            definition["definition"]["parts"].append({"path": path, "payload": payload})
+    else:
+        definition = result.copy()
+
+    if return_dataframe:
+        df = pd.DataFrame(definition["definition"]["parts"])
+        df.columns = ["Path", "Payload", "Payload Type"]
+        return df
+    else:
+        return definition
+
+
+@log
+def list_variables(
+    variable_library: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Lists the variables in a variable library.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the variables within a variable library.
+    """
+
+    result = get_variable_library_definition(
+        variable_library=variable_library,
+        workspace=workspace,
+        decode=True,
+        return_dataframe=False,
+    )
+
+    columns = {
+        "Variable Name": "string",
+        "Note": "string",
+        "Type": "string",
+        "Value": "string",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for part in result.get("definition").get("parts"):
+        path = part.get("path")
+        payload = json.loads(part.get("payload"))
+        if path == "variables.json":
+
+            for variable in payload.get("variables", []):
+                rows.append(
+                    {
+                        "Variable Name": variable.get("name"),
+                        "Note": variable.get("note"),
+                        "Type": variable.get("type"),
+                        "Value": variable.get("value"),
+                    }
+                )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    for part in result.get("definition", {}).get("parts", []):
+        path = part.get("path")
+        if path.startswith("valueSets") and path.endswith(".json"):
+            payload = json.loads(part.get("payload"))
+            value_set_name = payload.get("name")
+
+            # Initialize the new column with None (or pd.NA)
+            df[value_set_name] = None
+
+            for override in payload.get("variableOverrides", []):
+                variable_name = override.get("name")
+                variable_value = override.get("value")
+
+                # Set the value in the appropriate row and column
+                df.loc[df["Variable Name"] == variable_name, value_set_name] = (
+                    variable_value
+                )
+
+    return df
+
+
+@log
+def get_variable_values(
+    variable_names: List[str],
+    variable_library: Union[str, UUID],
+    workspace: Optional[Union[str, UUID]] = None,
+    value_set: Optional[str] = None,
+) -> dict:
+    """
+    Gets the values of multiple variables from a variable library with a single call to list_variables.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_names : List[str]
+        A list of variable names to retrieve.
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    value_set : str, default=None
+        The name of the value set to use for variable overrides.
+        If None, the active value set of the variable library will be used.
+
+    Returns
+    -------
+    dict
+        Dictionary mapping variable names to their corresponding values.
+    """
+
+    if isinstance(variable_names, str):
+        variable_names = [variable_names]
+
+    if value_set is None:
+        vl_df = get_variable_library(
+            variable_library=variable_library, workspace=workspace
+        )
+        if vl_df.empty:
+            raise ValueError(
+                f"{icons.red_dot} The variable library '{variable_library}' does not exist within the '{workspace}' workspace."
+            )
+        value_set = vl_df["Active Value Set Name"].iloc[0]
+
+    df = list_variables(variable_library=variable_library, workspace=workspace)
+    found_variables = df[df["Variable Name"].isin(variable_names)]
+
+    missing = set(variable_names) - set(found_variables["Variable Name"])
+    if missing:
+        raise ValueError(
+            f"{icons.red_dot} The following variables do not exist in the '{variable_library}' variable library: {', '.join(missing)}"
+        )
+
+    if value_set == "Default value set":
+        value_set = "Value"
+    if value_set not in df.columns:
+        raise ValueError(
+            f"{icons.red_dot} The value set '{value_set}' does not exist in the variable library '{variable_library}' within the '{workspace}' workspace."
+        )
+
+    return dict(zip(found_variables["Variable Name"], found_variables[value_set]))
+
+
+@log
+def get_variable_value(
+    variable_name: str,
+    variable_library: str | UUID,
+    workspace: Optional[str | UUID] = None,
+    value_set: Optional[str] = None,
+) -> Any:
+    """
+    Gets the value of a single variable in a variable library.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    variable_name : str
+        Name of the variable.
+    variable_library : str | uuid.UUID
+        Name or ID of the variable library.
+    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.
+    value_set : str, default=None
+        The name of the value set to use for variable overrides.
+        If None, the active value set of the variable library will be used.
+
+    Returns
+    -------
+    Any
+        The value of the variable.
+    """
+
+    return get_variable_values(
+        variable_names=[variable_name],
+        variable_library=variable_library,
+        workspace=workspace,
+        value_set=value_set,
+    )[variable_name]

sempy_labs/warehouse/__init__.py

@@ -0,0 +1,28 @@
+from ._restore_points import (
+    create_restore_point,
+    delete_restore_point,
+    list_restore_points,
+    update_restore_point,
+    restore_to_restore_point,
+)
+from ._items import (
+    create_warehouse,
+    delete_warehouse,
+    get_warehouse_tables,
+    get_warehouse_columns,
+    list_warehouses,
+)
+
+
+__all__ = [
+    "create_restore_point",
+    "delete_restore_point",
+    "list_restore_points",
+    "update_restore_point",
+    "restore_to_restore_point",
+    "create_warehouse",
+    "delete_warehouse",
+    "get_warehouse_tables",
+    "get_warehouse_columns",
+    "list_warehouses",
+]

sempy_labs/warehouse/_items.py

@@ -0,0 +1,234 @@
+from sempy_labs._helper_functions import (
+    resolve_workspace_name_and_id,
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    delete_item,
+    resolve_workspace_id,
+)
+import pandas as pd
+from typing import Optional
+import sempy_labs._icons as icons
+from uuid import UUID
+from sempy._utils._log import log
+
+
+@log
+def create_warehouse(
+    warehouse: str,
+    description: Optional[str] = None,
+    case_insensitive_collation: bool = False,
+    workspace: Optional[str | UUID] = None,
+) -> UUID:
+    """
+    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>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    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.
+
+    Returns
+    -------
+    uuid.UUID
+        The ID of the created warehouse.
+    """
+
+    (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"
+
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/warehouses",
+        payload=payload,
+        method="post",
+        lro_return_json=True,
+        status_codes=[201, 202],
+        client="fabric_sp",
+    )
+
+    print(
+        f"{icons.green_dot} The '{warehouse}' warehouse has been created within the '{workspace_name}' workspace."
+    )
+
+    return result.get("id")
+
+
+@log
+def list_warehouses(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the warehouses within a workspace.
+
+    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
+        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
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the warehouses within a workspace.
+    """
+
+    columns = {
+        "Warehouse Name": "string",
+        "Warehouse Id": "string",
+        "Description": "string",
+        "Connection Info": "string",
+        "Created Date": "datetime",
+        "Last Updated Time": "datetime",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/warehouses",
+        uses_pagination=True,
+        client="fabric_sp",
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            prop = v.get("properties", {})
+
+            rows.append(
+                {
+                    "Warehouse Name": v.get("displayName"),
+                    "Warehouse Id": v.get("id"),
+                    "Description": v.get("description"),
+                    "Connection Info": prop.get("connectionInfo"),
+                    "Created Date": prop.get("createdDate"),
+                    "Last Updated Time": prop.get("lastUpdatedTime"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def delete_warehouse(name: str | UUID, 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>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    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.
+    """
+
+    delete_item(item=name, type="Warehouse", workspace=workspace)
+
+
+@log
+def get_warehouse_tables(
+    warehouse: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Shows a list of the tables in the Fabric warehouse. This function is based on INFORMATION_SCHEMA.TABLES.
+
+    Parameters
+    ----------
+    warehouse : str | uuid.UUID
+        Name or ID of the Fabric 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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of the tables in the Fabric warehouse.
+    """
+
+    from sempy_labs._sql import ConnectWarehouse
+
+    with ConnectWarehouse(warehouse=warehouse, workspace=workspace) as sql:
+        df = sql.query(
+            """
+        SELECT TABLE_SCHEMA AS [Schema], TABLE_NAME AS [Table Name], TABLE_TYPE AS [Table Type]
+        FROM INFORMATION_SCHEMA.TABLES
+        WHERE TABLE_TYPE = 'BASE TABLE'
+        """
+        )
+
+    return df
+
+
+@log
+def get_warehouse_columns(
+    warehouse: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Shows a list of the columns in each table within the Fabric warehouse. This function is based on INFORMATION_SCHEMA.COLUMNS.
+
+    Parameters
+    ----------
+    warehouse : str | uuid.UUID
+        Name or ID of the Fabric 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.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of the columns in each table within the Fabric warehouse.
+    """
+
+    from sempy_labs._sql import ConnectWarehouse
+
+    with ConnectWarehouse(warehouse=warehouse, workspace=workspace) as sql:
+        df = sql.query(
+            """
+        SELECT t.TABLE_SCHEMA AS [Schema], t.TABLE_NAME AS [Table Name], c.COLUMN_NAME AS [Column Name], c.DATA_TYPE AS [Data Type], c.IS_NULLABLE AS [Is Nullable], c.CHARACTER_MAXIMUM_LENGTH AS [Character Max Length]
+        FROM INFORMATION_SCHEMA.TABLES AS t
+        LEFT JOIN INFORMATION_SCHEMA.COLUMNS AS c
+        ON t.TABLE_NAME = c.TABLE_NAME
+        AND t.TABLE_SCHEMA = c.TABLE_SCHEMA
+        WHERE t.TABLE_TYPE = 'BASE TABLE'
+        """
+        )
+
+    return df