feat: Add tree / pretty explain mode

datafusion-examples/examples/planner_api.rs

@@ -17,7 +17,7 @@
 
 use datafusion::error::Result;
 use datafusion::logical_expr::{LogicalPlan, PlanType};
-use datafusion::physical_plan::displayable;
+use datafusion::physical_plan::{displayable, DisplayFormatType};
 use datafusion::physical_planner::DefaultPhysicalPlanner;
 use datafusion::prelude::*;
 
@@ -78,7 +78,11 @@ async fn to_physical_plan_in_one_api_demo(
     println!(
         "Physical plan direct from logical plan:\n\n{}\n\n",
         displayable(physical_plan.as_ref())
-            .to_stringified(false, PlanType::InitialPhysicalPlan)
+            .to_stringified(
+                false,
+                PlanType::InitialPhysicalPlan,
+                DisplayFormatType::Default
+            )
             .plan
     );
 
@@ -120,7 +124,11 @@ async fn to_physical_plan_step_by_step_demo(
     println!(
         "Final physical plan:\n\n{}\n\n",
         displayable(physical_plan.as_ref())
-            .to_stringified(false, PlanType::InitialPhysicalPlan)
+            .to_stringified(
+                false,
+                PlanType::InitialPhysicalPlan,
+                DisplayFormatType::Default
+            )
             .plan
     );
 
@@ -135,7 +143,11 @@ async fn to_physical_plan_step_by_step_demo(
     println!(
         "Optimized physical plan:\n\n{}\n\n",
         displayable(physical_plan.as_ref())
-            .to_stringified(false, PlanType::InitialPhysicalPlan)
+            .to_stringified(
+                false,
+                PlanType::InitialPhysicalPlan,
+                DisplayFormatType::Default
+            )
             .plan
     );
 

datafusion/common/src/config.rs

@@ -711,6 +711,10 @@ config_namespace! {
 
         /// When set to true, the explain statement will print schema information
         pub show_schema: bool, default = false
+
+        /// Display format of explain. Default is "indent".
+        /// When set to "tree", it will print the plan in a tree-rendered format.
+        pub format: String, default = "indent".to_string()
     }
 }
 

datafusion/core/src/datasource/file_format/arrow.rs

@@ -301,6 +301,10 @@ impl DisplayAs for ArrowFileSink {
                 FileGroupDisplay(&self.config.file_groups).fmt_as(t, f)?;
                 write!(f, ")")
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/src/datasource/file_format/csv.rs

@@ -16,7 +16,6 @@
 // under the License.
 
 //! Re-exports the [`datafusion_datasource_csv::file_format`] module, and contains tests for it.
-
 pub use datafusion_datasource_csv::file_format::*;
 
 #[cfg(test)]

datafusion/core/src/datasource/file_format/json.rs

@@ -16,7 +16,6 @@
 // under the License.
 
 //! Re-exports the [`datafusion_datasource_json::file_format`] module, and contains tests for it.
-
 pub use datafusion_datasource_json::file_format::*;
 
 #[cfg(test)]

datafusion/core/src/datasource/memory.rs

@@ -315,6 +315,10 @@ impl DisplayAs for MemSink {
                 let partition_count = self.batches.len();
                 write!(f, "MemoryTable (partitions={partition_count})")
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/src/physical_planner.rs

@@ -19,6 +19,7 @@
 
 use std::borrow::Cow;
 use std::collections::HashMap;
+use std::str::FromStr;
 use std::sync::Arc;
 
 use crate::datasource::file_format::file_type_to_format;
@@ -87,6 +88,7 @@ use datafusion_physical_optimizer::PhysicalOptimizerRule;
 use datafusion_physical_plan::execution_plan::InvariantLevel;
 use datafusion_physical_plan::placeholder_row::PlaceholderRowExec;
 use datafusion_physical_plan::unnest::ListUnnest;
+use datafusion_physical_plan::DisplayFormatType;
 
 use crate::schema_equivalence::schema_satisfied_by;
 use async_trait::async_trait;
@@ -1723,6 +1725,7 @@ impl DefaultPhysicalPlanner {
             let mut stringified_plans = vec![];
 
             let config = &session_state.config_options().explain;
+            let explain_format = DisplayFormatType::from_str(&config.format)?;
 
             if !config.physical_plan_only {
                 stringified_plans.clone_from(&e.stringified_plans);
@@ -1742,7 +1745,11 @@ impl DefaultPhysicalPlanner {
                             displayable(input.as_ref())
                                 .set_show_statistics(config.show_statistics)
                                 .set_show_schema(config.show_schema)
-                                .to_stringified(e.verbose, InitialPhysicalPlan),
+                                .to_stringified(
+                                    e.verbose,
+                                    InitialPhysicalPlan,
+                                    explain_format,
+                                ),
                         );
 
                         // Show statistics + schema in verbose output even if not
@@ -1755,6 +1762,7 @@ impl DefaultPhysicalPlanner {
                                         .to_stringified(
                                             e.verbose,
                                             InitialPhysicalPlanWithStats,
+                                            explain_format,
                                         ),
                                 );
                             }
@@ -1765,6 +1773,7 @@ impl DefaultPhysicalPlanner {
                                         .to_stringified(
                                             e.verbose,
                                             InitialPhysicalPlanWithSchema,
+                                            explain_format,
                                         ),
                                 );
                             }
@@ -1780,7 +1789,11 @@ impl DefaultPhysicalPlanner {
                                     displayable(plan)
                                         .set_show_statistics(config.show_statistics)
                                         .set_show_schema(config.show_schema)
-                                        .to_stringified(e.verbose, plan_type),
+                                        .to_stringified(
+                                            e.verbose,
+                                            plan_type,
+                                            explain_format,
+                                        ),
                                 );
                             },
                         );
@@ -1791,7 +1804,11 @@ impl DefaultPhysicalPlanner {
                                     displayable(input.as_ref())
                                         .set_show_statistics(config.show_statistics)
                                         .set_show_schema(config.show_schema)
-                                        .to_stringified(e.verbose, FinalPhysicalPlan),
+                                        .to_stringified(
+                                            e.verbose,
+                                            FinalPhysicalPlan,
+                                            explain_format,
+                                        ),
                                 );
 
                                 // Show statistics + schema in verbose output even if not
@@ -1804,6 +1821,7 @@ impl DefaultPhysicalPlanner {
                                                 .to_stringified(
                                                     e.verbose,
                                                     FinalPhysicalPlanWithStats,
+                                                    explain_format,
                                                 ),
                                         );
                                     }
@@ -1814,6 +1832,7 @@ impl DefaultPhysicalPlanner {
                                                 .to_stringified(
                                                     e.verbose,
                                                     FinalPhysicalPlanWithSchema,
+                                                    explain_format,
                                                 ),
                                         );
                                     }
