This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/master by this push:
new f995de5 Improve field not found error messages (#625)
f995de5 is described below
commit f995de59c0f83156ddd0a1e9ab274cb43225a307
Author: Andy Grove <[email protected]>
AuthorDate: Sun Jun 27 04:57:43 2021 -0600
Improve field not found error messages (#625)
---
datafusion/src/logical_plan/dfschema.rs | 50 +++++++++++++++++++++++++++++----
datafusion/src/sql/planner.rs | 12 ++++----
2 files changed, 50 insertions(+), 12 deletions(-)
diff --git a/datafusion/src/logical_plan/dfschema.rs
b/datafusion/src/logical_plan/dfschema.rs
index e754add..b46e067 100644
--- a/datafusion/src/logical_plan/dfschema.rs
+++ b/datafusion/src/logical_plan/dfschema.rs
@@ -135,14 +135,18 @@ impl DFSchema {
&self.fields[i]
}
- /// Find the index of the column with the given unqualifed name
+ /// Find the index of the column with the given unqualified name
pub fn index_of(&self, name: &str) -> Result<usize> {
for i in 0..self.fields.len() {
if self.fields[i].name() == name {
return Ok(i);
}
}
- Err(DataFusionError::Plan(format!("No field named '{}'", name)))
+ Err(DataFusionError::Plan(format!(
+ "No field named '{}'. Valid fields are {}.",
+ name,
+ self.get_field_names()
+ )))
}
/// Find the index of the column with the given qualifer and name
@@ -181,8 +185,9 @@ impl DFSchema {
.collect();
match matches.len() {
0 => Err(DataFusionError::Plan(format!(
- "No field with unqualified name '{}'",
- name
+ "No field with unqualified name '{}'. Valid fields are {}.",
+ name,
+ self.get_field_names()
))),
1 => Ok(matches[0].to_owned()),
_ => Err(DataFusionError::Plan(format!(
@@ -207,8 +212,10 @@ impl DFSchema {
.collect();
match matches.len() {
0 => Err(DataFusionError::Plan(format!(
- "No field named '{}.{}'",
- relation_name, name
+ "No field named '{}.{}'. Valid fields are {}.",
+ relation_name,
+ name,
+ self.get_field_names()
))),
1 => Ok(matches[0].to_owned()),
_ => Err(DataFusionError::Internal(format!(
@@ -273,6 +280,15 @@ impl DFSchema {
.collect(),
}
}
+
+ /// Get comma-seperated list of field names for use in error messages
+ fn get_field_names(&self) -> String {
+ self.fields
+ .iter()
+ .map(|f| format!("'{}'", f.name()))
+ .collect::<Vec<_>>()
+ .join(", ")
+ }
}
impl Into<Schema> for DFSchema {
@@ -586,6 +602,28 @@ mod tests {
}
#[test]
+ fn helpful_error_messages() -> Result<()> {
+ let schema = DFSchema::try_from_qualified_schema("t1",
&test_schema_1())?;
+ let expected_help = "Valid fields are \'c0\', \'c1\'.";
+ assert!(schema
+ .field_with_qualified_name("x", "y")
+ .unwrap_err()
+ .to_string()
+ .contains(expected_help));
+ assert!(schema
+ .field_with_unqualified_name("y")
+ .unwrap_err()
+ .to_string()
+ .contains(expected_help));
+ assert!(schema
+ .index_of("y")
+ .unwrap_err()
+ .to_string()
+ .contains(expected_help));
+ Ok(())
+ }
+
+ #[test]
fn into() {
// Demonstrate how to convert back and forth between Schema,
SchemaRef, DFSchema, and DFSchemaRef
let arrow_schema = Schema::new(vec![Field::new("c0", DataType::Int64,
true)]);
diff --git a/datafusion/src/sql/planner.rs b/datafusion/src/sql/planner.rs
index 1718123..0691ce6 100644
--- a/datafusion/src/sql/planner.rs
+++ b/datafusion/src/sql/planner.rs
@@ -1650,7 +1650,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'doesnotexist'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'doesnotexist'"),
));
}
@@ -1708,7 +1708,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'doesnotexist'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'doesnotexist'"),
));
}
@@ -1718,7 +1718,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'x'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'x'"),
));
}
@@ -2189,7 +2189,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'doesnotexist'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'doesnotexist'"),
));
}
@@ -2279,7 +2279,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'doesnotexist'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'doesnotexist'"),
));
}
@@ -2289,7 +2289,7 @@ mod tests {
let err = logical_plan(sql).expect_err("query should have failed");
assert!(matches!(
err,
- DataFusionError::Plan(msg) if msg == "No field with unqualified
name 'doesnotexist'",
+ DataFusionError::Plan(msg) if msg.contains("No field with
unqualified name 'doesnotexist'"),
));
}
