Repository navigation
Closed
Labels
good first issueGood for newcomersGood for newcomers
Description
Is your feature request related to a problem or challenge?
@irenjj added a new tree explain mode in #14677. Now we need to add support for different types of operators.
Here is an example of how to see the new explain plans:
set datafusion.explain.format = 'tree';
create table foo(x int, y int) as values (1,2), (3,4);
explain select * from foo where x = 4;
+---------------+------------------------------------+
| plan_type | plan |
+---------------+------------------------------------+
| logical_plan | Filter: foo.x = Int32(4) |
| | TableScan: foo projection=[x, y] |
| physical_plan | ┌───────────────────────────┐ |
| | │ CoalesceBatchesExec │ |
| | └─────────────┬─────────────┘ |
| | ┌─────────────┴─────────────┐ |
| | │ FilterExec │ |
| | └─────────────┬─────────────┘ |
| | ┌─────────────┴─────────────┐ |
| | │ DataSourceExec │ |
| | │ -------------------- │ |
| | │ partition_sizes: [1] │ |
| | │ partitions: 1 │ |
| | └───────────────────────────┘ |
| | |
+---------------+------------------------------------+Describe the solution you'd like
Add tree format to the ExecutionPlan specified in the subject of this ticket
Note that the tree mode should have only the most relevant information for users to understand what plan is being run. Detailed iformation
The process goes like:
- Add the relevant code to the operator
- Add / update explain_tree.slt test to show the new code in action
The relevant code looks like this
DisplayFormatType::TreeRender => {
// TODO: collect info
write!(f, "")?;
}You can run the tests like
cargo test --test sqllogictests -- explain_treeYou can update the test like this:
cargo test --test sqllogictests -- explain_tree --completeDescribe alternatives you've considered
Here is an example PR that shows what is needed
Additional context
Since this is well specified and has several examples and will give exposure to DataFusion code and testing, I have marked this as a good first issue
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomers
Activity
zebsme commentedon Mar 5, 2025
take
alamb commentedon Mar 7, 2025
@zebsme how is this going? I noticed you took this and #15025 and #15026
If you aren't planning on working on them in the near term perhaps you could mention that on the tickets so others who might have time can work on them
zebsme commentedon Mar 8, 2025
hi,I only took this,15025 and 15026 are not my tickets. And I will work on this tomorrow
alamb commentedon Mar 8, 2025
Sorry about that -- yes I confused your github handle and @zjregee -- I apologize 🤦