[SPARK-49739][SQL] Throw Custom error condition for invalid options in SaveIntoDataSourceCommand class #48188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaxGekk
reviewed
Sep 20, 2024
| @@ -46,6 +46,10 @@ case class SaveIntoDataSourceCommand( | |||
| override def innerChildren: Seq[QueryPlan[_]] = Seq(query) | |||
|
|
|||
| override def run(sparkSession: SparkSession): Seq[Row] = { | |||
| if (options.values.exists(_ == null)) { | |||
There was a problem hiding this comment.
How about keys? Should we check them too?
There was a problem hiding this comment.
No, the keys cannot be null since Map[String, String] can't accept null keys.
| }, | ||
| "NULL_VALUE" : { | ||
| "message" : [ | ||
| "Values of keys and values in `map()` must be string, but got null in value." |
There was a problem hiding this comment.
Users can build values dynamically, and could be not clear which one is null. Let's help them in troubleshooting, and provide key which has the null value.
| @@ -2752,6 +2752,11 @@ | |||
| "message" : [ | |||
| "A type of keys and values in `map()` must be string, but got <mapType>." | |||
| ] | |||
| }, | |||
| "NULL_VALUE" : { | |||
There was a problem hiding this comment.
How about to re-use the existing error condition: NULL_DATA_SOURCE_OPTION?
There was a problem hiding this comment.
i actually missed this condition, it makes more sense
|
Master branch is guarded from the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
NullPointerException was thrown when invalid options were provided in the run function of SaveIntoDataSourceCommand up to now. That is because this map is propagated here, and java.util.Properties throws NPE if key/value is null. In map, a key cannot be null, but a value can, so that is why this NPE is possible to produce.
I propose we send the client an appropriate error condition. I've created a new error condition
INVALID_OPTIONS.NULL_VALUE. Options are checked, and the error is thrown if there exists an entry in options map where the value is null.Why are the changes needed?
To send the client an appropriate error.
Does this PR introduce any user-facing change?
Yes, in case invalid options are sent, we throw
INVALID_OPTIONS.NULL_VALUEinstead of NullPointerException.How was this patch tested?
Wrote a unit test.
Was this patch authored or co-authored using generative AI tooling?
No.