forked from apache/datafusion
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support inlining view / dataframes logical plan (apache#3923)
* Inline TableScans for views and dataframes * Inline TableScans for views and dataframes * Inline TableScans for views and dataframes * WIP * WIP * WIP * WIP * WIP * WIP * fmt * doc * Fix test * Simplify * Fix * Rename test source * Use plan instead of projected schema * Docs * Use SubqueryAlias * Revert "Use SubqueryAlias" This reverts commit 207c2a9. * WIP * Fix issue * Clippy * Format
- Loading branch information
Showing
10 changed files
with
228 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| //! Optimizer rule to replace TableScan references | ||
| //! such as DataFrames and Views and inlines the LogicalPlan | ||
| //! to support further optimization | ||
| use crate::{OptimizerConfig, OptimizerRule}; | ||
| use datafusion_common::Result; | ||
| use datafusion_expr::{ | ||
| logical_plan::LogicalPlan, utils::from_plan, Expr, LogicalPlanBuilder, TableScan, | ||
| }; | ||
|
|
||
| /// Optimization rule that inlines TableScan that provide a [LogicalPlan] | ||
| /// ([DataFrame] / [ViewTable]) | ||
| #[derive(Default)] | ||
| pub struct InlineTableScan; | ||
|
|
||
| impl InlineTableScan { | ||
| #[allow(missing_docs)] | ||
| pub fn new() -> Self { | ||
| Self {} | ||
| } | ||
| } | ||
|
|
||
| /// Inline | ||
| fn inline_table_scan(plan: &LogicalPlan) -> Result<LogicalPlan> { | ||
| match plan { | ||
| // Match only on scans without filter / projection / fetch | ||
| // Views and DataFrames won't have those added | ||
| // during the early stage of planning | ||
| LogicalPlan::TableScan(TableScan { | ||
| source, | ||
| table_name, | ||
| filters, | ||
| fetch: None, | ||
| .. | ||
| }) if filters.is_empty() => { | ||
| if let Some(sub_plan) = source.get_logical_plan() { | ||
| // Recursively apply optimization | ||
| let plan = inline_table_scan(sub_plan)?; | ||
| let plan = LogicalPlanBuilder::from(plan).project_with_alias( | ||
| vec![Expr::Wildcard], | ||
| Some(table_name.to_string()), | ||
| )?; | ||
| plan.build() | ||
| } else { | ||
| // No plan available, return with table scan as is | ||
| Ok(plan.clone()) | ||
| } | ||
| } | ||
|
|
||
| // Rest: Recurse | ||
| _ => { | ||
| // apply the optimization to all inputs of the plan | ||
| let inputs = plan.inputs(); | ||
| let new_inputs = inputs | ||
| .iter() | ||
| .map(|plan| inline_table_scan(plan)) | ||
| .collect::<Result<Vec<_>>>()?; | ||
|
|
||
| from_plan(plan, &plan.expressions(), &new_inputs) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl OptimizerRule for InlineTableScan { | ||
| fn optimize( | ||
| &self, | ||
| plan: &LogicalPlan, | ||
| _optimizer_config: &mut OptimizerConfig, | ||
| ) -> Result<LogicalPlan> { | ||
| inline_table_scan(plan) | ||
| } | ||
|
|
||
| fn name(&self) -> &str { | ||
| "inline_table_scan" | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use std::{sync::Arc, vec}; | ||
|
|
||
| use arrow::datatypes::{DataType, Field, Schema}; | ||
| use datafusion_expr::{col, lit, LogicalPlan, LogicalPlanBuilder, TableSource}; | ||
|
|
||
| use crate::{inline_table_scan::InlineTableScan, OptimizerConfig, OptimizerRule}; | ||
|
|
||
| pub struct RawTableSource {} | ||
|
|
||
| impl TableSource for RawTableSource { | ||
| fn as_any(&self) -> &dyn std::any::Any { | ||
| self | ||
| } | ||
|
|
||
| fn schema(&self) -> arrow::datatypes::SchemaRef { | ||
| Arc::new(Schema::new(vec![Field::new("a", DataType::Int64, false)])) | ||
| } | ||
|
|
||
| fn supports_filter_pushdown( | ||
| &self, | ||
| _filter: &datafusion_expr::Expr, | ||
| ) -> datafusion_common::Result<datafusion_expr::TableProviderFilterPushDown> | ||
| { | ||
| Ok(datafusion_expr::TableProviderFilterPushDown::Inexact) | ||
| } | ||
| } | ||
|
|
||
| pub struct CustomSource { | ||
| plan: LogicalPlan, | ||
| } | ||
| impl CustomSource { | ||
| fn new() -> Self { | ||
| Self { | ||
| plan: LogicalPlanBuilder::scan("y", Arc::new(RawTableSource {}), None) | ||
| .unwrap() | ||
| .build() | ||
| .unwrap(), | ||
| } | ||
| } | ||
| } | ||
| impl TableSource for CustomSource { | ||
| fn as_any(&self) -> &dyn std::any::Any { | ||
| self | ||
| } | ||
|
|
||
| fn supports_filter_pushdown( | ||
| &self, | ||
| _filter: &datafusion_expr::Expr, | ||
| ) -> datafusion_common::Result<datafusion_expr::TableProviderFilterPushDown> | ||
| { | ||
| Ok(datafusion_expr::TableProviderFilterPushDown::Exact) | ||
| } | ||
|
|
||
| fn schema(&self) -> arrow::datatypes::SchemaRef { | ||
| Arc::new(Schema::new(vec![Field::new("a", DataType::Int64, false)])) | ||
| } | ||
|
|
||
| fn get_logical_plan(&self) -> Option<&LogicalPlan> { | ||
| Some(&self.plan) | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn inline_table_scan() { | ||
| let rule = InlineTableScan::new(); | ||
|
|
||
| let source = Arc::new(CustomSource::new()); | ||
|
|
||
| let scan = LogicalPlanBuilder::scan("x".to_string(), source, None).unwrap(); | ||
|
|
||
| let plan = scan.filter(col("x.a").eq(lit(1))).unwrap().build().unwrap(); | ||
|
|
||
| let optimized_plan = rule | ||
| .optimize(&plan, &mut OptimizerConfig::new()) | ||
| .expect("failed to optimize plan"); | ||
| let formatted_plan = format!("{:?}", optimized_plan); | ||
| let expected = "\ | ||
| Filter: x.a = Int32(1)\ | ||
| \n Projection: y.a, alias=x\ | ||
| \n TableScan: y"; | ||
|
|
||
| assert_eq!(formatted_plan, expected); | ||
| assert_eq!(plan.schema(), optimized_plan.schema()); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters