andygrove commented on a change in pull request #7993:
URL: https://github.com/apache/arrow/pull/7993#discussion_r472425993
##########
File path: rust/datafusion/src/dataframe.rs
##########
@@ -174,4 +174,18 @@ pub trait DataFrame {
/// Return the logical plan represented by this DataFrame.
fn to_logical_plan(&self) -> LogicalPlan;
+
+ /// Return a DataFrame with the explanation of its plan so far.
+ ///
+ /// ```
+ /// # use datafusion::prelude::*;
+ /// # use datafusion::error::Result;
+ /// # fn main() -> Result<()> {
+ /// let mut ctx = ExecutionContext::new();
+ /// let df = ctx.read_csv("tests/example.csv", CsvReadOptions::new())?;
+ /// let batches = df.limit(100)?.explain(false)?.collect()?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ fn explain(&self, verbose: bool) -> Result<Arc<dyn DataFrame>>;
Review comment:
I agree with your concern @jorgecarleitao and would expect `explain()`
to just print the plan rather than return a DataFrame. That would be easy to
implement (just call pretty_print here) but hard to test.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
