Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions datafusion/expr/src/planner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,13 @@ pub trait ExprPlanner: Debug + Send + Sync {
)
}

/// Plans scalar functions, such as `ABS(<expr>)`
///
/// Returns the original scalar function if not possible
fn plan_scalar(&self, expr: RawScalarExpr) -> Result<PlannerResult<RawScalarExpr>> {
Ok(PlannerResult::Original(expr))
}

/// Plans aggregate functions, such as `COUNT(<expr>)`
///
/// Returns original expression arguments if not possible
Expand Down Expand Up @@ -318,6 +325,13 @@ pub struct RawDictionaryExpr {
pub values: Vec<Expr>,
}

/// A scalar function to plan with [`ExprPlanner`].
#[derive(Debug, Clone)]
pub struct RawScalarExpr {
pub func: Arc<ScalarUDF>,
pub args: Vec<Expr>,
}

/// This structure is used by `AggregateFunctionPlanner` to plan operators with
/// custom expressions.
#[derive(Debug, Clone)]
Expand Down
17 changes: 15 additions & 2 deletions datafusion/sql/src/expr/function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ use datafusion_expr::{
self, HigherOrderFunction, Lambda, NullTreatment, ScalarFunction, Unnest,
WildcardOptions, WindowFunction,
},
planner::{PlannerResult, RawAggregateExpr, RawWindowExpr},
planner::{PlannerResult, RawAggregateExpr, RawScalarExpr, RawWindowExpr},
type_coercion::functions::value_fields_with_higher_order_udf,
};
use sqlparser::ast::{
Expand Down Expand Up @@ -341,7 +341,20 @@ impl<S: ContextProvider> SqlToRel<'_, S> {
};

// After resolution, all arguments are positional
let inner = ScalarFunction::new_udf(fm, resolved_args);
let mut scalar_expr = RawScalarExpr {
func: fm,
args: resolved_args,
};

for planner in self.context_provider.get_expr_planners().iter() {
match planner.plan_scalar(scalar_expr)? {
PlannerResult::Planned(expr) => return Ok(expr),
PlannerResult::Original(expr) => scalar_expr = expr,
}
}

let RawScalarExpr { func, args } = scalar_expr;
let inner = ScalarFunction::new_udf(func, args);

if name.eq_ignore_ascii_case(inner.name()) {
return Ok(Expr::ScalarFunction(inner));
Expand Down
39 changes: 38 additions & 1 deletion datafusion/sql/tests/sql_integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ use datafusion_expr::{
expr::{HigherOrderFunction, LambdaVariable, ScalarFunction},
lambda,
logical_plan::LogicalPlan,
planner::{ExprPlanner, PlannerResult, RawScalarExpr},
test::function_stub::sum_udaf,
};
use datafusion_functions::{string, unicode};
use datafusion_functions::{core as core_functions, string, unicode};
use datafusion_sql::{
parser::DFParser,
planner::{NullOrdering, ParserOptions, PlannerContext, SqlToRel},
Expand Down Expand Up @@ -836,6 +837,42 @@ fn select_scalar_func_with_literal_no_relation() {
);
}

#[derive(Debug)]
struct SingleArgumentCoalescePlanner;

impl ExprPlanner for SingleArgumentCoalescePlanner {
fn plan_scalar(&self, expr: RawScalarExpr) -> Result<PlannerResult<RawScalarExpr>> {
if expr.func.name() == "coalesce"
&& let [arg] = expr.args.as_slice()
{
Ok(PlannerResult::Planned(arg.clone()))
} else {
Ok(PlannerResult::Original(expr))
}
}
}

#[test]
fn select_scalar_func_with_expr_planner() -> Result<()> {
let state = mock_session_state()
.with_scalar_function(core_functions::coalesce())
.with_expr_planner(Arc::new(SingleArgumentCoalescePlanner));
let plan = logical_plan_from_state(
"SELECT coalesce(42)",
&GenericDialect {},
ParserOptions::default(),
state,
)?;
assert_snapshot!(
plan,
@r"
Projection: Int64(42)
EmptyRelation: rows=1
"
);
Ok(())
}

#[test]
fn select_simple_filter() {
let sql = "SELECT id, first_name, last_name \
Expand Down