[SPARK-28814][SQL][DOC] Document SET/RESET in SQL Reference #25606
Conversation
|
@dilipbiswal , @gatorsmile , Please review. Thanks |
|
@dilipbiswal , @huaxingao , @gatorsmile , Could you please review and let me know your comments. |
|
|
||
| ### Syntax | ||
| {% highlight sql %} | ||
| SET; |
There was a problem hiding this comment.
Can we remove the semi colon from the syntax ?
| ### Syntax | ||
| {% highlight sql %} | ||
| SET; | ||
| SET [ -v ]; |
| {% highlight sql %} | ||
| SET; | ||
| SET [ -v ]; | ||
| SET property_key[ =property_value ]; |
There was a problem hiding this comment.
ditto. Add a space after equal ?
|
|
||
| <dl> | ||
| <dt><code><em>property_key=property_value</em></code></dt> | ||
| <dd>Sets the value of specified property key.</dd> |
There was a problem hiding this comment.
Can we add that , "The new value overrides any existing value for the specified property key" ?
|
|
||
| **This page is under construction** | ||
| ### Description | ||
| Reset all SQLConf properties to the default values. After RESET command, executing SET command will output empty. |
There was a problem hiding this comment.
Can we say "Reset all the properties specific to the current session to their default values" ? I would like to remove SQLConf as even non sql properties are being cleared.
|
@dilipbiswal , Thanks for the review. Resubmitted the PR with updates. Please have a look. Thanks !!! |
| <dl> | ||
| <dt><code><em>property_key=property_value</em></code></dt> | ||
| <dd>Sets the value of specified property key.</dd> | ||
| <dd>The new value overrides any existing value for the specified property key.</dd> |
There was a problem hiding this comment.
@sharangk This makes it sound like it only supports a update op ? How about the following ?
Sets the value for a given property key. If an old value exists for a given property key, then it gets overridden by the new value.
|
LGTM - except a minor comment. |
|
@dilipbiswal , Thanks. Handled the review comments. |
|
LGTM |
|
ok to test |
|
Test build #110827 has finished for PR 25606 at commit
|
|
Thanks! Merged to master. |
5 participants
What changes were proposed in this pull request?
Document SET/REST statement in SQL Reference Guide.
Why are the changes needed?
Currently Spark lacks documentation on the supported SQL constructs causing
confusion among users who sometimes have to look at the code to understand the
usage. This is aimed at addressing this issue.
Does this PR introduce any user-facing change?
Yes.
Before:
There was no documentation for this.
After:
SET
RESET
How was this patch tested?
Manual Review and Tested using jykyll build --serve