[SPARK-45070][SQL][DOCS] Describe the binary and datetime formats of to_char/to_varchar
#42801
Conversation
This file contains hidden or 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
changed the title
to_char/to_varcharto_char/to_varchar
cloud-fan
reviewed
Sep 4, 2023
connector/connect/client/jvm/src/main/scala/org/apache/spark/sql/functions.scala
Show resolved
Hide resolved
cloud-fan
reviewed
Sep 4, 2023
cloud-fan
approved these changes
Sep 4, 2023
| * <li>'base64': a base 64 string.</li> | ||
| * <li>'hex': a string in the hexadecimal format.</li> | ||
| * <li>'utf-8': the input binary is decoded to UTF-8 string.</li> | ||
| * </ul> |
Member
There was a problem hiding this comment.
To @MaxGekk , it seems our Linter CI doesn't allow this kind of human-friendly formatting in the comment.
The scalafmt check failed on connector/connect at following occurrences:
Requires formatting: functions.scala
Before submitting your change, please make sure to format your code using the following command:
./build/mvn -Pscala-2.12 scalafmt:format -Dscalafmt.skip=false -Dscalafmt.validateOnly=false -Dscalafmt.changedOnly=false -pl connector/connect/common -pl connector/connect/server -pl connector/connect/client/jvm
Error: Process completed with exit code 1.
The recommended style is something like the following. Please fix the style by run the above command line.
- * brackets if the input value is negative.</li> </ul>
- * If `e` is a datetime, `format` shall be a valid datetime pattern, see
- * <a href="https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html">Datetime Patterns</a>.
- * If `e` is a binary, it is converted to a string in one of the formats:
- * <ul>
- * <li>'base64': a base 64 string.</li>
- * <li>'hex': a string in the hexadecimal format.</li>
- * <li>'utf-8': the input binary is decoded to UTF-8 string.</li>
- * </ul>
+ * brackets if the input value is negative.</li> </ul> If `e` is a datetime, `format` shall be
+ * a valid datetime pattern, see <a
+ * href="https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html">Datetime
+ * Patterns</a>. If `e` is a binary, it is converted to a string in one of the formats: <ul>
+ * <li>'base64': a base 64 string.</li> <li>'hex': a string in the hexadecimal format.</li>
+ * <li>'utf-8': the input binary is decoded to UTF-8 string.</li> </ul>
Member
Author
|
Merging to master. Thank you, @dongjoon-hyun and @cloud-fan for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
In the PR, I propose to document the recent changes related to the
formatof theto_char/to_varcharfunctions:to_charfor the formats:hex,base64,utf-8#42632to_char/to_varchar#42534Why are the changes needed?
To inform users about recent changes.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
By CI.
Was this patch authored or co-authored using generative AI tooling?
No.