[SPARK-43361][PROTOBUF] update documentation for errors related to enum serialization #41188
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
justaparth
changed the title
justaparth
changed the title
justaparth
force-pushed
the
parth/update-documentation-enum-error-message
branch
from
36bf491
to
8a30c34
Compare
rangadi
approved these changes
May 16, 2023
| @@ -120,7 +120,7 @@ private[sql] class ProtobufSerializer( | |||
| catalystPath, | |||
| toFieldStr(protoPath), | |||
| data.toString, | |||
| enumValues.mkString("", ",", "")) | |||
| enumValues.mkString("", ", ", "")) | |||
There was a problem hiding this comment.
This can be replaced with enumValues.mkString(", ")
| "sqlColumn" -> "`basic_enum`", | ||
| "protobufColumn" -> "field 'basic_enum'", | ||
| "data" -> "9999", | ||
| "enumString" -> "0, 1, 2")) |
There was a problem hiding this comment.
I see, we print the integer values if the the column is int?
| "message" : [ | ||
| "Cannot convert SQL <sqlColumn> to Protobuf <protobufColumn> because schema is incompatible (protobufType = <protobufType>, sqlType = <sqlType>)." | ||
| "Cannot convert SQL <sqlColumn> to Protobuf <protobufColumn> because <data> is not defined in ENUM <enumString>." |
There was a problem hiding this comment.
<enumString>
Should this be something like allowed values (<enumString>)?
|
@justaparth could you take a look at the comments? Would like to merge asap. |
justaparth
force-pushed
the
parth/update-documentation-enum-error-message
branch
from
8a30c34
to
a4e032b
Compare
|
@rangadi just updated to respond to your comments! |
|
Thank you! |
|
cc @HyukjinKwon would you mind taking a look and merging this one? thanks 🙏 |
zhengruifeng
approved these changes
May 19, 2023
|
merged to master |
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?
Follows-up on the comment here: #41075 (comment)
Namely:
error-classes.jsonandsql-error-conditions.mdto have the updated error name.Why are the changes needed?
Improve documentation
Does this PR introduce any user-facing change?
Yes, documentation.
How was this patch tested?
Existing unit tests