feat: implement tree rendering for SortPreservingMergeExec

Signed-off-by: Alan Tang <[email protected]>

Author: Standing-Man

datafusion/physical-plan/src/sorts/sort_preserving_merge.rs

@@ -186,8 +186,15 @@ impl DisplayAs for SortPreservingMergeExec {
                 Ok(())
             }
             DisplayFormatType::TreeRender => {
-                // TODO: collect info
-                write!(f, "")
+                for (i, e) in self.expr().iter().enumerate() {
+                    let e = e.to_string();
+                    writeln!(f, "expr{i}={e}")?;
+                }
+                if let Some(fetch) = self.fetch {
+                    writeln!(f, "fetch={fetch}")?;
+                };
+
+                Ok(())
             }
         }
     }

datafusion/sqllogictest/test_files/explain_tree.slt

@@ -1315,25 +1315,31 @@ logical_plan
 physical_plan
 01)┌───────────────────────────┐
 02)│  SortPreservingMergeExec  │
-03)└─────────────┬─────────────┘
-04)┌─────────────┴─────────────┐
-05)│    CoalesceBatchesExec    │
-06)└─────────────┬─────────────┘
-07)┌─────────────┴─────────────┐
-08)│         FilterExec        │
-09)│    --------------------   │
-10)│         predicate:        │
-11)│        ticker@1 = A       │
+03)│    --------------------   │
+04)│           expr0:          │
+05)│   date@0 ASC NULLS LAST   │
+06)│                           │
+07)│           expr1:          │
+08)│   time@2 ASC NULLS LAST   │
+09)└─────────────┬─────────────┘
+10)┌─────────────┴─────────────┐
+11)│    CoalesceBatchesExec    │
 12)└─────────────┬─────────────┘
 13)┌─────────────┴─────────────┐
-14)│      RepartitionExec      │
-15)└─────────────┬─────────────┘
-16)┌─────────────┴─────────────┐
-17)│     StreamingTableExec    │
-18)│    --------------------   │
-19)│       infinite: true      │
-20)│        limit: None        │
-21)└───────────────────────────┘
+14)│         FilterExec        │
+15)│    --------------------   │
+16)│         predicate:        │
+17)│        ticker@1 = A       │
+18)└─────────────┬─────────────┘
+19)┌─────────────┴─────────────┐
+20)│      RepartitionExec      │
+21)└─────────────┬─────────────┘
+22)┌─────────────┴─────────────┐
+23)│     StreamingTableExec    │
+24)│    --------------------   │
+25)│       infinite: true      │
+26)│        limit: None        │
+27)└───────────────────────────┘
 
 
 # constant ticker, CAST(time AS DATE) = time, order by time
@@ -1349,26 +1355,29 @@ logical_plan
 physical_plan
 01)┌───────────────────────────┐
 02)│  SortPreservingMergeExec  │
-03)└─────────────┬─────────────┘
-04)┌─────────────┴─────────────┐
-05)│    CoalesceBatchesExec    │
+03)│    --------------------   │
+04)│           expr0:          │
+05)│   time@2 ASC NULLS LAST   │
 06)└─────────────┬─────────────┘
 07)┌─────────────┴─────────────┐
-08)│         FilterExec        │
-09)│    --------------------   │
-10)│         predicate:        │
-11)│ ticker@1 = A AND CAST(time│
-12)│   @2 AS Date32) = date@0  │
-13)└─────────────┬─────────────┘
-14)┌─────────────┴─────────────┐
-15)│      RepartitionExec      │
+08)│    CoalesceBatchesExec    │
+09)└─────────────┬─────────────┘
+10)┌─────────────┴─────────────┐
+11)│         FilterExec        │
+12)│    --------------------   │
+13)│         predicate:        │
+14)│ ticker@1 = A AND CAST(time│
+15)│   @2 AS Date32) = date@0  │
 16)└─────────────┬─────────────┘
 17)┌─────────────┴─────────────┐
-18)│     StreamingTableExec    │
-19)│    --------------------   │
-20)│       infinite: true      │
-21)│        limit: None        │
-22)└───────────────────────────┘
+18)│      RepartitionExec      │
+19)└─────────────┬─────────────┘
+20)┌─────────────┴─────────────┐
+21)│     StreamingTableExec    │
+22)│    --------------------   │
+23)│       infinite: true      │
+24)│        limit: None        │
+25)└───────────────────────────┘
 
 # same thing but order by date
 query TT
@@ -1383,26 +1392,29 @@ logical_plan
 physical_plan
 01)┌───────────────────────────┐
 02)│  SortPreservingMergeExec  │
-03)└─────────────┬─────────────┘
-04)┌─────────────┴─────────────┐
-05)│    CoalesceBatchesExec    │
+03)│    --------------------   │
+04)│           expr0:          │
+05)│   date@0 ASC NULLS LAST   │
 06)└─────────────┬─────────────┘
 07)┌─────────────┴─────────────┐