@@ -2720,6 +2739,10 @@ mod tests {
                 DisplayFormatType::Default | DisplayFormatType::Verbose => {
                     write!(f, "NoOpExecutionPlan")
                 }
+                DisplayFormatType::TreeRender => {
+                    // TODO: collect info
+                    write!(f, "")
+                }
             }
         }
     }

datafusion/core/tests/custom_sources_cases/mod.rs

@@ -138,6 +138,11 @@ impl DisplayAs for CustomExecutionPlan {
             DisplayFormatType::Default | DisplayFormatType::Verbose => {
                 write!(f, "CustomExecutionPlan: projection={:#?}", self.projection)
             }
+
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/tests/custom_sources_cases/provider_filter_pushdown.rs

@@ -92,6 +92,10 @@ impl DisplayAs for CustomPlan {
             DisplayFormatType::Default | DisplayFormatType::Verbose => {
                 write!(f, "CustomPlan: batch_size={}", self.batches.len(),)
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/tests/custom_sources_cases/statistics.rs

@@ -141,6 +141,10 @@ impl DisplayAs for StatisticsValidation {
                     self.stats.num_rows,
                 )
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/tests/physical_optimizer/enforce_distribution.rs

@@ -99,10 +99,18 @@ impl SortRequiredExec {
 impl DisplayAs for SortRequiredExec {
     fn fmt_as(
         &self,
-        _t: DisplayFormatType,
+        t: DisplayFormatType,
         f: &mut std::fmt::Formatter,
     ) -> std::fmt::Result {
-        write!(f, "SortRequiredExec: [{}]", self.expr)
+        match t {
+            DisplayFormatType::Default | DisplayFormatType::Verbose => {
+                write!(f, "SortRequiredExec: [{}]", self.expr)
+            }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
+        }
     }
 }
 

datafusion/core/tests/physical_optimizer/join_selection.rs

@@ -924,6 +924,10 @@ impl DisplayAs for UnboundedExec {
                     self.batch_produce.is_none(),
                 )
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }
@@ -1019,6 +1023,11 @@ impl DisplayAs for StatisticsExec {
                     self.stats.num_rows,
                 )
             }
+
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/core/tests/physical_optimizer/test_utils.rs

@@ -339,8 +339,16 @@ impl RequirementsTestExec {
 }
 
 impl DisplayAs for RequirementsTestExec {
-    fn fmt_as(&self, _t: DisplayFormatType, f: &mut Formatter) -> std::fmt::Result {
-        write!(f, "RequiredInputOrderingExec")
+    fn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter) -> std::fmt::Result {
+        match t {
+            DisplayFormatType::Default | DisplayFormatType::Verbose => {
+                write!(f, "RequiredInputOrderingExec")
+            }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
+        }
     }
 }
 

datafusion/core/tests/user_defined/user_defined_plan.rs

@@ -700,6 +700,10 @@ impl DisplayAs for TopKExec {
             DisplayFormatType::Default | DisplayFormatType::Verbose => {
                 write!(f, "TopKExec: k={}", self.k)
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/datasource-csv/src/file_format.rs

@@ -665,6 +665,10 @@ impl DisplayAs for CsvSink {
                 FileGroupDisplay(&self.config.file_groups).fmt_as(t, f)?;
                 write!(f, ")")
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/datasource-json/src/file_format.rs

@@ -324,6 +324,10 @@ impl DisplayAs for JsonSink {
                 FileGroupDisplay(&self.config.file_groups).fmt_as(t, f)?;
                 write!(f, ")")
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/datasource-parquet/src/file_format.rs

@@ -871,6 +871,10 @@ impl DisplayAs for ParquetSink {
                 FileGroupDisplay(&self.config.file_groups).fmt_as(t, f)?;
                 write!(f, ")")
             }
+            DisplayFormatType::TreeRender => {
+                // TODO: collect info
+                write!(f, "")
+            }
         }
     }
 }

datafusion/datasource-parquet/src/source.rs

@@ -554,7 +554,9 @@ impl FileSource for ParquetSource {
 
     fn fmt_extra(&self, t: DisplayFormatType, f: &mut Formatter) -> std::fmt::Result {
         match t {
-            DisplayFormatType::Default | DisplayFormatType::Verbose => {
+            DisplayFormatType::Default
+            | DisplayFormatType::Verbose
+            | DisplayFormatType::TreeRender => {
                 let predicate_string = self
                     .predicate()
                     .map(|p| format!(", predicate={p}"))

datafusion/datasource/src/display.rs

@@ -36,7 +36,7 @@ impl DisplayAs for FileGroupsDisplay<'_> {
         let groups = if n_groups == 1 { "group" } else { "groups" };
         write!(f, "{{{n_groups} {groups}: [")?;
         match t {
-            DisplayFormatType::Default => {
+            DisplayFormatType::Default | DisplayFormatType::TreeRender => {
                 // To avoid showing too many partitions
                 let max_groups = 5;
                 fmt_up_to_n_elements(self.0, max_groups, f, |group, f| {
@@ -66,7 +66,7 @@ impl DisplayAs for FileGroupDisplay<'_> {
     fn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter) -> FmtResult {
         write!(f, "[")?;
         match t {
-            DisplayFormatType::Default => {
+            DisplayFormatType::Default | DisplayFormatType::TreeRender => {
                 // To avoid showing too many files
                 let max_files = 5;
                 fmt_up_to_n_elements(self.0, max_files, f, |pf, f| {