jonahgao commented on code in PR #13651:
URL: https://github.com/apache/datafusion/pull/13651#discussion_r1896844656
##########
datafusion/optimizer/src/optimizer.rs:
##########
@@ -384,9 +396,26 @@ impl Optimizer {
// rule handles recursion itself
None => optimize_plan_node(new_plan, rule.as_ref(),
config),
}
- // verify the rule didn't change the schema
.and_then(|tnr| {
- assert_schema_is_the_same(rule.name(), &starting_schema,
&tnr.data)?;
+ // run checks optimizer invariant checks, per pass
+ assert_valid_optimization(&tnr.data, &starting_schema)
+ .map_err(|e| {
+ DataFusionError::Context(
+ format!("check_optimizer_specific_invariants
after optimizer pass: {}", rule.name()),
Review Comment:
I think it should be "after optimizer rule"
##########
datafusion/expr/src/logical_plan/invariants.rs:
##########
@@ -15,14 +15,98 @@
// specific language governing permissions and limitations
// under the License.
-use crate::analyzer::check_plan;
-use crate::utils::collect_subquery_cols;
+use datafusion_common::{
+ plan_err,
+ tree_node::{TreeNode, TreeNodeRecursion},
+ DFSchemaRef, DataFusionError, Result,
+};
-use datafusion_common::tree_node::{TreeNode, TreeNodeRecursion};
-use datafusion_common::{plan_err, Result};
-use datafusion_expr::expr_rewriter::strip_outer_reference;
-use datafusion_expr::utils::split_conjunction;
-use datafusion_expr::{Aggregate, Expr, Filter, Join, JoinType, LogicalPlan,
Window};
+use crate::{
+ expr::{Exists, InSubquery},
+ expr_rewriter::strip_outer_reference,
+ utils::{collect_subquery_cols, split_conjunction},
+ Aggregate, Expr, Filter, Join, JoinType, LogicalPlan, Window,
+};
+
+pub enum InvariantLevel {
+ /// Invariants that are always true in DataFusion `LogicalPlan`s
+ /// such as the number of expected children and no duplicated output fields
+ Always,
+ /// Invariants that must hold true for the plan to be "executable"
+ /// such as the type and number of function arguments are correct and
+ /// that wildcards have been expanded
+ ///
+ /// To ensure a LogicalPlan satisfies the `Executable` inariants, run the
+ /// `Analyzer`
+ Executable,
+}
+
+pub fn assert_required_invariants(plan: &LogicalPlan) -> Result<()> {
+ // Refer to
<https://datafusion.apache.org/contributor-guide/specification/invariants.html#relation-name-tuples-in-logical-fields-and-logical-columns-are-unique>
+ assert_unique_field_names(plan)?;
+
+ Ok(())
+}
+
+pub fn assert_executable_invariants(plan: &LogicalPlan) -> Result<()> {
+ assert_required_invariants(plan)?;
+ assert_valid_semantic_plan(plan)?;
+ Ok(())
+}
+
+/// Returns an error if plan, and subplans, do not have unique fields.
+///
+/// This invariant is subject to change.
+/// refer:
<https://github.com/apache/datafusion/issues/13525#issuecomment-2494046463>
+fn assert_unique_field_names(plan: &LogicalPlan) -> Result<()> {
+ plan.schema().check_names()
+}
+
+/// Returns an error if the plan is not sematically valid.
+fn assert_valid_semantic_plan(plan: &LogicalPlan) -> Result<()> {
+ assert_subqueries_are_valid(plan)?;
+
+ Ok(())
+}
+
+/// Returns an error if the plan does not have the expected schema.
+/// Ignores metadata and nullability.
+pub fn assert_expected_schema(schema: &DFSchemaRef, plan: &LogicalPlan) ->
Result<()> {
+ let equivalent = plan.schema().equivalent_names_and_types(schema);
+
+ if !equivalent {
+ Err(DataFusionError::Internal(format!(
Review Comment:
Use the `internal_err!` macro would be simpler
```sh
internal_err!("Failed due to a difference in schemas, original schema:
{:?}, new schema: {:?}",
schema,
plan.schema()
)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
