Skip to content

Housepath

Public callable

Fabric lakehouse or warehouse connection details.

Housepath stores the minimum identifiers needed to read from or write to a Fabric lakehouse or warehouse using framework helpers.

In normal use, define these values in a separate Fabric config notebook, validate the CONFIG mapping with load_fabric_config, then retrieve the required environment and target with get_path.

Attributes:

Name Type Description
workspace_id str

Fabric workspace ID that contains the lakehouse or warehouse.
house_id str

Fabric lakehouse or warehouse item ID.
house_name str

Lakehouse or warehouse name.
root str

ABFSS root path for the lakehouse or warehouse.

Examples:

>>> lh = Housepath(
...     workspace_id="<workspace-id>",
...     house_id="<lakehouse-id>",
...     house_name="DEX_SB_SOURCE",
...     root="abfss://<workspace-id>@onelake.dfs.fabric.microsoft.com/<lakehouse-id>",
... )
>>> lh.house_name
'DEX_SB_SOURCE'
Source code in src/fabricops_kit/fabric_io.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@dataclass(frozen=True)
class Housepath:
    """Fabric lakehouse or warehouse connection details.

    `Housepath` stores the minimum identifiers needed to read from or write to
    a Fabric lakehouse or warehouse using framework helpers.

    In normal use, define these values in a separate Fabric config notebook,
    validate the `CONFIG` mapping with `load_fabric_config`, then retrieve the
    required environment and target with `get_path`.

    Attributes
    ----------
    workspace_id : str
        Fabric workspace ID that contains the lakehouse or warehouse.
    house_id : str
        Fabric lakehouse or warehouse item ID.
    house_name : str
        Lakehouse or warehouse name.
    root : str
        ABFSS root path for the lakehouse or warehouse.

    Examples
    --------
    >>> lh = Housepath(
    ...     workspace_id="<workspace-id>",
    ...     house_id="<lakehouse-id>",
    ...     house_name="DEX_SB_SOURCE",
    ...     root="abfss://<workspace-id>@onelake.dfs.fabric.microsoft.com/<lakehouse-id>",
    ... )
    >>> lh.house_name
    'DEX_SB_SOURCE'
    """

    workspace_id: str
    house_id: str
    house_name: str
    root: str

workspace_id instance-attribute 

workspace_id

house_id instance-attribute 

house_id

house_name instance-attribute 

house_name

root instance-attribute 

root

__init__ 

__init__(workspace_id, house_id, house_name, root)