Skip to content

Clarify documentation that ScalarUDFImpl::simplity must not change the schema #17981

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

Merged
merged 4 commits into from
Oct 10, 2025
Merged

Clarify documentation that ScalarUDFImpl::simplity must not change the schema #17981

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13c8237
Clarify documentation that ScalarUDFImpl::simplity must not change th…
alamb Oct 8, 2025
ddc3370
Merge branch 'main' into alamb/docs_schema
alamb Oct 8, 2025
08abc7d
Merge remote-tracking branch 'apache/main' into alamb/docs_schema
alamb Oct 9, 2025
ce7bc3f
Add comments to AggregateUDFImpl and WindowUDFImpl
alamb Oct 9, 2025
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
8 changes: 8 additions & 0 deletions datafusion/expr/src/udf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,14 @@ pub trait ScalarUDFImpl: Debug + DynEq + DynHash + Send + Sync {
/// [`ExprSimplifyResult`] indicating the result of the simplification NOTE
/// if the function cannot be simplified, the arguments *MUST* be returned
/// unmodified
///
/// # Notes
///
/// The returned expression must have the same schema as the original
/// expression, including both the data type and nullability. For example,
/// if the original expression is nullable, the returned expression must
/// also be nullable, otherwise it may lead to schema verification errors
/// later in query planning.
fn simplify(
&self,
args: Vec<Expr>,
Expand Down