Implement tree explain for RepartitionExec and WorkTableExec (#15137)

Standing-Man · alamb · web-flow · commit 4b8a2d84506b · 2025-03-11T16:35:26.000-04:00
* feat: implement tree rendering for RepartitionExec

Signed-off-by: Alan Tang &lt;jmtangcs@gmail.com&gt;

* feat: implement tree rendering for WorkTableExec

Signed-off-by: Alan Tang &lt;jmtangcs@gmail.com&gt;

* bug: fix clippy error

Signed-off-by: Alan Tang &lt;jmtangcs@gmail.com&gt;

---------

Signed-off-by: Alan Tang &lt;jmtangcs@gmail.com&gt;
Co-authored-by: Andrew Lamb &lt;andrew@nerdnetworks.org&gt;
diff --git a/datafusion/physical-plan/src/repartition/mod.rs b/datafusion/physical-plan/src/repartition/mod.rs
@@ -507,8 +507,16 @@ impl DisplayAs for RepartitionExec {
                 Ok(())
             }
             DisplayFormatType::TreeRender => {
-                // TODO: collect info
-                write!(f, "")
+                writeln!(f, "partitioning_scheme={}", self.partitioning(),)?;
+                writeln!(
+                    f,
+                    "output_partition_count={}",
+                    self.input.output_partitioning().partition_count()
+                )?;
+                if self.preserve_order {
+                    writeln!(f, "preserve_order={}", self.preserve_order)?;
+                }
+                Ok(())
             }
         }
     }
diff --git a/datafusion/physical-plan/src/work_table.rs b/datafusion/physical-plan/src/work_table.rs
@@ -163,8 +163,7 @@ impl DisplayAs for WorkTableExec {
                 write!(f, "WorkTableExec: name={}", self.name)
             }
             DisplayFormatType::TreeRender => {
-                // TODO: collect info
-                write!(f, "")
+                write!(f, "name={}", self.name)
             }
         }
     }
diff --git a/datafusion/sqllogictest/test_files/explain_tree.slt b/datafusion/sqllogictest/test_files/explain_tree.slt

Original file line number	Diff line number	Diff line change
`@@ -507,8 +507,16 @@ impl DisplayAs for RepartitionExec {`
`507`	`507`	`Ok(())`
`508`	`508`	`}`
`509`	`509`	`DisplayFormatType::TreeRender => {`
`510`		`- // TODO: collect info`
`511`		`- write!(f, "")`
	`510`	`+ writeln!(f, "partitioning_scheme={}", self.partitioning(),)?;`
	`511`	`+ writeln!(`
	`512`	`+ f,`
	`513`	`+ "output_partition_count={}",`
	`514`	`+ self.input.output_partitioning().partition_count()`
	`515`	`+ )?;`
	`516`	`+ if self.preserve_order {`
	`517`	`+ writeln!(f, "preserve_order={}", self.preserve_order)?;`
	`518`	`+ }`
	`519`	`+ Ok(())`
`512`	`520`	`}`
`513`	`521`	`}`
`514`	`522`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,8 +163,7 @@ impl DisplayAs for WorkTableExec {`
`163`	`163`	`write!(f, "WorkTableExec: name={}", self.name)`
`164`	`164`	`}`
`165`	`165`	`DisplayFormatType::TreeRender => {`
`166`		`- // TODO: collect info`
`167`		`- write!(f, "")`
	`166`	`+ write!(f, "name={}", self.name)`
`168`	`167`	`}`
`169`	`168`	`}`
`170`	`169`	`}`