Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[FEATURE] Preserve Workspace Folder Structure on 'export'

Đang mở
  • Có gì không ổn?
#48 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
cli

Hướng nghiên cứu

Bắt đầu với việc xử lý đối số export trong src/fabric_cli/parsers/fab_fs_parser.py, sau đó đọc các client cho folder, workspace item và item definition trong src/fabric_cli/client/fab_api_folders.py, fab_api_workspace.py và fab_api_item.py. Công việc hoàn tất khi --preserve-folders tái tạo các đường dẫn folder của item, trong khi export mặc định vẫn phẳng, bao gồm cả các item ở cấp root.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement
Use Case / Problem

Problem Statement

I'm exporting a Fabric workspace to my local filesystem for backup and version control. My workspace uses folders to organize items logically—by feature, department, or data source—but the current export functionality strips away this structure entirely.

Current Limitation

The export command flattens the folder hierarchy. When I export an item located at MyWorkspace/Sales Reports/Q1_Report.Report, it creates Q1_Report.Report/ directly in the output directory, completely discarding the Sales Reports/ parent folder. This eliminates the organizational context that's critical for understanding the project.

Impact on Workflow

This limitation breaks DevOps and GitOps practices. In code-managed Fabric environments, folder structure isn't just organizational—it's fundamental to the project architecture. Without it, I can't:

  • Navigate locally: The flat structure makes it nearly impossible to find items quickly or understand relationships between assets.
  • Conduct meaningful code reviews: Git diffs lose context when the logical grouping disappears, making it harder for teams to review changes effectively.
  • Automate deployments: Re-importing assets while preserving the intended workspace organization becomes manual and error-prone.

Requested Enhancement

Preserve the full folder hierarchy during workspace export. If an item exists at MyWorkspace/Sales Reports/Q1_Report.Report, the export should create Sales Reports/Q1_Report.Report/ in the output directory, maintaining the complete path structure.

This would enable seamless integration with modern development workflows and make Fabric workspaces truly manageable as code.

Proposed Solution

Specific commands or functionality:

Extend the existing export command with a --preserve-folders flag to maintain the workspace's folder hierarchy during export.

fab export <workspace_name> -o <output_path> --preserve-folders

Expected behavior and output:

With the --preserve-folders flag enabled, the export command replicates the complete folder structure from the Fabric workspace to the local filesystem.

Example:

Starting with this workspace structure in Fabric:

/MyWorkspace.Workspace/
├── Reports/
│   └── Sales_Report.Report
└── Notebooks/
    └── Data_Processing.Notebook

Current Behavior (fab export MyWorkspace.Workspace -o ./local_export --all):

./local_export/
├── Sales_Report.Report/
│   └── ... (item files)
└── Data_Processing.Notebook/
    └── ... (item files)

All items export to a flat structure, losing the original folder organization.

Expected Behavior (fab export MyWorkspace.Workspace -o ./local_export --all --preserve-folders):

./local_export/
├── Reports/
│   └── Sales_Report.Report/
│       └── ... (item files)
└── Notebooks/
    └── Data_Processing.Notebook/
        └── ... (item files)

The original folder hierarchy is preserved, making it easier to understand project organization.

Integration with existing fabric-cli features:

This enhancement naturally extends the export command and strengthens the CLI's filesystem metaphor established by commands like ls, cd, and mkdir. It also sets the foundation for a complementary import enhancement that could automatically recreate folder structures in target workspaces, enabling true round-trip workflows.

Alternatives Considered

No response

Impact Assessment
  • This would help me personally
  • This would help my team/organization
  • This would help the broader fabric-cli community
  • This aligns with Microsoft Fabric roadmap items
Implementation Attestation
  • I understand this feature should maintain backward compatibility with existing commands
  • I confirm this feature request does not introduce performance regressions for existing workflows
  • I acknowledge that new features must follow fabric-cli's established patterns and conventions
Implementation Notes
  • Relevant Fabric REST APIs:

This feature can be efficiently implemented using three core APIs that minimize the number of calls needed:

  1. GET /v1/workspaces/{workspaceId}/folders?recursive=True: Found in src/fabric_cli/client/fab_api_folders.py, this single call retrieves the entire folder hierarchy for a workspace—no recursive GET /folders/{folderId} calls required. The response includes each folder's id, displayName, and parentFolderId.

  2. GET /v1/workspaces/{workspaceId}/items: This API (in fab_api_workspace.py) returns a flat list of all workspace items. The critical property is folderId, which links each item to its parent folder in the hierarchy. Root-level items won't have a folderId.

  3. POST /v1/workspaces/{workspaceId}/items/{itemId}/getDefinition: The existing API used by the export command (fab_api_item.py) to fetch an item's actual definition content. This part of the logic would remain unchanged.

  • Command Structure or Argument Patterns:

    A new optional flag should be added to the export command in src/fabric_cli/parsers/fab_fs_parser.py. A good name would be --preserve-folders.

  • Compatibility Concerns:

    To ensure backward compatibility, this new behavior should only be triggered when the --preserve-folders flag is present. The default behavior of the export command (flattening the directory structure) should remain unchanged to avoid breaking existing user scripts and workflows.

Ngôn ngữ chính
Python
Star
174
Fork
64
Merge trung bình
6 ngày 38 phút
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/fabric-cli

Tất cả issue của microsoft/fabric-cli

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.