-08)│         FilterExec        │
-09)│    --------------------   │
-10)│         predicate:        │
-11)│ ticker@1 = A AND CAST(time│
-12)│   @2 AS Date32) = date@0  │
-13)└─────────────┬─────────────┘
-14)┌─────────────┴─────────────┐
-15)│      RepartitionExec      │
+08)│    CoalesceBatchesExec    │
+09)└─────────────┬─────────────┘
+10)┌─────────────┴─────────────┐
+11)│         FilterExec        │
+12)│    --------------------   │
+13)│         predicate:        │
+14)│ ticker@1 = A AND CAST(time│
+15)│   @2 AS Date32) = date@0  │
 16)└─────────────┬─────────────┘
 17)┌─────────────┴─────────────┐
-18)│     StreamingTableExec    │
-19)│    --------------------   │
-20)│       infinite: true      │
-21)│        limit: None        │
-22)└───────────────────────────┘
+18)│      RepartitionExec      │
+19)└─────────────┬─────────────┘
+20)┌─────────────┴─────────────┐
+21)│     StreamingTableExec    │
+22)│    --------------------   │
+23)│       infinite: true      │
+24)│        limit: None        │
+25)└───────────────────────────┘
 
 # same thing but order by ticker
 query TT
@@ -1452,26 +1464,32 @@ logical_plan
 physical_plan
 01)┌───────────────────────────┐
 02)│  SortPreservingMergeExec  │
-03)└─────────────┬─────────────┘
-04)┌─────────────┴─────────────┐
-05)│    CoalesceBatchesExec    │
-06)└─────────────┬─────────────┘
-07)┌─────────────┴─────────────┐
-08)│         FilterExec        │
-09)│    --------------------   │
-10)│         predicate:        │
-11)│ ticker@1 = A AND CAST(time│
-12)│   @2 AS Date32) = date@0  │
-13)└─────────────┬─────────────┘
-14)┌─────────────┴─────────────┐
-15)│      RepartitionExec      │
-16)└─────────────┬─────────────┘
-17)┌─────────────┴─────────────┐
-18)│     StreamingTableExec    │
-19)│    --------------------   │
-20)│       infinite: true      │
-21)│        limit: None        │
-22)└───────────────────────────┘
+03)│    --------------------   │
+04)│           expr0:          │
+05)│   time@2 ASC NULLS LAST   │
+06)│                           │
+07)│           expr1:          │
+08)│   date@0 ASC NULLS LAST   │
+09)└─────────────┬─────────────┘
+10)┌─────────────┴─────────────┐
+11)│    CoalesceBatchesExec    │
+12)└─────────────┬─────────────┘
+13)┌─────────────┴─────────────┐
+14)│         FilterExec        │
+15)│    --------------------   │
+16)│         predicate:        │
+17)│ ticker@1 = A AND CAST(time│
+18)│   @2 AS Date32) = date@0  │
+19)└─────────────┬─────────────┘
+20)┌─────────────┴─────────────┐
+21)│      RepartitionExec      │
+22)└─────────────┬─────────────┘
+23)┌─────────────┴─────────────┐
+24)│     StreamingTableExec    │
+25)│    --------------------   │
+26)│       infinite: true      │
+27)│        limit: None        │
+28)└───────────────────────────┘
 
 
 
@@ -1489,22 +1507,28 @@ logical_plan
 physical_plan
 01)┌───────────────────────────┐
 02)│  SortPreservingMergeExec  │
-03)└─────────────┬─────────────┘
-04)┌─────────────┴─────────────┐
-05)│    CoalesceBatchesExec    │
-06)└─────────────┬─────────────┘
-07)┌─────────────┴─────────────┐
-08)│         FilterExec        │
-09)│    --------------------   │
-10)│         predicate:        │
-11)│    date@0 = 2006-01-02    │
+03)│    --------------------   │
+04)│           expr0:          │
+05)│  ticker@1 ASC NULLS LAST  │
+06)│                           │
+07)│           expr1:          │
+08)│   time@2 ASC NULLS LAST   │
+09)└─────────────┬─────────────┘
+10)┌─────────────┴─────────────┐
+11)│    CoalesceBatchesExec    │
 12)└─────────────┬─────────────┘
 13)┌─────────────┴─────────────┐
-14)│      RepartitionExec      │
-15)└─────────────┬─────────────┘
-16)┌─────────────┴─────────────┐
-17)│     StreamingTableExec    │
-18)│    --------------------   │
-19)│       infinite: true      │
-20)│        limit: None        │
-21)└───────────────────────────┘
+14)│         FilterExec        │
+15)│    --------------------   │
+16)│         predicate:        │
+17)│    date@0 = 2006-01-02    │
+18)└─────────────┬─────────────┘
+19)┌─────────────┴─────────────┐
+20)│      RepartitionExec      │
+21)└─────────────┬─────────────┘
+22)┌─────────────┴─────────────┐
+23)│     StreamingTableExec    │
+24)│    --------------------   │
+25)│       infinite: true      │
+26)│        limit: None        │
+27)└───────────────────────────┘