Skip to content

Commit f478cdc

Browse files
committed
improve OneOf signature diagnostics
Cherry-pick of apache#21032. Adapted for 52.5.0: - Two unused imports in datafusion-expr's test module (`IntervalUnit`, `logical_int64`) compile-fail under -D warnings; dropped. - Two sql-integration tests and several sqllogictest expected-error patterns assumed the friendlier Display impl from apache#20605 was already on 52.5.0 (it isn't); updated those patterns to the pre-apache#20605 verbose `TypeSignatureClass::Native(LogicalType(...))` shape and to the post-apache#21032 `failed with: ...` (no quoted inner message) shape. - Also includes the author's own follow-up CI fix (was a separate commit upstream, folded here). Signed-off-by: yaommen <[email protected]>
1 parent a1e8e20 commit f478cdc

17 files changed

Lines changed: 670 additions & 81 deletions

File tree

‎datafusion/expr/src/type_coercion/functions.rs‎

Lines changed: 549 additions & 41 deletions
Large diffs are not rendered by default.

‎datafusion/expr/src/udaf.rs‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ use std::vec;
2626

2727
use arrow::datatypes::{DataType, Field, FieldRef};
2828

29-
use datafusion_common::{Result, ScalarValue, Statistics, exec_err, not_impl_err};
29+
use datafusion_common::{
30+
DataFusionError, Result, ScalarValue, Statistics, exec_err, not_impl_err,
31+
};
3032
use datafusion_expr_common::dyn_eq::{DynEq, DynHash};
3133
use datafusion_physical_expr_common::physical_expr::PhysicalExpr;
3234

@@ -271,6 +273,16 @@ impl AggregateUDF {
271273
self.inner.coerce_types(arg_types)
272274
}
273275

