Apache DataFusion SQL Query Engine
Improve error message when string functions receive Binary types (#19819)
Miaocf76352d90b8
diff --git a/datafusion/expr/src/type_coercion/functions.rs b/datafusion/expr/src/type_coercion/functions.rsindex e1f2a19672..34147d1973 100644--- a/datafusion/expr/src/type_coercion/functions.rs+++ b/datafusion/expr/src/type_coercion/functions.rs@@ -635,8 +635,13 @@ fn get_valid_types(default_casted_type.default_cast_for(current_type)?;new_types.push(casted_type);} else {- return internal_err!(- "Expect {} but received NativeType::{}, DataType: {}",+ let hint = if matches!(current_native_type, NativeType::Binary) {+ "\n\nHint: Binary types are not automatically coerced to String. Use CAST(column AS VARCHAR) to convert Binary data to String."+ } else {+ ""+ };+ return plan_err!(+ "Function '{function_name}' requires {}, but received {} (DataType: {}).{hint}",param.desired_type(),current_native_type,current_typediff --git a/datafusion/sqllogictest/test_files/arrow_typeof.slt b/datafusion/sqllogictest/test_files/arrow_typeof.sltindex ee1f204664..d6f9ffadcf 100644--- a/datafusion/sqllogictest/test_files/arrow_typeof.slt+++ b/datafusion/sqllogictest/test_files/arrow_typeof.slt@@ -95,7 +95,7 @@ SELECT arrow_cast('1', 'Int16')query errorSELECT arrow_cast('1')-query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\) but received NativeType::Int64, DataType: Int64+query error DataFusion error: Error during planning: Function 'arrow_cast' requires TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\), but received Int64 \(DataType: Int64\)SELECT arrow_cast('1', 43)query error DataFusion error: Execution error: arrow_cast requires its second argument to be a non\-empty constant stringdiff --git a/datafusion/sqllogictest/test_files/binary.slt b/datafusion/sqllogictest/test_files/binary.sltindex 1077c32e46..c4a21deeff 100644--- a/datafusion/sqllogictest/test_files/binary.slt+++ b/datafusion/sqllogictest/test_files/binary.slt@@ -311,3 +311,13 @@ Foo foo Foo fooNULL NULL NULL NULLBar Bar Bar BarFooBar fooBar FooBar fooBar++# show helpful error msg when Binary type is used with string functions+query error DataFusion error: Error during planning: Function 'split_part' requires TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\), but received Binary \(DataType: Binary\)\.\n\nHint: Binary types are not automatically coerced to String\. Use CAST\(column AS VARCHAR\) to convert Binary data to String\.+SELECT split_part(binary, '~', 2) FROM t WHERE binary IS NOT NULL LIMIT 1;++# ensure the suggested CAST workaround works+query T+SELECT split_part(CAST(binary AS VARCHAR), 'o', 2) FROM t WHERE binary = X'466f6f';+----+(empty)diff --git a/datafusion/sqllogictest/test_files/datetime/timestamps.slt b/datafusion/sqllogictest/test_files/datetime/timestamps.sltindex efa7a536c8..f0b3a480c8 100644--- a/datafusion/sqllogictest/test_files/datetime/timestamps.slt+++ b/datafusion/sqllogictest/test_files/datetime/timestamps.slt@@ -3064,7 +3064,7 @@ NULLquery error DataFusion error: Error during planning: Function 'make_date' expects 3 arguments but received 1select make_date(1);-query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\) but received NativeType::Interval\(MonthDayNano\), DataType: Interval\(MonthDayNano\)+query error DataFusion error: Error during planning: Function 'make_date' requires TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\), but received Interval\(MonthDayNano\) \(DataType: Interval\(MonthDayNano\)\)select make_date(interval '1 day', '2001-05-21'::timestamp, '2001-05-21'::timestamp);##########@@ -3337,7 +3337,7 @@ select make_time(22, '', 27);query error Cannot cast string '' to value of Int32 typeselect make_time(22, 1, '');-query error Expect TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\) but received NativeType::Float64, DataType: Float64+query error DataFusion error: Error during planning: Function 'make_time' requires TypeSignatureClass::Native\(LogicalType\(Native\(Int32\), Int32\)\), but received Float64 \(DataType: Float64\)select make_time(arrow_cast(22, 'Float64'), 1, '');##########@@ -3952,7 +3952,7 @@ statement errorselect to_local_time('2024-04-01T00:00:20Z'::timestamp, 'some string');# invalid argument data type-statement error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Timestamp but received NativeType::String, DataType: Utf8+statement error DataFusion error: Error during planning: Function 'to_local_time' requires TypeSignatureClass::Timestamp, but received String \(DataType: Utf8\)select to_local_time('2024-04-01T00:00:20Z');# invalid timezonediff --git a/datafusion/sqllogictest/test_files/encoding.slt b/datafusion/sqllogictest/test_files/encoding.sltindex ef91eade01..1b1acbc385 100644--- a/datafusion/sqllogictest/test_files/encoding.slt+++ b/datafusion/sqllogictest/test_files/encoding.slt@@ -55,10 +55,10 @@ CREATE TABLE test(;# errors-query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Binary but received NativeType::Int64, DataType: Int64+query error DataFusion error: Error during planning: Function 'encode' requires TypeSignatureClass::Binary, but received Int64 \(DataType: Int64\)select encode(12, 'hex');-query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Binary but received NativeType::Int64, DataType: Int64+query error DataFusion error: Error during planning: Function 'decode' requires TypeSignatureClass::Binary, but received Int64 \(DataType: Int64\)select decode(12, 'hex');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;query error DataFusion error: This feature is not implemented: Encoding must be a scalar; array specified encoding is not yet supportedselect decode('', hex_field) from test;-query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Integer but received NativeType::String, DataType: Utf8View+query error DataFusion error: Error during planning: Function 'to_hex' requires TypeSignatureClass::Integer, but received String \(DataType: Utf8View\)select to_hex(hex_field) from test;query error DataFusion error: Execution error: Failed to decode value using base64diff --git a/datafusion/sqllogictest/test_files/expr.slt b/datafusion/sqllogictest/test_files/expr.sltindex cec9b63675..00b5816327 100644--- a/datafusion/sqllogictest/test_files/expr.slt+++ b/datafusion/sqllogictest/test_files/expr.slt@@ -589,7 +589,7 @@ select repeat('-1.2', arrow_cast(3, 'Int32'));-----1.2-1.2-1.2-query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Native\(LogicalType\(Native\(Int64\), Int64\)\) but received NativeType::Float64, DataType: Float64+query error DataFusion error: Error during planning: Function 'repeat' requires TypeSignatureClass::Native\(LogicalType\(Native\(Int64\), Int64\)\), but received Float64 \(DataType: Float64\)select repeat('-1.2', 3.2);query Tdiff --git a/datafusion/sqllogictest/test_files/scalar.slt b/datafusion/sqllogictest/test_files/scalar.sltindex b0307c4630..39f53f865b 100644--- a/datafusion/sqllogictest/test_files/scalar.slt+++ b/datafusion/sqllogictest/test_files/scalar.slt@@ -2069,7 +2069,7 @@ select position('' in '')----1-query error DataFusion error: Error during planning: Internal error: Expect TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\) but received NativeType::Int64, DataType: Int64+query error DataFusion error: Error during planning: Function 'strpos' requires TypeSignatureClass::Native\(LogicalType\(Native\(String\), String\)\), but received Int64 \(DataType: Int64\)select position(1 in 1)query I