HyukjinKwon commented on a change in pull request #26970:
[SPARK-28825][SQL][DOC] Documentation for Explain Command
URL: https://github.com/apache/spark/pull/26970#discussion_r360743754
##########
File path: docs/sql-ref-syntax-qry-explain.md
##########
@@ -19,4 +19,157 @@ license: |
limitations under the License.
---
-**This page is under construction**
+### Description
+
+The `EXPLAIN` statement provides the execution plan for the statement.
+By default, `EXPLAIN` provides information about the physical plan.
+`EXPLAIN` does not support 'DESCRIBE TABLE' statement.
+
+
+### Syntax
+{% highlight sql %}
+EXPLAIN [EXTENDED | CODEGEN] statement
+{% endhighlight %}
+
+### Parameters
+
+<dl>
+ <dt><code><em>EXTENDED</em></code></dt>
+ <dd>Generates Parsed Logical Plan, Analyzed Logical Plan, Optimized Logical
Plan and Physical Plan.</dd>
+</dl>
+
+<dl>
+ <dt><code><em>CODEGEN</em></code></dt>
+ <dd>Generates code for the statement, if any.</dd>
Review comment:
You can also refer the documentations at
https://github.com/apache/spark/blob/master/sql/core/src/main/scala/org/apache/spark/sql/execution/ExplainMode.scala#L29-L57
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