276+
/// Returns a function-specific signature failure for argument combinations
277+
/// that are better described semantically than by generic signature
278+
/// diagnostics.
279+
pub fn diagnose_failed_signature(
280+
&self,
281+
arg_types: &[DataType],
282+
) -> Option<DataFusionError> {
283+
self.inner.diagnose_failed_signature(arg_types)
284+
}
285+
274286
/// See [`AggregateUDFImpl::with_beneficial_ordering`] for more details.
275287
pub fn with_beneficial_ordering(
276288
self,
@@ -711,6 +723,16 @@ pub trait AggregateUDFImpl: Debug + DynEq + DynHash + Send + Sync {
711723
not_impl_err!("Function {} does not implement coerce_types", self.name())
712724
}
713725

726+
/// Returns a semantic signature failure for argument combinations that
727+
/// should be surfaced directly instead of going through generic `OneOf`
728+
/// diagnostics.
729+
fn diagnose_failed_signature(
730+
&self,
731+
_arg_types: &[DataType],
732+
) -> Option<DataFusionError> {
733+
None
734+
}
735+
714736
/// If this function is max, return true
715737
/// If the function is min, return false
716738
/// Otherwise return None (the default)
@@ -1243,6 +1265,13 @@ impl AggregateUDFImpl for AliasedAggregateUDFImpl {
12431265
self.inner.coerce_types(arg_types)
12441266
}
12451267

1268+
fn diagnose_failed_signature(
1269+
&self,
1270+
arg_types: &[DataType],
1271+
) -> Option<DataFusionError> {
1272+
self.inner.diagnose_failed_signature(arg_types)
1273+
}
1274+
12461275
fn return_field(&self, arg_fields: &[FieldRef]) -> Result<FieldRef> {
12471276
self.inner.return_field(arg_fields)
12481277
}

‎datafusion/functions-aggregate/src/average.rs‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ use arrow::datatypes::{
3232
DurationSecondType, Field, FieldRef, Float64Type, TimeUnit, UInt64Type, i256,
3333
};
3434
use datafusion_common::types::{NativeType, logical_float64};
35-
use datafusion_common::{Result, ScalarValue, exec_err, not_impl_err};
35+
use datafusion_common::{
36+
DataFusionError, Result, ScalarValue, exec_err, not_impl_err, plan_datafusion_err,
37+
};
3638
use datafusion_expr::function::{AccumulatorArgs, StateFieldsArgs};
3739
use datafusion_expr::utils::format_state_name;
3840
use datafusion_expr::{
@@ -139,6 +141,18 @@ impl AggregateUDFImpl for Avg {
139141
&self.signature
140142
}
141143

144+
fn diagnose_failed_signature(
145+
&self,
146+
arg_types: &[DataType],
147+
) -> Option<DataFusionError> {
148+
match arg_types {
149+
[DataType::Boolean] => {
150+
Some(plan_datafusion_err!("Avg not supported for Boolean"))
151+
}
152+
_ => None,
153+
}
154+
}
155+
142156
fn return_type(&self, arg_types: &[DataType]) -> Result<DataType> {
143157
match &arg_types[0] {
144158
DataType::Decimal32(precision, scale) => {

‎datafusion/functions-aggregate/src/sum.rs‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ use datafusion_common::types::{
3131
NativeType, logical_float64, logical_int8, logical_int16, logical_int32,
3232
logical_int64, logical_uint8, logical_uint16, logical_uint32, logical_uint64,
3333
};
34-
use datafusion_common::{HashMap, Result, ScalarValue, exec_err, not_impl_err};
34+
use datafusion_common::{
35+
DataFusionError, HashMap, Result, ScalarValue, exec_err, not_impl_err,
36+
plan_datafusion_err,
37+
};
3538
use datafusion_expr::function::{AccumulatorArgs, StateFieldsArgs};
3639
use datafusion_expr::utils::{AggregateOrderSensitivity, format_state_name};
3740
use datafusion_expr::{
@@ -210,6 +213,18 @@ impl AggregateUDFImpl for Sum {
210213
&self.signature
211214
}
212215

216+
fn diagnose_failed_signature(
217+
&self,
218+
arg_types: &[DataType],
219+
) -> Option<DataFusionError> {
220+
match arg_types {
221+
[DataType::Boolean] => {
222+
Some(plan_datafusion_err!("Sum not supported for Boolean"))
223+
}
224+
_ => None,
225+
}
226+
}
227+
213228
fn return_type(&self, arg_types: &[DataType]) -> Result<DataType> {
214229
match &arg_types[0] {
215230
DataType::Int64 => Ok(DataType::Int64),

‎datafusion/functions-window/src/nth_value.rs‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use datafusion_doc::window_doc_sections::DOC_SECTION_ANALYTICAL;
2727
use datafusion_expr::window_state::WindowAggState;
2828
use datafusion_expr::{
2929
Documentation, LimitEffect, Literal, PartitionEvaluator, ReversedUDWF, Signature,
30-
TypeSignature, Volatility, WindowUDFImpl,
30+
Volatility, WindowUDFImpl,
3131
};
3232
use datafusion_functions_window_common::field;
3333
use datafusion_functions_window_common::partition::PartitionEvaluatorArgs;
@@ -93,17 +93,14 @@ pub struct NthValue {
9393
impl NthValue {
9494
/// Create a new `nth_value` function
9595
pub fn new(kind: NthValueKind) -> Self {
96-
Self {
97-
signature: Signature::one_of(
98-
vec![
99-
TypeSignature::Any(0),
100-
TypeSignature::Any(1),
101-
TypeSignature::Any(2),
102-
],
103-
Volatility::Immutable,
104-
),
105-
kind,
106-
}
96+
let signature = match kind {
97+
NthValueKind::First | NthValueKind::Last => {
98+
Signature::any(1, Volatility::Immutable)
99+
}
100+
NthValueKind::Nth => Signature::any(2, Volatility::Immutable),
101+
};
102+
103+
Self { signature, kind }
107104
}
108105

109106
pub fn first() -> Self {

‎datafusion/sql/tests/sql_integration.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4719,7 +4719,7 @@ fn test_error_message_invalid_scalar_function_signature() {
47194719
fn test_error_message_invalid_aggregate_function_signature() {
47204720
error_message_test(
47214721
"select sum()",
4722-
"Error during planning: Execution error: Function 'sum' user-defined coercion failed with \"Execution error: sum function requires 1 argument, got 0\"",
4722+
"Error during planning: Execution error: Function 'sum' user-defined coercion failed with: Execution error: sum function requires 1 argument, got 0",
47234723
);
47244724
// We keep two different prefixes because they clarify each other.
47254725
// It might be incorrect, and we should consider keeping only one.
@@ -4741,7 +4741,7 @@ fn test_error_message_invalid_window_function_signature() {
47414741
fn test_error_message_invalid_window_aggregate_function_signature() {
47424742
error_message_test(
47434743
"select sum() over()",
4744-
"Error during planning: Execution error: Function 'sum' user-defined coercion failed with \"Execution error: sum function requires 1 argument, got 0\"",
4744+
"Error during planning: Execution error: Function 'sum' user-defined coercion failed with: Execution error: sum function requires 1 argument, got 0",
47454745
);
47464746
}
47474747

‎datafusion/sqllogictest/test_files/array.slt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3361,7 +3361,7 @@ select
33613361
[1, 2, 3] List(Utf8View)
33623362

33633363
# array_concat error
3364-
query error DataFusion error: Error during planning: Execution error: Function 'array_concat' user-defined coercion failed with "Error during planning: array_concat does not support type Int64"
3364+
query error DataFusion error: Error during planning: Execution error: Function 'array_concat' user-defined coercion failed with: Error during planning: array_concat does not support type Int64
33653365
select array_concat(1, 2);
33663366

33673367
# array_concat scalar function #1
@@ -7241,17 +7241,17 @@ select generate_series(arrow_cast('2021-01-01T00:00:00', 'Timestamp(Nanosecond,
72417241
[2021-01-01T00:00:00-05:00, 2021-01-01T01:29:54.500-05:00, 2021-01-01T02:59:49-05:00, 2021-01-01T04:29:43.500-05:00, 2021-01-01T05:59:38-05:00]
72427242

72437243
## mixing types for timestamps is not supported
7244-
query error DataFusion error: Error during planning: Internal error: Function 'generate_series' failed to match any signature
7244+
query error DataFusion error: Error during planning: Function 'generate_series' failed to match any signature
72457245
select generate_series(arrow_cast('2021-01-01T00:00:00', 'Timestamp(Nanosecond, Some("-05:00"))'), DATE '2021-01-02', INTERVAL '1' HOUR);
72467246

72477247
## mixing types not allowed even if an argument is null
7248-
query error DataFusion error: Error during planning: Internal error: Function 'generate_series' failed to match any signature
7248+
query error DataFusion error: Error during planning: Function 'generate_series' failed to match any signature
72497249
select generate_series(TIMESTAMP '1992-09-01', DATE '1993-03-01', NULL);
72507250

7251-
query error DataFusion error: Error during planning: Internal error: Function 'generate_series' failed to match any signature
7251+
query error DataFusion error: Error during planning: Function 'generate_series' failed to match any signature
72527252
select generate_series(1, '2024-01-01', '2025-01-02');
72537253

7254-
query error DataFusion error: Error during planning: Internal error: Function 'generate_series' failed to match any signature
7254+
query error DataFusion error: Error during planning: Function 'generate_series' failed to match any signature
72557255
select generate_series('2024-01-01'::timestamp, '2025-01-02', interval '1 day');
72567256

72577257
## should return NULL

‎datafusion/sqllogictest/test_files/arrow_typeof.slt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ SELECT arrow_cast('1', 'Int16')
9595
query error
9696
SELECT arrow_cast('1')
9797

98-
query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\) but received NativeType::Int64, DataType: Int64
98+
query error Function 'arrow_cast' requires TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\), but received Int64 \(DataType: Int64\)
9999
SELECT arrow_cast('1', 43)
100100

101101
query error DataFusion error: Execution error: arrow_cast requires its second argument to be a non\-empty constant string

‎datafusion/sqllogictest/test_files/datetime/timestamps.slt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3009,7 +3009,7 @@ NULL
30093009
query error DataFusion error: Error during planning: Function 'make_date' expects 3 arguments but received 1
30103010
select make_date(1);
30113011

3012-
query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\) but received NativeType::Interval\(MonthDayNano\), DataType: Interval\(MonthDayNano\)
3012+
query error Function 'make_date' requires TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\), but received Interval\(MonthDayNano\) \(DataType: Interval\(MonthDayNano\)\)
30133013
select make_date(interval '1 day', '2001-05-21'::timestamp, '2001-05-21'::timestamp);
30143014

30153015
##########
@@ -3282,7 +3282,7 @@ select make_time(22, '', 27);
32823282
query error Cannot cast string '' to value of Int32 type
32833283
select make_time(22, 1, '');
32843284

3285-
query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\) but received NativeType::Float64, DataType: Float64
3285+
query error Function 'make_time' requires TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\), but received Float64 \(DataType: Float64\)
32863286
select make_time(arrow_cast(22, 'Float64'), 1, '');
32873287

32883288
##########
@@ -3897,7 +3897,7 @@ statement error
38973897
select to_local_time('2024-04-01T00:00:20Z'::timestamp, 'some string');
38983898

38993899
# invalid argument data type
3900-
statement error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Timestamp but received NativeType::String, DataType: Utf8
3900+
statement error DataFusion error: Error during planning: Function 'to_local_time' requires TypeSignatureClass::Timestamp, but received String \(DataType: Utf8\)
39013901
select to_local_time('2024-04-01T00:00:20Z');
39023902

39033903
# invalid timezone

‎datafusion/sqllogictest/test_files/encoding.slt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ CREATE TABLE test(
5555
;
5656

5757
# errors
58-
query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Binary but received NativeType::Int64, DataType: Int64
58+
query error DataFusion error: Error during planning: Function 'encode' requires TypeSignatureClass::Binary, but received Int64 \(DataType: Int64\)
5959
select encode(12, 'hex');
6060

61-
query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Binary but received NativeType::Int64, DataType: Int64
61+
query error DataFusion error: Error during planning: Function 'decode' requires TypeSignatureClass::Binary, but received Int64 \(DataType: Int64\)
6262
select decode(12, 'hex');
6363

6464
query error DataFusion error: Error during planning: There is no built\-in encoding named 'non_encoding', currently supported encodings are: base64, hex
@@ -73,7 +73,7 @@ select decode('', null) from test;
7373
query error DataFusion error: This feature is not implemented: Encoding must be a scalar; array specified encoding is not yet supported
7474
select decode('', hex_field) from test;
7575

76-
query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Integer but received NativeType::String, DataType: Utf8View
76+
query error DataFusion error: Error during planning: Function 'to_hex' requires TypeSignatureClass::Integer, but received String \(DataType: Utf8View\)
7777
select to_hex(hex_field) from test;
7878

7979
query error DataFusion error: Execution error: Failed to decode value using base64

0 commit comments

Comments
 (0)