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

Closed
erenavsarogullari wants to merge 5 commits into from
Closed

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

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c24141
Add SQL Rest API Documentation
Apr 27, 2020
5723cdc
Remove line-breaks
Apr 27, 2020
227cebe
Update documentation in the light of all Http parameters details
May 18, 2020
cf7b041
Review comment is being addressed
erenavsarogullari Jun 2, 2020
84739cd
Update monitoring.md
gengliangwang Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,24 @@ can be identified by their `[attempt-id]`. In the API listed below, when running
<td><code>/applications/[app-id]/streaming/batches/[batch-id]/operations/[outputOp-id]</code></td>
<td>Details of the given operation and given batch.</td>
</tr>
<tr>
<td><code>/applications/[app-id]/sql</code></td>
<td>A list of all queries for a given application.
<br>
<code>?details=[true (default) | false]</code> lists metric details in addition to queries details.
<br>
<code>?planDescription=[true (default) | false]</code> enables/disables Physical <code>planDescription</code> on demand when Physical Plan size is high.
<br>
<code>?offset=[offset]&length=[len]</code> lists queries in the given range.
</tr>
<tr>
<td><code>/applications/[app-id]/sql/[execution-id]</code></td>
<td>Details for the given query.
<br>
<code>?details=[true (default) | false]</code> lists metric details in addition to given query details.
<br>
<code>?planDescription=[true (default) | false]</code> enables/disables Physical <code>planDescription</code> on demand for the given query when Physical Plan size is high.
</tr>
<tr>
<td><code>/applications/[app-id]/environment</code></td>
<td>Environment details of the given application.</td>
Expand Down