Eren Avsarogullari created SPARK-31566:
------------------------------------------
Summary: Add SQL Rest API Documentation
Key: SPARK-31566
URL: https://issues.apache.org/jira/browse/SPARK-31566
Project: Spark
Issue Type: Documentation
Components: Documentation, SQL
Affects Versions: 3.1.0
Reporter: Eren Avsarogullari
SQL Rest API exposes query execution metrics as Public API. Its documentation
will be useful for end-users. Also, this is a follow-up jira with
https://issues.apache.org/jira/browse/SPARK-31440
{code:java}
/applications/[app-id]/sql
1- A list of all queries for a given application.
2- ?details=[true|false (default)] lists metric details in addition to queries
details.
3- ?details=true&planDescription=[true (default)|false]</code> enables/disables
Physical planDescription on demand when Physical Plan size is high.
4- ?offset=[offset]&length=[len] lists queries in the given range.{code}
{code:java}
/applications/[app-id]/sql/[execution-id]
1- ?details=[true|false (default)] lists metric details in addition to given
query details.
2- ?details=true&planDescription=[true (default)|false] enables/disables
Physical planDescription on demand for the given query when Physical Plan size
is high.{code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
