Warehouses

export_all_warehouses(workspace, path)

Exports all warehouses from the workspace to path.

Parameters:

Name	Type	Description	Default
workspace	str	The ID or name of the workspace.	required
path	Union[str, Path]	The path to export to.	required

Source code in src/pyfabricops/helpers/warehouses.py

def export_all_warehouses(workspace: str, path: Union[str, Path]) -> None:
    """
    Exports all warehouses from the workspace to path.

    Args:
        workspace (str): The ID or name of the workspace.
        path (Union[str, Path]): The path to export to.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    items = list_valid_warehouses(workspace_id, df=False)
    if items is None:
        return None

    for item in items:
        try:
            folder_path = resolve_folder_from_id_to_path(
                workspace_id, item['folderId']
            )
        except:
            logger.info(
                f'{item["displayName"]}.Warehouse is not inside a folder.'
            )
            folder_path = None

        if folder_path is None:
            item_path = Path(path) / (item['displayName'] + '.Warehouse')
        else:
            item_path = (
                Path(path) / folder_path / (item['displayName'] + '.Warehouse')
            )
        os.makedirs(item_path, exist_ok=True)

        platform = _generate_warehouse_platform(
            display_name=item['displayName'],
            description=item['description'],
        )

        _save_warehouse_platform(platform, item_path)

        _save_warehouse_defaultsemanticmodel_txt(item_path)

        _save_warehouse_sqlproj(item['displayName'], item_path)

        _save_warehouse_xmla_json(item_path)

    logger.success(f'All warehouses exported to {path} successfully.')
    return None

export_warehouse(workspace, warehouse, path)

Export a warehouse to path

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID of the workspace.	required
warehouse	str	The name or ID of the warehouse.	required
path	Union[str, Path]	The path to export to.	required

Source code in src/pyfabricops/helpers/warehouses.py

def export_warehouse(
    workspace: str,
    warehouse: str,
    path: Union[str, Path],
) -> None:
    """
    Export a warehouse to path

    Args:
        workspace (str): The name or ID of the workspace.
        warehouse (str): The name or ID of the warehouse.
        path (Union[str, Path]): The path to export to.
    """
    workspace_id = resolve_workspace(workspace)
    if workspace_id is None:
        return None

    item = get_warehouse(workspace_id, warehouse, df=True)
    try:
        folder_path = resolve_folder_from_id_to_path(
            workspace_id, item['folderId']
        )
    except:
        logger.info(f'{item["displayName"]}.Warehouse is not inside a folder.')
        folder_path = None

    if folder_path is None:
        item_path = Path(path) / (item['displayName'] + '.Warehouse')
    else:
        item_path = (
            Path(path) / folder_path / (item['displayName'] + '.Warehouse')
        )
    os.makedirs(item_path, exist_ok=True)

    platform = _generate_warehouse_platform(
        display_name=item['displayName'],
        description=item['description'],
    )

    _save_warehouse_platform(platform, item_path)

    _save_warehouse_defaultsemanticmodel_txt(item_path)

    _save_warehouse_sqlproj(item['displayName'], item_path)

    _save_warehouse_xmla_json(item_path)

    logger.success(f'All warehouses exported to {path} successfully.')
    return None

get_all_warehouses_config(workspace)

Generate warehouses config from a workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID from the workspace.	required

Returns:

Type	Description
Union[Dict[str, Any], None]	The dict config from the warehouses of the workspace

Source code in src/pyfabricops/helpers/warehouses.py

def get_all_warehouses_config(workspace: str) -> Union[Dict[str, Any], None]:
    """
    Generate warehouses config from a workspace.

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

    Returns:
        (Union[Dict[str, Any], None]): The dict config from the warehouses of the workspace
    """
    items = list_valid_warehouses(workspace, df=False)

    if items is None:
        return None

    config = {}

    for item in items:

        item_data = get_warehouse(workspace, item['id'], df=False)

        config[item['displayName']] = {
            'id': item['id'],
            'description': item.get('description', None),
            'folder_id': ''
            if item.get('folderId') is None or pd.isna(item.get('folderId'))
            else item['folderId'],
            'connection_string': item_data['properties']['connectionString'],
        }

    return config

get_warehouse_config(workspace, warehouse)

Get a specific warehouse config from a workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID from the workspace.	required
warehouse	str	The name or ID from the warehouse.	required

Returns:

Type	Description
Union[Dict[str, Any], None]	The dict config from the warehouse

Source code in src/pyfabricops/helpers/warehouses.py

def get_warehouse_config(
    workspace: str, warehouse: str
) -> Union[Dict[str, Any], None]:
    """
    Get a specific warehouse config from a workspace.

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

    Returns:
        (Union[Dict[str, Any], None]): The dict config from the warehouse
    """
    item = warehouse
    item_data = get_warehouse(workspace, item, df=False)

    if item_data is None:
        return None

    else:
        config = {}
        config = config[item_data.get('displayName')] = {}

        config = {
            'id': item_data['id'],
            'description': item_data.get('description', None),
            'folder_id': ''
            if item_data.get('folderId') is None
            or pd.isna(item_data.get('folderId'))
            else item_data['folderId'],
            'connection_string': item_data['properties']['connectionString'],
        }

        return config

list_valid_warehouses(workspace, df=True)

Generate a list of valid warehouses from a workspace.

Parameters:

Name	Type	Description	Default
workspace	str	The name or ID from the workspace.	required

Returns:

Type	Description
Union[Dict[str, Any], None]	The list of valids warehouses of the workspace

Source code in src/pyfabricops/helpers/warehouses.py

@df
def list_valid_warehouses(
    workspace: str,
    df: Optional[bool] = True,
) -> Union[DataFrame, List[Dict[str, Any]], None]:
    """
    Generate a list of valid warehouses from a workspace.

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

    Returns:
        (Union[Dict[str, Any], None]): The list of valids warehouses of the workspace
    """
    items = list_warehouses(workspace)

    if items is None:
        return None

    return items[
        ~items['displayName'].str.contains('staging', case=False, na=False)
    ].to_dict(orient='records')