[GitHub] [spark] srowen commented on a change in pull request #25528: [SPARK-28802][DOC][SQL]Document DESCRIBE DATABASE statement in SQL Reference

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

srowen commented on a change in pull request #25528: [SPARK-28802][DOC][SQL]Document DESCRIBE DATABASE statement in SQL Reference
URL: https://github.com/apache/spark/pull/25528#discussion_r316328605
 
 

 ##########
 File path: docs/sql-ref-syntax-aux-describe-database.md
 ##########
 @@ -18,5 +18,23 @@ license: |
   See the License for the specific language governing permissions and
   limitations under the License.
 ---
+### Description
+​
+Return the metadata of an existing database(name, comment and location). If the database does not exist,
+an exception is thrown.
+
+When `extended` is specified, it also shows the database's properties.
+ 
+You can use the abbreviation `DESC` for the `DESCRIBE` statement.
+
+### Syntax
+{% highlight sql %}
+[DESC | DESCRIBE] DATABASE [EXTENDED] db_name 
+{% endhighlight %}
+
+### Example
+{% highlight sql %}
+DESCRIBE DATABASE EXTENDED tempdb
 
 Review comment:
   Can you provide any output? this doc page isn't giving much additional info (though there is not a lot to know, granted)

----------------------------------------------------------------
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