Skip to content

feat(query): support aggregate common subplans in CSE #19981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SkyFan2002 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(query): support aggregate common subplans in CSE #19981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 182 additions & 0 deletions src/query/sql/src/planner/optimizer/optimizers/cse/analyze.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,21 +156,36 @@ mod tests {
use std::any::Any;

use databend_common_catalog::table::Table;
use databend_common_expression::Scalar;
use databend_common_expression::TableDataType;
use databend_common_expression::TableField;
use databend_common_expression::TableSchema;
use databend_common_expression::types::DataType;
use databend_common_expression::types::NumberDataType;
use databend_common_expression::types::NumberScalar;
use databend_common_meta_app::schema::CatalogInfo;
use databend_common_meta_app::schema::DatabaseType;
use databend_common_meta_app::schema::TableIdent;
use databend_common_meta_app::schema::TableInfo;
use databend_common_meta_app::schema::TableMeta;

use super::*;
use crate::ColumnBindingBuilder;
use crate::Symbol;
use crate::Visibility;
use crate::planner::metadata::Metadata;
use crate::plans::Aggregate;
use crate::plans::AggregateFunction;
use crate::plans::AggregateMode;
use crate::plans::BoundColumnRef;
use crate::plans::ConstantExpr;
use crate::plans::EvalScalar;
use crate::plans::FunctionCall;
use crate::plans::Join;
use crate::plans::JoinType;
use crate::plans::RelOperator;
use crate::plans::ScalarExpr;
use crate::plans::ScalarItem;
use crate::plans::Scan;

#[derive(Debug)]
Expand Down Expand Up @@ -240,6 +255,62 @@ mod tests {
})))
}

fn column_expr(metadata: &Metadata, table_index: usize) -> ScalarExpr {
let column = metadata.columns_by_table_index(table_index)[0].clone();
BoundColumnRef {
span: None,
column: ColumnBindingBuilder::new(
column.name(),
column.index(),
Box::new(column.data_type()),
Visibility::Visible,
)
.table_index(Some(table_index))
.build(),
}
.into()
}

fn max_aggregate_expr(
metadata: &Metadata,
table_index: usize,
output_index: Symbol,
with_group_by: bool,
) -> SExpr {
let group_items = if with_group_by {
vec![ScalarItem {
scalar: column_expr(metadata, table_index),
index: Symbol::new(output_index.as_usize() + 1),
}]
} else {
vec![]
};

SExpr::create_unary(
Arc::new(RelOperator::Aggregate(Aggregate {
mode: AggregateMode::Initial,
group_items,
aggregate_functions: vec![ScalarItem {
scalar: ScalarExpr::AggregateFunction(AggregateFunction {
span: None,
func_name: "max".to_string(),
distinct: false,
params: vec![],
args: vec![column_expr(metadata, table_index)],
return_type: Box::new(DataType::Number(NumberDataType::UInt64)),
sort_descs: vec![],
display_name: "max(a)".to_string(),
}),
index: output_index,
}],
from_distinct: false,
rank_limit: None,
grouping_sets: None,
})),
Arc::new(scan_expr(metadata, table_index)),
)
}

fn cross_join_expr(left: SExpr, right: SExpr) -> SExpr {
SExpr::create_binary(
Arc::new(RelOperator::Join(Join {
Expand All @@ -251,6 +322,35 @@ mod tests {
)
}

fn eval_scalar_expr(
metadata: &Metadata,
input: SExpr,
table_index: usize,
output_index: Symbol,
value: u64,
) -> SExpr {
SExpr::create_unary(
Arc::new(RelOperator::EvalScalar(EvalScalar {
items: vec![ScalarItem {
scalar: ScalarExpr::FunctionCall(FunctionCall {
span: None,
func_name: "plus".to_string(),
params: vec![],
arguments: vec![
column_expr(metadata, table_index),
ScalarExpr::ConstantExpr(ConstantExpr {
span: None,
value: Scalar::Number(NumberScalar::UInt64(value)),
}),
],
}),
index: output_index,
}],
})),
Arc::new(input),
)
}

#[test]
fn test_analyze_common_subexpression_prefers_cross_join_subtree() {
let mut metadata = Metadata::default();
Expand Down Expand Up @@ -313,4 +413,86 @@ mod tests {
.all(|cte| matches!(cte.child(0).unwrap().plan(), RelOperator::Scan(_)))
);
}

#[test]
fn test_analyze_common_subexpression_matches_identical_aggregates() {
let mut metadata = Metadata::default();
let t1 = fake_fuse_table(1, "t1");

let t1_left = add_table(&mut metadata, t1.clone());
let t1_right = add_table(&mut metadata, t1);

let left = max_aggregate_expr(&metadata, t1_left, Symbol::new(10), false);
let right = max_aggregate_expr(&metadata, t1_right, Symbol::new(11), false);
let root = cross_join_expr(left, right);

let (replacements, materialized_ctes) =
analyze_common_subexpression(&root, &mut metadata).unwrap();

assert_eq!(replacements.len(), 2);
assert_eq!(materialized_ctes.len(), 1);
assert!(matches!(
materialized_ctes[0].child(0).unwrap().plan(),
RelOperator::Aggregate(_)
));
}

#[test]
fn test_analyze_common_subexpression_matches_identical_group_aggregates() {
let mut metadata = Metadata::default();
let t1 = fake_fuse_table(1, "t1");

let t1_left = add_table(&mut metadata, t1.clone());
let t1_right = add_table(&mut metadata, t1);

let left = max_aggregate_expr(&metadata, t1_left, Symbol::new(10), true);
let right = max_aggregate_expr(&metadata, t1_right, Symbol::new(12), true);
let root = cross_join_expr(left, right);

let (replacements, materialized_ctes) =
analyze_common_subexpression(&root, &mut metadata).unwrap();

assert_eq!(replacements.len(), 2);
assert_eq!(materialized_ctes.len(), 1);
assert!(matches!(
materialized_ctes[0].child(0).unwrap().plan(),
RelOperator::Aggregate(_)
));
}

#[test]
fn test_analyze_common_subexpression_does_not_materialize_eval_scalar_subtree() {
let mut metadata = Metadata::default();
let t1 = fake_fuse_table(1, "t1");
let t2 = fake_fuse_table(2, "t2");

let t1_left = add_table(&mut metadata, t1.clone());
let t2_left = add_table(&mut metadata, t2.clone());
let t1_right = add_table(&mut metadata, t1);
let t2_right = add_table(&mut metadata, t2);

let left_input =
cross_join_expr(scan_expr(&metadata, t1_left), scan_expr(&metadata, t2_left));
let right_input = cross_join_expr(
scan_expr(&metadata, t1_right),
scan_expr(&metadata, t2_right),
);
let left = eval_scalar_expr(&metadata, left_input, t1_left, Symbol::new(20), 1);
let right = eval_scalar_expr(&metadata, right_input, t1_right, Symbol::new(21), 2);
let root = cross_join_expr(left, right);

let (_replacements, materialized_ctes) =
analyze_common_subexpression(&root, &mut metadata).unwrap();

assert!(
materialized_ctes
.iter()
.all(|cte| !contains_eval_scalar(cte.child(0).unwrap()))
);
}

fn contains_eval_scalar(expr: &SExpr) -> bool {
matches!(expr.plan(), RelOperator::EvalScalar(_))
|| expr.children().any(contains_eval_scalar)
}
}
Loading
Loading