Skip to content

Warehouses

create_warehouse(workspace, display_name, *, description=None, folder=None, enable_schemas=False, df=True)

Create a warehouse in the specified workspace.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
display_name str

The display name for the warehouse.

 required
description Optional[str]

The description for the warehouse.

 None
folder Optional[str]

The folder to create the warehouse in.

 None
enable_schemas Optional[bool]

Whether to enable schemas for the warehouse.

 False
df Optional[bool]

If True or not provided, returns a DataFrame with flattened keys. If False, returns a list of dictionaries.

 True

Returns:

Type Description
Union[DataFrame, Dict[str, Any], None]

The created warehouse details if successful, otherwise None.

Examples:

create_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
create_warehouse('MyProjectWorkspace', 'SalesDatawarehouse', description='Sales data warehouse')
Source code in src/pyfabricops/items/warehouses.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
@df
def create_warehouse(
    workspace: str,
    display_name: str,
    *,
    description: Optional[str] = None,
    folder: Optional[str] = None,
    enable_schemas: Optional[bool] = False,
    df: Optional[bool] = True,
) -> Union[DataFrame, Dict[str, Any], None]:
    """
    Create a warehouse in the specified workspace.

    Args:
        workspace (str): The workspace name or ID.
        display_name (str): The display name for the warehouse.
        description (Optional[str]): The description for the warehouse.
        folder (Optional[str]): The folder to create the warehouse in.
        enable_schemas (Optional[bool]): Whether to enable schemas for the warehouse.
        df (Optional[bool]): If True or not provided, returns a DataFrame with flattened keys.
            If False, returns a list of dictionaries.

    Returns:
        (Union[DataFrame, Dict[str, Any], None]): The created warehouse details if successful, otherwise None.

    Examples:
        ```python
        create_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
        create_warehouse('MyProjectWorkspace', 'SalesDatawarehouse', description='Sales data warehouse')
        ```
    """
    workspace_id = resolve_workspace(workspace)

    payload = {'displayName': display_name}

    if description:
        payload['description'] = description

    if folder:
        folder_id = resolve_folder(workspace_id, folder)
        if folder_id:
            payload['folderId'] = folder_id

    if enable_schemas:
        payload['creationPayload'] = {'enableSchemas': True}

    return api_request(
        endpoint='/workspaces/' + workspace_id + '/warehouses',
        method='post',
        payload=payload,
        support_lro=True,
    )

delete_warehouse(workspace, warehouse)

Delete a warehouse in the specified workspace.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
warehouse str

The name or ID of the warehouse to delete.

 required

Returns:

Type Description
bool

True if the warehouse was deleted successfully, otherwise False.

Examples:

delete_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
delete_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000')
Source code in src/pyfabricops/items/warehouses.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
def delete_warehouse(workspace: str, warehouse: str) -> None:
    """
    Delete a warehouse in the specified workspace.

    Args:
        workspace (str): The workspace name or ID.
        warehouse (str): The name or ID of the warehouse to delete.

    Returns:
        (bool): True if the warehouse was deleted successfully, otherwise False.

    Examples:
        ```python
        delete_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
        delete_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000')
        ```
    """
    workspace_id = resolve_workspace(workspace)
    warehouse_id = resolve_warehouse(workspace_id, warehouse)
    return api_request(
        endpoint='/workspaces/' + workspace_id + '/warehouses/' + warehouse_id,
        method='delete',
    )

get_warehouse(workspace, warehouse, *, df=True)

Retrieves a warehouse by its name or ID from the specified workspace.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
warehouse str

The name or ID of the warehouse.

 required
df Optional[bool]

If True or not provided, returns a DataFrame with flattened keys. If False, returns a list of dictionaries.

 True

Returns:

Type Description
Union[DataFrame, Dict[str, Any], None]

The warehouse details if found. If df=True, returns a DataFrame with flattened keys.

Examples:

get_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
get_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000')
get_warehouse('123e4567-e89b-12d3-a456-426614174000', 'SalesDatawarehouse', df=True)
Source code in src/pyfabricops/items/warehouses.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@df
def get_warehouse(
    workspace: str,
    warehouse: str,
    *,
    df: Optional[bool] = True,
) -> Union[DataFrame, Dict[str, Any], None]:
    """
    Retrieves a warehouse by its name or ID from the specified workspace.

    Args:
        workspace (str): The workspace name or ID.
        warehouse (str): The name or ID of the warehouse.
        df (Optional[bool]): If True or not provided, returns a DataFrame with flattened keys.
            If False, returns a list of dictionaries.

    Returns:
        (Union[DataFrame, Dict[str, Any], None]): The warehouse details if found. If `df=True`, returns a DataFrame with flattened keys.

    Examples:
        ```python
        get_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
        get_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000')
        get_warehouse('123e4567-e89b-12d3-a456-426614174000', 'SalesDatawarehouse', df=True)
        ```
    """
    workspace_id = resolve_workspace(workspace)
    if not workspace_id:
        return None

    warehouse_id = resolve_warehouse(workspace_id, warehouse)
    if not warehouse_id:
        return None

    return api_request(
        endpoint='/workspaces/' + workspace_id + '/warehouses/' + warehouse_id,
    )

get_warehouse_id(workspace, warehouse)

Retrieves the ID of a warehouse by its name from the specified workspace.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
warehouse str

The name of the warehouse.

 required

Returns:

Type Description
Union[str, None]

The ID of the warehouse, or None if not found.

Examples:

get_warehouse_id('MyProjectWorkspace', 'SalesDatawarehouse')
Source code in src/pyfabricops/items/warehouses.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def get_warehouse_id(workspace: str, warehouse: str) -> Union[str, None]:
    """
    Retrieves the ID of a warehouse by its name from the specified workspace.

    Args:
        workspace (str): The workspace name or ID.
        warehouse (str): The name of the warehouse.

    Returns:
        (Union[str, None]): The ID of the warehouse, or None if not found.

    Examples:
        ```python
        get_warehouse_id('MyProjectWorkspace', 'SalesDatawarehouse')
        ```
    """
    warehouses = list_warehouses(workspace, df=False)
    if not warehouses:
        return None

    for warehouse_ in warehouses:
        if warehouse_['displayName'] == warehouse:
            return warehouse_['id']
    return None

list_warehouses(workspace, *, df=True)

Returns a list of warehouses from the specified workspace. This API supports pagination.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
ddf Optional[bool]

If True or not provided, returns a DataFrame with flattened keys. If False, returns a list of dictionaries.

 required

Returns:

Type Description
Union[DataFrame, List[Dict[str, Any]], None]

A list of warehouses, excluding those that start with the specified prefixes. If df=True, returns a DataFrame with flattened keys.

Examples:

list_warehouses('MyProjectWorkspace')
Source code in src/pyfabricops/items/warehouses.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@df
def list_warehouses(
    workspace: str,
    *,
    df: Optional[bool] = True,
) -> Union[DataFrame, List[Dict[str, Any]], None]:
    """
    Returns a list of warehouses from the specified workspace.
    This API supports pagination.

    Args:
        workspace (str): The workspace name or ID.
        ddf (Optional[bool]): If True or not provided, returns a DataFrame with flattened keys.
            If False, returns a list of dictionaries.

    Returns:
        (Union[DataFrame, List[Dict[str, Any]], None]): A list of warehouses, excluding those that start with the specified prefixes. If `df=True`, returns a DataFrame with flattened keys.

    Examples:
        ```python
        list_warehouses('MyProjectWorkspace')
        ```
    """
    return api_request(
        endpoint='/workspaces/' + resolve_workspace(workspace) + '/warehouses',
        support_pagination=True,
    )

resolve_warehouse(workspace, warehouse)

Resolves a warehouse name to its ID.

Parameters:

Name Type Description Default
workspace str

The ID of the workspace.

 required
warehouse str

The name of the warehouse.

 required

Returns:

Type Description
Union[str, None]

The ID of the warehouse, or None if not found.

Examples:

resolve_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
Source code in src/pyfabricops/items/warehouses.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def resolve_warehouse(
    workspace: str,
    warehouse: str,
) -> Union[str, None]:
    """
    Resolves a warehouse name to its ID.

    Args:
        workspace (str): The ID of the workspace.
        warehouse (str): The name of the warehouse.

    Returns:
        (Union[str, None]): The ID of the warehouse, or None if not found.

    Examples:
        ```python
        resolve_warehouse('MyProjectWorkspace', 'SalesDatawarehouse')
        ```
    """
    if is_valid_uuid(warehouse):
        return warehouse
    else:
        return get_warehouse_id(workspace, warehouse)

update_warehouse(workspace, warehouse, *, display_name=None, description=None, df=True)

Updates the properties of the specified warehouse.

Parameters:

Name Type Description Default
workspace str

The workspace name or ID.

 required
warehouse str

The name or ID of the warehouse to update.

 required
display_name Optional[str]

The new display name for the warehouse.

 None
description Optional[str]

The new description for the warehouse.

 None
df Optional[bool]

If True or not provided, returns a DataFrame with flattened keys. If False, returns a list of dictionaries.

 True

Returns:

Type Description
Union[DataFrame, Dict[str, Any], None]

The updated warehouse details if successful, otherwise None.

Examples:

update_warehouse('MyProjectWorkspace', 'SalesDatawarehouse', display_name='UpdatedSalesDatawarehouse')
update_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000', description='Updated description')
Source code in src/pyfabricops/items/warehouses.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
@df
def update_warehouse(
    workspace: str,
    warehouse: str,
    *,
    display_name: Optional[str] = None,
    description: Optional[str] = None,
    df: Optional[bool] = True,
) -> Union[DataFrame, Dict[str, Any], None]:
    """
    Updates the properties of the specified warehouse.

    Args:
        workspace (str): The workspace name or ID.
        warehouse (str): The name or ID of the warehouse to update.
        display_name (Optional[str]): The new display name for the warehouse.
        description (Optional[str]): The new description for the warehouse.
        df (Optional[bool]): If True or not provided, returns a DataFrame with flattened keys.
            If False, returns a list of dictionaries.

    Returns:
        (Union[DataFrame, Dict[str, Any], None]): The updated warehouse details if successful, otherwise None.

    Examples:
        ```python
        update_warehouse('MyProjectWorkspace', 'SalesDatawarehouse', display_name='UpdatedSalesDatawarehouse')
        update_warehouse('MyProjectWorkspace', '123e4567-e89b-12d3-a456-426614174000', description='Updated description')
        ```
    """
    workspace_id = resolve_workspace(workspace)
    warehouse_id = resolve_warehouse(workspace_id, warehouse)

    payload = {}

    if display_name:
        payload['displayName'] = display_name

    if description:
        payload['description'] = description

    return api_request(
        endpoint='/workspaces/' + workspace_id + '/warehouses/' + warehouse_id,
        method='patch',
        payload=payload,
    )