[SPARK-48976][SQL][DOCS] Improve the docs related to variable
#47460
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
Contributor
Author
|
Additionally, the syntax seems 
Should we unify it?
|
Contributor
Author
panbingkun
commented
Jul 23, 2024
| If you did not qualify the name with a schema and catalog, verify the current_schema() output, or qualify the name with the correct schema and catalog. | ||
| To tolerate the error on drop use DROP VARIABLE IF EXISTS. SQLSTATE: 42883 | ||
|
|
||
| -- Drop temporart variable if it exists |
Contributor
Author
There was a problem hiding this comment.
typo
temporart -> temporary
panbingkun
commented
Jul 23, 2024
| Choose a different name, or drop or replace the existing variable. SQLSTATE: 42723 | ||
|
|
||
| -- Use `DECLARE OR REPLACE` to declare a defined variable | ||
| DECLARE OR REPLACE five = 55; |
Contributor
Author
There was a problem hiding this comment.
The usage of DECLARE OR REPLACE does not exist in the doc
Contributor
There was a problem hiding this comment.
to double check, the doc does mention it but we don't show it in the example, right?
Contributor
Author
There was a problem hiding this comment.
Yes, this doc mentions it in the Syntax section, but don't show it in the example.
HyukjinKwon
approved these changes
Jul 24, 2024
Member
|
Merged to master. |
ilicmarkodb
pushed a commit
to ilicmarkodb/spark
that referenced
this pull request
Jul 29, 2024
### What changes were proposed in this pull request? The pr aims to improve the docs related to `variable`, includes: - `docs/sql-ref-syntax-aux-set-var.md`, show the `primitive` error messages. - `docs/sql-ref-syntax-ddl-declare-variable.md`, add usage of `DECLARE OR REPLACE`. - `docs/sql-ref-syntax-ddl-drop-variable.md`, show the `primitive` error messages and fix `typo`. ### Why are the changes needed? Only improve docs. ### Does this PR introduce _any_ user-facing change? Yes, make end-user docs clearer. ### How was this patch tested? Manually test. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#47460 from panbingkun/SPARK-48976. Authored-by: panbingkun <panbingkun@baidu.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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?
The pr aims to improve the docs related to
variable, includes:docs/sql-ref-syntax-aux-set-var.md, show theprimitiveerror messages.docs/sql-ref-syntax-ddl-declare-variable.md, add usage ofDECLARE OR REPLACE.docs/sql-ref-syntax-ddl-drop-variable.md, show theprimitiveerror messages and fixtypo.Why are the changes needed?
Only improve docs.
Does this PR introduce any user-facing change?
Yes, make end-user docs clearer.
How was this patch tested?
Manually test.
Was this patch authored or co-authored using generative AI tooling?
No.