Skip to content

Conversation

@dilipbiswal
Copy link
Contributor

@dilipbiswal dilipbiswal commented Aug 21, 2019

What changes were proposed in this pull request?

Document DESCRIBE QUERY 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.
Screen Shot 2019-08-29 at 5 47 51 PM
Screen Shot 2019-08-29 at 5 48 06 PM
Screen Shot 2019-08-29 at 5 48 18 PM

How was this patch tested?

Tested using jykyll build --serve

@SparkQA
Copy link

SparkQA commented Aug 21, 2019

Test build #109473 has finished for PR 25529 at commit 5f1df99.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@dilipbiswal
Copy link
Contributor Author

cc @gatorsmile


**This page is under construction**
### Description
The DESCRIBE QUERY statement is used to return the metadata of output
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back tick the reserved words

@srowen
Copy link
Member

srowen commented Aug 21, 2019

PS you might look at the other similar PRs to add these docs to try to harmonize the style and format a little bit. They're pretty similar. That can mean reviewing others' changes.

@SparkQA
Copy link

SparkQA commented Aug 21, 2019

Test build #109515 has finished for PR 25529 at commit 719c717.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@dilipbiswal dilipbiswal changed the title [SPARK-28804][DOC] Document DESCRIBE QUERY in SQL Reference [SPARK-28804][DOCS][SQL] Document DESCRIBE QUERY in SQL Reference Aug 24, 2019
@SparkQA
Copy link

SparkQA commented Aug 30, 2019

Test build #109925 has finished for PR 25529 at commit 4d6f415.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Aug 30, 2019

Test build #109926 has finished for PR 25529 at commit 8fe2b67.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@gatorsmile
Copy link
Member

LGTM

Thanks! Merged to master.

@dilipbiswal
Copy link
Contributor Author

@gatorsmile Thank you for fixing the mistake and merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants