[SPARK-28802][DOC][SQL]Document DESCRIBE DATABASE statement in SQL Reference #25528
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
|
@kevinyu98 Can you please attach a screen-shot of the page ? |
srowen
requested changes
Aug 21, 2019
| @@ -18,5 +18,23 @@ license: | | |||
| See the License for the specific language governing permissions and | |||
| limitations under the License. | |||
| --- | |||
| ### Description | |||
| | |||
| Return the metadata of an existing database(name, comment and location). If the database does not exist, | |||
| Return the metadata of an existing database(name, comment and location). If the database does not exist, | ||
| an exception is thrown. | ||
|
|
||
| When `extended` is specified, it also shows the database's properties. |
|
|
||
| ### Example | ||
| {% highlight sql %} | ||
| DESCRIBE DATABASE EXTENDED tempdb |
There was a problem hiding this comment.
Can you provide any output? this doc page isn't giving much additional info (though there is not a lot to know, granted)
kevinyu98
force-pushed
the
sql-ref-describe
branch
from
a3595ac
to
25db698
Compare
dilipbiswal
reviewed
Sep 5, 2019
| ### Example | ||
| {% highlight sql %} | ||
| -- Create employees DATABASE | ||
| CREATE DATABASE EMPLOYEES COMMENT 'For software companies'; |
There was a problem hiding this comment.
@kevinyu98 lets use lowercase for EMPLOYEES to match other PRS..
dilipbiswal
reviewed
Sep 5, 2019
|
|
||
| -- Describe employees DATABASE. | ||
| -- Returns Database Name, Description and Root location of the filesystem for the employees DATABASE | ||
| DESCRIBE DATABASE Employees; |
dilipbiswal
reviewed
Sep 5, 2019
| CREATE DATABASE EMPLOYEES COMMENT 'For software companies'; | ||
|
|
||
| -- Describe employees DATABASE. | ||
| -- Returns Database Name, Description and Root location of the filesystem for the employees DATABASE |
There was a problem hiding this comment.
@kevinyu98 Can we please put DATABASE in another line with a comment marker. ?
dilipbiswal
reviewed
Sep 5, 2019
| -- Describe employees DATABASE. | ||
| -- Returns Database Name, Description and Root location of the filesystem for the employees DATABASE | ||
| DESCRIBE DATABASE Employees; | ||
| +-------------------------+-----------------------------+ |
There was a problem hiding this comment.
@kevinyu98 Can we keep the results 2 spaces to the right to match other PRs.
dilipbiswal
reviewed
Sep 5, 2019
|
|
||
| {% highlight sql %} | ||
| -- Create employees DATABASE | ||
| CREATE DATABASE EMPLOYEES COMMENT 'For software companies'; |
There was a problem hiding this comment.
@kevinyu98 lowercase employees.
dilipbiswal
reviewed
Sep 5, 2019
| -- Alter employees database to set DBPROPERTIES | ||
| ALTER DATABASE EMPLOYEES SET DBPROPERTIES ('Create-by' = 'Kevin', 'Create-date' = '09/01/2019'); | ||
|
|
||
| -- Describe employees DATABASE with EXTENDED option to the database properties |
There was a problem hiding this comment.
@kevinyu98 "to return additional database properties"
dilipbiswal
reviewed
Sep 5, 2019
|
|
||
| {% highlight sql %} | ||
| -- Create deployment SCHEMA | ||
| CREATE SCHEMA DEPLOYMENT comment 'Deployment environment'; |
There was a problem hiding this comment.
@kevinyu98 lowercase ..
|
LGTM |
|
ok to test |
|
Test build #110203 has finished for PR 25528 at commit
|
|
LGTM Thanks! Merged to master. |
|
@gatorsmile thank a lot. |
|
retest this please |
PavithraRamachandran
pushed a commit
to PavithraRamachandran/spark
that referenced
this pull request
Sep 15, 2019
…eference ### What changes were proposed in this pull request? Document DESCRIBE DATABASE statement in SQL Reference ### Why are the changes needed? To complete the SQL Reference ### Does this PR introduce any user-facing change? Yes #### Before There is no documentation for this command in sql reference #### After   ### How was this patch tested? Used jekyll build and serve to verify Closes apache#25528 from kevinyu98/sql-ref-describe. Lead-authored-by: Kevin Yu <qyu@us.ibm.com> Co-authored-by: Xiao Li <gatorsmile@gmail.com> Signed-off-by: Xiao Li <gatorsmile@gmail.com>
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?
Document DESCRIBE DATABASE statement in SQL Reference
Why are the changes needed?
To complete the SQL Reference
Does this PR introduce any user-facing change?
Yes
Before
There is no documentation for this command in sql reference
After
How was this patch tested?
Used jekyll build and serve to verify