Apache DataFusion SQL Query Engine
Fix issue #24701 Better error when the query contains reserved names (#24715)
Ruchir Tripathi5bae63e7125c
diff --git a/datafusion/sql/src/statement.rs b/datafusion/sql/src/statement.rsindex 1a9072212f..dde9420a68 100644--- a/datafusion/sql/src/statement.rs+++ b/datafusion/sql/src/statement.rs@@ -227,23 +227,22 @@ fn calc_inline_constraints_from_columns(columns: &[ColumnDef]) -> Vec<TableConstimpl<S: ContextProvider> SqlToRel<'_, S> {/// Generate a logical plan from an DataFusion SQL statementpub fn statement_to_plan(&self, statement: DFStatement) -> Result<LogicalPlan> {- match statement {- DFStatement::CreateExternalTable(s) => self.external_table_to_plan(s),- DFStatement::Statement(s) => self.sql_statement_to_plan(*s),- DFStatement::CopyTo(s) => self.copy_to_plan(s),+ let plan = match statement {+ DFStatement::CreateExternalTable(s) => self.external_table_to_plan(s)?,+ DFStatement::Statement(s) => self.sql_statement_to_plan(*s)?,+ DFStatement::CopyTo(s) => self.copy_to_plan(s)?,DFStatement::Explain(ExplainStatement { options, statement }) => {- self.explain_to_plan(options, *statement)+ self.explain_to_plan(options, *statement)?}- DFStatement::Reset(statement) => self.reset_statement_to_plan(statement),- }+ DFStatement::Reset(statement) => self.reset_statement_to_plan(statement)?,+ };+ check_plan(&plan)?;+ Ok(plan)}/// Generate a logical plan from an SQL statementpub fn sql_statement_to_plan(&self, statement: Statement) -> Result<LogicalPlan> {- self.sql_statement_to_plan_with_context_impl(- statement,- &mut PlannerContext::new(),- )+ self.sql_statement_to_plan_with_context(statement, &mut PlannerContext::new())}/// Generate a logical plan from an SQL statement@@ -252,7 +251,10 @@ impl<S: ContextProvider> SqlToRel<'_, S> {statement: Statement,planner_context: &mut PlannerContext,) -> Result<LogicalPlan> {- self.sql_statement_to_plan_with_context_impl(statement, planner_context)+ let plan =+ self.sql_statement_to_plan_with_context_impl(statement, planner_context)?;+ check_plan(&plan)?;+ Ok(plan)}fn sql_statement_to_plan_with_context_impl(@@ -3186,3 +3188,20 @@ FROM (}}}++fn check_plan(plan: &LogicalPlan) -> Result<()> {+ use datafusion_common::plan_err;+ use datafusion_common::tree_node::{TreeNode, TreeNodeRecursion};+ plan.apply(|node| {+ for field in node.schema().fields() {+ if field.name().starts_with("__common_expr") {+ return plan_err!(+ "{} is a reserved DataFusion column name, please use another name",+ field.name()+ );+ }+ }+ Ok(TreeNodeRecursion::Continue)+ })+ .map(|_| ())+}diff --git a/datafusion/sql/tests/sql_integration.rs b/datafusion/sql/tests/sql_integration.rsindex 9f57aaafb0..1fadca5eff 100644--- a/datafusion/sql/tests/sql_integration.rs+++ b/datafusion/sql/tests/sql_integration.rs@@ -5850,3 +5850,43 @@ impl HigherOrderUDFImpl for MockArrayReduce {unreachable!()}}++#[test]+fn test_reserved_column_name() {+ let sql = "SELECT 1 AS __common_expr_1";+ let err = logical_plan(sql).unwrap_err().strip_backtrace();+ assert_eq!(+ err,+ "Error during planning: __common_expr_1 is a reserved DataFusion column name, please use another name"+ );+}++#[test]+fn test_reserved_column_name_copy() {+ let sql = "COPY (SELECT 1 AS __common_expr_1) TO 'output.csv' STORED AS CSV";+ let err = logical_plan(sql).unwrap_err().strip_backtrace();+ assert_eq!(+ err,+ "Error during planning: __common_expr_1 is a reserved DataFusion column name, please use another name"+ );+}++#[test]+fn test_reserved_column_name_boundary() {+ let sql = "SELECT 1 AS user__common_expr_1";+ let plan = logical_plan(sql).unwrap();+ assert_eq!(+ format!("{plan}"),+ "Projection: Int64(1) AS user__common_expr_1\n EmptyRelation: rows=1"+ );+}++#[test]+fn test_reserved_column_name_explain_copy() {+ let sql = "EXPLAIN COPY (SELECT 1 AS __common_expr_1) TO 'output.csv' STORED AS CSV";+ let err = logical_plan(sql).unwrap_err().strip_backtrace();+ assert_eq!(+ err,+ "Error during planning: __common_expr_1 is a reserved DataFusion column name, please use another name"+ );+}