[GitHub] [spark] dilipbiswal commented on a change in pull request #25527: [SPARK-28803][DOC] Document DESCRIBE TABLE in SQL Reference

[GitBox <gi...@apache.org>]

dilipbiswal commented on a change in pull request #25527: [SPARK-28803][DOC] Document DESCRIBE TABLE in SQL Reference
URL: https://github.com/apache/spark/pull/25527#discussion_r316347952
 
 

 ##########
 File path: docs/sql-ref-syntax-aux-describe-table.md
 ##########
 @@ -18,5 +18,53 @@ license: |
   See the License for the specific language governing permissions and
   limitations under the License.
 ---
+### Description
+DESCRIBE TABLE statement is used to return the metadata information of a
+table. The basic metadata information includes column name, column type
+and column comment. If EXTENDED mode is specified then additional
+metadata such as parent database, owner, created and last access time etc.
+are returned. Optionally a partition spec or column name can be specified
+to return the metadata pertaining to the partition or column respectively.
 
-**This page is under construction**
+### Syntax
+{% highlight sql %}
+{DESC | DESCRIBE} [TABLE] [format] tableIdentifier [partition-spec] [desc-col]
+
+format:= EXTENDED | FORMATTED
+tableIdentifier:= [db.][table]
+parition-spec:= PARTITION (part_col1 = value1, part_col2 = value2, ...) 
+desc-col:= [db.][table.]column-name
+{% endhighlight %}
+**Note**<br>
 
 Review comment:
   @srowen No.. did not need it. Not sure why i put it in the first place. Thanks for catching it.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org