You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "ganeshashree (via GitHub)" <gi...@apache.org> on 2025/11/01 15:25:54 UTC
[PR] [SPARK-54130][SQL] Add detailed error messages for catalog assertion failures [spark]
ganeshashree opened a new pull request, #52826:
URL: https://github.com/apache/spark/pull/52826
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR enhances error reporting in the catalog layer by adding detailed, user-friendly assertion messages for various metadata validation failures. The changes add informative error messages to 11 bare `assert()` statements across the catalog codebase.
**Files modified:**
- `SessionCatalog.scala`: Enhanced 5 assertions with detailed error messages
- `interface.scala`: Enhanced 2 assertions (UnresolvedCatalogRelation, HiveTableRelation)
- `SQLFunction.scala`: Enhanced 2 assertions for function validation
- `InMemoryCatalog.scala`: Enhanced 2 assertions for table operations
- `SessionCatalogSuite.scala`: Added 6 new unit tests to verify error messages
**Enhanced assertions include:**
- Table identifier validation (missing database names)
- SQL function body validation (missing expression/query text)
- SQL function type validation (mismatched function type and return type)
- Function plan method validation (wrong method called for function type)
- Table function return parameter validation
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Currently, when metadata validation fails, assertions fail with generic "assertion failed" messages that provide no context about:
- Which table/function has the problem
- What the actual vs expected values are
- What specific validation failed
- How to resolve the issue
This makes debugging production issues very difficult, especially for:
- Missing database names in table identifiers
- Malformed SQL function definitions
- Type mismatches in SQL functions
- Internal method call errors
The enhanced error messages provide all necessary information to quickly identify and resolve issues.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as new features, bug fixes, or other behavior changes. Documentation-only updates are not considered user-facing changes.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes. Users will now see detailed error messages instead of generic assertion failures.
**Before:**
assertion failed
**After:**
assertion failed: Table identifier test_table is missing database name.
UnresolvedCatalogRelation requires a fully qualified table identifier with database.
**Example for SQL functions:**
assertion failed: SQL function 'test_func' is missing function body.
Either exprText or queryText must be defined. Found: exprText=None, queryText=None.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Added 6 new unit tests in `SessionCatalogSuite.scala` that:
- Create scenarios that trigger each assertion
- Verify that AssertionError is thrown
- Validate the complete error message matches expected format
**Test coverage:**
- `test("UnresolvedCatalogRelation requires database in identifier")`
- `test("HiveTableRelation requires database in identifier")`
- `test("SQLFunction requires either exprText or queryText")`
- `test("SQLFunction return type must match function type")`
- `test("InMemoryCatalog.createTable requires database in identifier")`
- `test("InMemoryCatalog.alterTable requires database in identifier")`
All existing tests continue to pass.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
Generated-by: Claude 3.5 Sonnet (Anthropic)
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-54130][SQL] Add detailed error messages for catalog assertion failures [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on PR #52826:
URL: https://github.com/apache/spark/pull/52826#issuecomment-3522037819
thanks, merging to master/4.1!
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org