Refactor duplicate code in type_coercion/functions.rs - #19518
Conversation
| let arg_fields = arg_types | ||
| .iter() | ||
| .map(|dt| Field::new("f", dt.clone(), true)) | ||
| .map(Arc::new) | ||
| .collect::<Vec<_>>(); | ||
| let return_types = | ||
| rresult_return!(data_types_with_scalar_udf(&arg_types, udf.inner())); | ||
| rresult_return!(fields_with_udf(&arg_fields, udf.inner().as_ref())) | ||
| .into_iter() | ||
| .map(|f| f.data_type().to_owned()) | ||
| .collect::<Vec<_>>(); |
There was a problem hiding this comment.
Same as how UDAF handles this:
datafusion/datafusion/ffi/src/udaf/mod.rs
Lines 329 to 350 in e5ca510
| /// | ||
| /// For more details on coercion in general, please see the | ||
| /// [`type_coercion`](crate::type_coercion) module. | ||
| #[deprecated(since = "52.0.0", note = "use fields_with_udf")] |
There was a problem hiding this comment.
Personally I'm of the mind to just remove these functions completely
| /// For more details on coercion in general, please see the | ||
| /// [`type_coercion`](crate::type_coercion) module. | ||
| #[deprecated(since = "52.0.0", note = "use fields_with_udf")] | ||
| pub fn data_types( |
There was a problem hiding this comment.
This function was only ever used in unit tests below 🤔
There was a problem hiding this comment.
if its pub it still might be used elsewhere beyond DF engine
|
|
||
| matches!( | ||
| type_signature, | ||
| match type_signature { |
There was a problem hiding this comment.
Using match here makes it more obvious which variants are not well supported
| ); | ||
| } | ||
| }, | ||
| TypeSignature::OneOf(signatures) => signatures |
There was a problem hiding this comment.
The scalar fn version actually has extra functionality in that it collects the errors together for oneof; unifying this code with aggregate/window udfs brings in this functionality for them, hence SLT fix was needed
| } | ||
|
|
||
| let current_types = expressions | ||
| let current_fields = expressions |
| } | ||
|
|
||
| impl UDFCoercionExt for ScalarUDF { | ||
| fn name(&self) -> &str { |
There was a problem hiding this comment.
its bad the specialization feature is in nightly releases, so we could get rid of those parts
|
|
||
| # WindowFunction wrong signature | ||
| statement error DataFusion error: Error during planning: Failed to coerce arguments to satisfy a call to 'nth_value' function: coercion from Int32, Int64, Int64 to the signature OneOf\(\[Any\(0\), Any\(1\), Any\(2\)\]\) failed | ||
| statement error DataFusion error: Error during planning: Internal error: Function 'nth_value' failed to match any signature |
There was a problem hiding this comment.
Is it really an Internal error ?
It is an error caused by the user's input.
| // Every signature failed, return the joined error | ||
| if res.is_empty() { | ||
| internal_err!( | ||
| return internal_err!( |
There was a problem hiding this comment.
I think this should be a plan_err!()
Co-authored-by: Oleks V <comphead@users.noreply.github.com>
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Follow up to #19518 - Initial work before tackling #19004 ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Found lots of code duplicated here, so unifying them. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> - Reduce code duplication around handling scalar/aggregate/window UDFs in type coercion related code, via usage of new `UDFCoercionExt` trait which unifies some of their behaviours (introduced by #19518) - Deprecate functions `can_coerce_from()` and `generate_signature_error_msg()` to work towards minimizing our public API surface - Fix some UDF signatures which nested `UserDefined` within `OneOf` - Fix bug where type coercion rewrites weren't being applied to arguments of non-aggregate window UDFs ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> Existing tests. ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> Deprecated some functions. <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - Follow up to apache#19518 - Initial work before tackling apache#19004 ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Found lots of code duplicated here, so unifying them. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> - Reduce code duplication around handling scalar/aggregate/window UDFs in type coercion related code, via usage of new `UDFCoercionExt` trait which unifies some of their behaviours (introduced by apache#19518) - Deprecate functions `can_coerce_from()` and `generate_signature_error_msg()` to work towards minimizing our public API surface - Fix some UDF signatures which nested `UserDefined` within `OneOf` - Fix bug where type coercion rewrites weren't being applied to arguments of non-aggregate window UDFs ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> Existing tests. ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> Deprecated some functions. <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Which issue does this PR close?
Rationale for this change
Found lots of code duplicated here, so unifying them.
What changes are included in this PR?
Introduce new trait
UDFCoercionExtto unify functions across scalar/aggregate/window UDFs for use in a single generic implementation. New unified functionsfields_with_udfandget_valid_types_with_udfwhich are generic across this new trait.Are these changes tested?
Existing tests.
Are there any user-facing changes?
Yes, deprecating functions.