maropu 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_r362435000
##########
File path: docs/sql-ref-syntax-qry-explain.md
##########
@@ -19,4 +19,112 @@ license: |
limitations under the License.
---
-**This page is under construction**
+### Description
+
+The `EXPLAIN` statement is used to provide logical/physical plans for an input
statement.
+By default, this clause provides information about a physical plan only.
+
+
+### Syntax
+{% highlight sql %}
+EXPLAIN [EXTENDED | CODEGEN | COST | FORMATTED] 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.
Review comment:
nit: please do not capitalize words in the middle of statements.
----------------------------------------------------------------
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]
