Skip to content

Commit

Permalink
implement short_circuits function for ScalarUDFImpl trait (#10168)
Browse files Browse the repository at this point in the history
* implement short_circuits function for ScalarUDFImpl trait

* finish
  • Loading branch information
Lordworms authored Apr 22, 2024
1 parent 0780438 commit f5ab312
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion datafusion/expr/src/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1266,7 +1266,7 @@ impl Expr {
pub fn short_circuits(&self) -> bool {
match self {
Expr::ScalarFunction(ScalarFunction { func_def, .. }) => {
matches!(func_def, ScalarFunctionDefinition::UDF(fun) if fun.name().eq("coalesce"))
matches!(func_def, ScalarFunctionDefinition::UDF(fun) if fun.short_circuits())
}
Expr::BinaryExpr(BinaryExpr { op, .. }) => {
matches!(op, Operator::And | Operator::Or)
Expand Down
12 changes: 12 additions & 0 deletions datafusion/expr/src/udf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,11 @@ impl ScalarUDF {
pub fn monotonicity(&self) -> Result<Option<FuncMonotonicity>> {
self.inner.monotonicity()
}

/// Get the circuits of inner implementation
pub fn short_circuits(&self) -> bool {
self.inner.short_circuits()
}
}

impl<F> From<F> for ScalarUDF
Expand Down Expand Up @@ -376,6 +381,13 @@ pub trait ScalarUDFImpl: Debug + Send + Sync {
) -> Result<ExprSimplifyResult> {
Ok(ExprSimplifyResult::Original(args))
}

/// Returns true if some of this `exprs` subexpressions may not be evaluated
/// and thus any side effects (like divide by zero) may not be encountered
/// Setting this to true prevents certain optimizations such as common subexpression elimination
fn short_circuits(&self) -> bool {
false
}
}

/// ScalarUDF that adds an alias to the underlying function. It is better to
Expand Down
4 changes: 4 additions & 0 deletions datafusion/functions/src/math/coalesce.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ impl ScalarUDFImpl for CoalesceFunc {
Ok(result)
}
}

fn short_circuits(&self) -> bool {
true
}
}

#[cfg(test)]
Expand Down

0 comments on commit f5ab312

Please sign in to comment.