Skip to content

[SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation #28354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
erenavsarogullari wants to merge 5 commits into from
Closed

[SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation #28354

erenavsarogullari wants to merge 5 commits into from

Conversation

@erenavsarogullari
Copy link
Member

@erenavsarogullari erenavsarogullari commented Apr 27, 2020 •
edited
Loading

What changes were proposed in this pull request?

SQL Rest API exposes query execution details and metrics as Public API. Its documentation will be useful for the end-users.

Why are the changes needed?

SQL Rest API does not exist under Spark Rest API.

Does this PR introduce any user-facing change?

No

How was this patch tested?

Manually build and check

@erenavsarogullari
Copy link
Member Author

erenavsarogullari commented Apr 27, 2020

cc @gengliangwang @vanzin @dongjoon-hyun

@erenavsarogullari erenavsarogullari mentioned this pull request Apr 27, 2020
Closed
@SparkQA
Copy link

SparkQA commented Apr 27, 2020

Test build #121857 has finished for PR 28354 at commit 5c24141.

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

@SparkQA
Copy link

SparkQA commented Apr 27, 2020

Test build #121858 has finished for PR 28354 at commit 5723cdc.

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

@HyukjinKwon
Copy link
Member

HyukjinKwon commented Apr 27, 2020

I think you can just fold this into #28208.

@erenavsarogullari
Copy link
Member Author

erenavsarogullari commented Apr 27, 2020

Hi @HyukjinKwon,
Thanks for the review. I removed the dependency so current documentation just points the existing functionality on SqlResource. So, this can go independently now.

@HyukjinKwon
Copy link
Member

HyukjinKwon commented Apr 27, 2020

cc @gengliangwang FYI

@SparkQA
Copy link

SparkQA commented Apr 27, 2020

Test build #121869 has finished for PR 28354 at commit a082de8.

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

@gengliangwang
Copy link
Member

gengliangwang commented Apr 28, 2020

I think either a separate PR or folding into #28208 is fine.
Since #28208 is not merged yet, let's mark this one as WIP.

@gengliangwang gengliangwang changed the title [SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation [WIP][SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation Apr 28, 2020
@SparkQA
Copy link

SparkQA commented May 18, 2020

Test build #122817 has finished for PR 28354 at commit 5723cdc.

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

@SparkQA
Copy link

SparkQA commented May 18, 2020

Test build #122818 has finished for PR 28354 at commit 227cebe.

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

@gengliangwang
Copy link
Member

gengliangwang commented May 19, 2020

@erenavsarogullari You can continue on this one now
Please remove the [WIP] in the title and provide a screenshot of doc after built

@erenavsarogullari
Copy link
Member Author

erenavsarogullari commented May 30, 2020

Hi @gengliangwang,

This PR is up-to-date. Please find doc screenshot as attached
Doc Link: https://github.com/erenavsarogullari/spark/blob/SPARK-31566/docs/monitoring.md
Spark SQL Rest API Doc

@erenavsarogullari erenavsarogullari changed the title [WIP][SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation [SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation May 30, 2020
gengliangwang
gengliangwang reviewed May 30, 2020
View reviewed changes
@SparkQA
Copy link

SparkQA commented Jun 2, 2020

Test build #123419 has finished for PR 28354 at commit cf7b041.

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

@gengliangwang
Copy link
Member

gengliangwang commented Jun 2, 2020

Thanks, merging to master

@sarutak sarutak mentioned this pull request Aug 4, 2020
Closed
gengliangwang pushed a commit that referenced this pull request Aug 4, 2020
@sarutak @gengliangwang
[SPARK-32525][DOCS] The layout of monitoring.html is broken
0660a05 
### What changes were proposed in this pull request?

This PR fixes the layout of monitoring.html broken after SPARK-31566(#28354).
The cause is there are 2 `<td>` tags not closed in `monitoring.md`.

### Why are the changes needed?

This is a bug.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Build docs and the following screenshots are before/after.

* Before fixed
![broken-doc](https://user-images.githubusercontent.com/4736016/89257873-fba09b80-d661-11ea-90da-06cbc0783011.png)

* After fixed.
![fixed-doc2](https://user-images.githubusercontent.com/4736016/89257910-0fe49880-d662-11ea-9a85-7a1ecb1d38d6.png)

Of course, the table is still rendered correctly.
![fixed-doc1](https://user-images.githubusercontent.com/4736016/89257948-225ed200-d662-11ea-80fd-d9254b44d4a0.png)

Closes #29345 from sarutak/fix-monitoring.md.

Authored-by: Kousuke Saruta <[email protected]>
Signed-off-by: Gengliang Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gengliangwang gengliangwang gengliangwang left review comments

Assignees

No one assigned

Labels

DOCS

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@erenavsarogullari @SparkQA @HyukjinKwon @gengliangwang