Skip to content

Apache DataFusion SQL Query Engine

minor: refactor with `assert_or_internal_err!()` in `datafusion/sql` (#18614)

Yongting Youfb765c234eb4
diff --git a/datafusion/sql/src/expr/identifier.rs b/datafusion/sql/src/expr/identifier.rs
index 3c57d195ad..498c58dd89 100644
--- a/datafusion/sql/src/expr/identifier.rs
+++ b/datafusion/sql/src/expr/identifier.rs
@@ -17,8 +17,9 @@
use arrow::datatypes::Field;
use datafusion_common::{
- exec_datafusion_err, internal_err, not_impl_err, plan_datafusion_err, plan_err,
- Column, DFSchema, Result, Span, TableReference,
+ assert_or_internal_err, exec_datafusion_err, internal_err, not_impl_err,
+ plan_datafusion_err, plan_err, Column, DFSchema, DataFusionError, Result, Span,
+ TableReference,
};
use datafusion_expr::planner::PlannerResult;
use datafusion_expr::{Case, Expr};
@@ -99,9 +100,7 @@ impl<S: ContextProvider> SqlToRel<'_, S> {
schema: &DFSchema,
planner_context: &mut PlannerContext,
) -> Result<Expr> {
- if ids.len() < 2 {
- return internal_err!("Not a compound identifier: {ids:?}");
- }
+ assert_or_internal_err!(ids.len() >= 2, "Not a compound identifier: {ids:?}");
let ids_span = Span::union_iter(
ids.iter()
diff --git a/datafusion/sql/src/unparser/expr.rs b/datafusion/sql/src/unparser/expr.rs
index 8dc3092e9c..10c34d5a4d 100644
--- a/datafusion/sql/src/unparser/expr.rs
+++ b/datafusion/sql/src/unparser/expr.rs
@@ -40,8 +40,8 @@ use arrow::datatypes::{
};
use arrow::util::display::array_value_to_string;
use datafusion_common::{
- internal_datafusion_err, internal_err, not_impl_err, plan_err, Column, Result,
- ScalarValue,
+ assert_eq_or_internal_err, assert_or_internal_err, internal_datafusion_err,
+ internal_err, not_impl_err, plan_err, Column, DataFusionError, Result, ScalarValue,
};
use datafusion_expr::{
expr::{Alias, Exists, InList, ScalarFunction, Sort, WindowFunction},
@@ -447,9 +447,7 @@ impl Unparser<'_> {
})
}
Expr::ScalarVariable(_, ids) => {
- if ids.is_empty() {
- return internal_err!("Not a valid ScalarVariable");
- }
+ assert_or_internal_err!(!ids.is_empty(), "Not a valid ScalarVariable");
Ok(if ids.len() == 1 {
ast::Expr::Identifier(
@@ -593,9 +591,11 @@ impl Unparser<'_> {
}
fn array_element_to_sql(&self, args: &[Expr]) -> Result<ast::Expr> {
- if args.len() != 2 {
- return internal_err!("array_element must have exactly 2 arguments");
- }
+ assert_eq_or_internal_err!(
+ args.len(),
+ 2,
+ "array_element must have exactly 2 arguments"
+ );
let array = self.expr_to_sql(&args[0])?;
let index = self.expr_to_sql(&args[1])?;
Ok(ast::Expr::CompoundFieldAccess {
@@ -605,9 +605,10 @@ impl Unparser<'_> {
}
fn named_struct_to_sql(&self, args: &[Expr]) -> Result<ast::Expr> {
- if !args.len().is_multiple_of(2) {
- return internal_err!("named_struct must have an even number of arguments");
- }
+ assert_or_internal_err!(
+ args.len().is_multiple_of(2),
+ "named_struct must have an even number of arguments"
+ );
let args = args
.chunks_exact(2)
@@ -628,9 +629,11 @@ impl Unparser<'_> {
}
fn get_field_to_sql(&self, args: &[Expr]) -> Result<ast::Expr> {
- if args.len() != 2 {
- return internal_err!("get_field must have exactly 2 arguments");
- }
+ assert_eq_or_internal_err!(
+ args.len(),
+ 2,
+ "get_field must have exactly 2 arguments"
+ );
let field = match &args[1] {
Expr::Literal(lit, _) => self.new_ident_quoted_if_needs(lit.to_string()),
@@ -672,9 +675,7 @@ impl Unparser<'_> {
}
fn map_to_sql(&self, args: &[Expr]) -> Result<ast::Expr> {
- if args.len() != 2 {
- return internal_err!("map must have exactly 2 arguments");
- }
+ assert_eq_or_internal_err!(args.len(), 2, "map must have exactly 2 arguments");
let ast::Expr::Array(Array { elem: keys, .. }) = self.expr_to_sql(&args[0])?
else {
diff --git a/datafusion/sql/src/unparser/plan.rs b/datafusion/sql/src/unparser/plan.rs
index 68b42ba05a..074ae994e6 100644
--- a/datafusion/sql/src/unparser/plan.rs
+++ b/datafusion/sql/src/unparser/plan.rs
@@ -39,7 +39,7 @@ use crate::unparser::utils::{find_unnest_node_until_relation, unproject_agg_expr
use crate::unparser::{ast::UnnestRelationBuilder, rewrite::rewrite_qualify};
use crate::utils::UNNEST_PLACEHOLDER;
use datafusion_common::{
- internal_err, not_impl_err,
+ assert_or_internal_err, internal_err, not_impl_err,
tree_node::{TransformedResult, TreeNode},
Column, DataFusionError, Result, ScalarValue, TableReference,
};
@@ -887,9 +887,10 @@ impl Unparser<'_> {
.map(|input| self.select_to_sql_expr(input, query))
.collect::<Result<Vec<_>>>()?;
- if input_exprs.len() < 2 {
- return internal_err!("UNION operator requires at least 2 inputs");
- }
+ assert_or_internal_err!(
+ input_exprs.len() >= 2,
+ "UNION operator requires at least 2 inputs"
+ );
let set_quantifier =
if query.as_ref().is_some_and(|q| q.is_distinct_union()) {
@@ -957,12 +958,11 @@ impl Unparser<'_> {
}
}
LogicalPlan::Unnest(unnest) => {
- if !unnest.struct_type_columns.is_empty() {
- return internal_err!(
- "Struct type columns are not currently supported in UNNEST: {:?}",
- unnest.struct_type_columns
- );
- }
+ assert_or_internal_err!(
+ unnest.struct_type_columns.is_empty(),
+ "Struct type columns are not currently supported in UNNEST: {:?}",
+ unnest.struct_type_columns
+ );
// In the case of UNNEST, the Unnest node is followed by a duplicate Projection node that we should skip.
// Otherwise, there will be a duplicate SELECT clause.
diff --git a/datafusion/sql/src/unparser/utils.rs b/datafusion/sql/src/unparser/utils.rs
index 8b3791017a..40d0d44136 100644
--- a/datafusion/sql/src/unparser/utils.rs
+++ b/datafusion/sql/src/unparser/utils.rs
@@ -22,7 +22,7 @@ use super::{
rewrite::TableAliasRewriter, Unparser,
};
use datafusion_common::{
- internal_err,
+ assert_eq_or_internal_err, internal_err,
tree_node::{Transformed, TransformedResult, TreeNode},
Column, DataFusionError, Result, ScalarValue,
};
@@ -520,12 +520,12 @@ pub(crate) fn sqlite_from_unixtime_to_sql(
unparser: &Unparser,
from_unixtime_args: &[Expr],
) -> Result<Option<ast::Expr>> {
- if from_unixtime_args.len() != 1 {
- return internal_err!(
- "from_unixtime for SQLite expects 1 argument, found {}",
- from_unixtime_args.len()
- );
- }
+ assert_eq_or_internal_err!(
+ from_unixtime_args.len(),
+ 1,
+ "from_unixtime for SQLite expects 1 argument, found {}",
+ from_unixtime_args.len()
+ );
Ok(Some(unparser.scalar_function_to_sql(
"datetime",
@@ -547,12 +547,12 @@ pub(crate) fn sqlite_date_trunc_to_sql(
unparser: &Unparser,
date_trunc_args: &[Expr],
) -> Result<Option<ast::Expr>> {
- if date_trunc_args.len() != 2 {
- return internal_err!(
- "date_trunc for SQLite expects 2 arguments, found {}",
- date_trunc_args.len()
- );
- }
+ assert_eq_or_internal_err!(
+ date_trunc_args.len(),
+ 2,
+ "date_trunc for SQLite expects 2 arguments, found {}",
+ date_trunc_args.len()
+ );
if let Expr::Literal(ScalarValue::Utf8(Some(unit)), _) = &date_trunc_args[0] {
let format = match unit.to_lowercase().as_str() {
diff --git a/datafusion/sql/src/utils.rs b/datafusion/sql/src/utils.rs
index 042ee53730..91ab2e003c 100644
--- a/datafusion/sql/src/utils.rs
+++ b/datafusion/sql/src/utils.rs
@@ -26,8 +26,8 @@ use datafusion_common::tree_node::{
Transformed, TransformedResult, TreeNode, TreeNodeRecursion, TreeNodeRewriter,
};
use datafusion_common::{
- exec_datafusion_err, exec_err, internal_err, plan_err, Column, DFSchemaRef,
- Diagnostic, HashMap, Result, ScalarValue,
+ assert_or_internal_err, exec_datafusion_err, exec_err, internal_err, plan_err,
+ Column, DFSchemaRef, DataFusionError, Diagnostic, HashMap, Result, ScalarValue,
};
use datafusion_expr::builder::get_struct_unnested_columns;
use datafusion_expr::expr::{
@@ -422,9 +422,10 @@ impl RecursiveUnnestRewriter<'_> {
match data_type {
DataType::Struct(inner_fields) => {
- if !struct_allowed {
- return internal_err!("unnest on struct can only be applied at the root level of select expression");
- }
+ assert_or_internal_err!(
+ struct_allowed,
+ "unnest on struct can only be applied at the root level of select expression"
+ );
push_projection_dedupl(
self.inner_projection_exprs,
expr_in_unnest.clone().alias(placeholder_name.clone()),
diff --git a/datafusion/sqllogictest/test_files/unnest.slt b/datafusion/sqllogictest/test_files/unnest.slt
index 5012181313..e650116a69 100644
--- a/datafusion/sqllogictest/test_files/unnest.slt
+++ b/datafusion/sqllogictest/test_files/unnest.slt
@@ -511,7 +511,7 @@ x y [30, 40, 50]
query error DataFusion error: type_coercion\ncaused by\nThis feature is not implemented: Unnest should be rewritten to LogicalPlan::Unnest before type coercion
select sum(unnest(generate_series(1,10)));
-query error DataFusion error: Internal error: unnest on struct can only be applied at the root level of select expression
+query error DataFusion error: Internal error: Assertion failed: struct_allowed: unnest on struct can only be applied at the root level of select expression
select arrow_typeof(unnest(column5)) from unnest_table;
query T
@@ -799,7 +799,7 @@ query error DataFusion error: Error during planning: Column in SELECT must be in
select unnest(column1) c1 from nested_unnest_table group by c1.c0;
# TODO: this query should work. see issue: https://github.com/apache/datafusion/issues/12794
-query error DataFusion error: Internal error: unnest on struct can only be applied at the root level of select expression
+query error DataFusion error: Internal error: Assertion failed: struct_allowed: unnest on struct can only be applied at the root level of select expression
select unnest(column1) c1 from nested_unnest_table
query II??I??