[SPARK-31566][SQL][DOCS] Add SQL Rest API Documentation
### 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 Closes #28354 from erenavsarogullari/SPARK-31566. Lead-authored-by: Eren Avsarogullari <eren.avsarogullari@gmail.com> Co-authored-by: Gengliang Wang <gengliang.wang@databricks.com> Co-authored-by: Eren Avsarogullari <erenavsarogullari@gmail.com> Signed-off-by: Gengliang Wang <gengliang.wang@databricks.com>
This commit is contained in:
parent
25702281dc
commit
979593d708
|
@ -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/hides details of Spark plan nodes.
|
||||
<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/hides 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>
|
||||
|
|
Loading…
Reference in a new issue