-
Notifications
You must be signed in to change notification settings - Fork 313
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: physical optimizer RemoveDuplicate to remove duplicate exec pla…
…ns (#3839) * feat: physical optimizer RemoveDuplicate to remove duplicate exec plans Signed-off-by: Ruihang Xia <waynestxia@gmail.com> * update document Signed-off-by: Ruihang Xia <waynestxia@gmail.com> * update sqlness results Signed-off-by: Ruihang Xia <waynestxia@gmail.com> --------- Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
- Loading branch information
Showing
7 changed files
with
127 additions
and
13 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
// Copyright 2023 Greptime Team | ||
// | ||
// Licensed 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. | ||
|
||
use common_query::DfPhysicalPlanRef; | ||
use datafusion::config::ConfigOptions; | ||
use datafusion::physical_optimizer::PhysicalOptimizerRule; | ||
use datafusion::physical_plan::coalesce_batches::CoalesceBatchesExec; | ||
use datafusion::physical_plan::repartition::RepartitionExec; | ||
use datafusion_common::tree_node::{Transformed, TreeNode}; | ||
use datafusion_common::Result as DfResult; | ||
|
||
/// This is [PhysicalOptimizerRule] to remove duplicate physical plans such as two | ||
/// adjoining [CoalesceBatchesExec] or [RepartitionExec]. They won't have any effect | ||
/// if one runs right after another. | ||
/// | ||
/// This rule is expected to be run in the final stage of the optimization process. | ||
pub struct RemoveDuplicate; | ||
|
||
impl PhysicalOptimizerRule for RemoveDuplicate { | ||
fn optimize( | ||
&self, | ||
plan: DfPhysicalPlanRef, | ||
_config: &ConfigOptions, | ||
) -> DfResult<DfPhysicalPlanRef> { | ||
Self::do_optimize(plan) | ||
} | ||
|
||
fn name(&self) -> &str { | ||
"RemoveDuplicateRule" | ||
} | ||
|
||
fn schema_check(&self) -> bool { | ||
false | ||
} | ||
} | ||
|
||
impl RemoveDuplicate { | ||
fn do_optimize(plan: DfPhysicalPlanRef) -> DfResult<DfPhysicalPlanRef> { | ||
let result = plan | ||
.transform_down_mut(&mut |plan| { | ||
if plan.as_any().is::<CoalesceBatchesExec>() | ||
|| plan.as_any().is::<RepartitionExec>() | ||
{ | ||
// check child | ||
let child = plan.children()[0].clone(); | ||
if child.as_any().type_id() == plan.as_any().type_id() { | ||
// remove child | ||
let grand_child = child.children()[0].clone(); | ||
let new_plan = plan.with_new_children(vec![grand_child])?; | ||
return Ok(Transformed::yes(new_plan)); | ||
} | ||
} | ||
|
||
Ok(Transformed::no(plan)) | ||
})? | ||
.data; | ||
|
||
Ok(result) | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod test { | ||
use std::sync::Arc; | ||
|
||
use arrow_schema::Schema; | ||
use datafusion::physical_plan::displayable; | ||
use datafusion::physical_plan::empty::EmptyExec; | ||
use datafusion_physical_expr::Partitioning; | ||
|
||
use super::*; | ||
|
||
#[test] | ||
fn remove_coalesce_batches() { | ||
let empty = Arc::new(EmptyExec::new(Arc::new(Schema::empty()))); | ||
let coalesce_batches = Arc::new(CoalesceBatchesExec::new(empty, 1024)); | ||
let another_coalesce_batches = Arc::new(CoalesceBatchesExec::new(coalesce_batches, 8192)); | ||
|
||
let optimized = RemoveDuplicate::do_optimize(another_coalesce_batches).unwrap(); | ||
let formatted = displayable(optimized.as_ref()).indent(true).to_string(); | ||
let expected = "CoalesceBatchesExec: target_batch_size=8192\ | ||
\n EmptyExec\n"; | ||
|
||
assert_eq!(expected, formatted); | ||
} | ||
|
||
#[test] | ||
fn non_continuous_coalesce_batches() { | ||
let empty = Arc::new(EmptyExec::new(Arc::new(Schema::empty()))); | ||
let coalesce_batches = Arc::new(CoalesceBatchesExec::new(empty, 1024)); | ||
let repartition = Arc::new( | ||
RepartitionExec::try_new(coalesce_batches, Partitioning::UnknownPartitioning(1)) | ||
.unwrap(), | ||
); | ||
let another_coalesce_batches = Arc::new(CoalesceBatchesExec::new(repartition, 8192)); | ||
|
||
let optimized = RemoveDuplicate::do_optimize(another_coalesce_batches).unwrap(); | ||
let formatted = displayable(optimized.as_ref()).indent(true).to_string(); | ||
let expected = "CoalesceBatchesExec: target_batch_size=8192\ | ||
\n RepartitionExec: partitioning=UnknownPartitioning(1), input_partitions=1\ | ||
\n CoalesceBatchesExec: target_batch_size=1024\ | ||
\n EmptyExec\n"; | ||
|
||
assert_eq!(expected, formatted); | ||
} | ||
} |
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