This is an automated email from the ASF dual-hosted git repository. lixiao pushed a commit to branch branch-3.0 in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.0 by this push: new f5e018e [SPARK-28806][DOCS][FOLLOW-UP] Remove unneeded HTML from the MD file f5e018e is described below commit f5e018edc71fd5ddf5ce4f82d02ac777bc3d7280 Author: Xiao Li <gatorsm...@gmail.com> AuthorDate: Thu Apr 30 09:34:56 2020 -0700 [SPARK-28806][DOCS][FOLLOW-UP] Remove unneeded HTML from the MD file ### What changes were proposed in this pull request? This PR is to clean up the markdown file in SHOW COLUMNS page. - remove the unneeded embedded inline HTML markup by using the basic markdown syntax. - use the ``` sql for highlighting the SQL syntax. ### Why are the changes needed? Make the doc cleaner and easily editable by MD editors. ### Does this PR introduce _any_ user-facing change? NO ### How was this patch tested? **Before** ![Screen Shot 2020-04-29 at 5 20 11 PM](https://user-images.githubusercontent.com/11567269/80661963-fa4d4a80-8a44-11ea-9dea-c43cda6de010.png) **After** ![Screen Shot 2020-04-29 at 6 03 50 PM](https://user-images.githubusercontent.com/11567269/80661940-f15c7900-8a44-11ea-9943-a83e8d8618fb.png) Closes #28414 from gatorsmile/cleanupShowColumns. Lead-authored-by: Xiao Li <gatorsm...@gmail.com> Co-authored-by: gatorsmile <gatorsm...@gmail.com> Signed-off-by: gatorsmile <gatorsm...@gmail.com> (cherry picked from commit b5ecc41c73018bbc742186d2e752101a99cfe852) Signed-off-by: gatorsmile <gatorsm...@gmail.com> --- docs/sql-ref-syntax-aux-show-columns.md | 51 ++++++++++++++------------------- 1 file changed, 22 insertions(+), 29 deletions(-) diff --git a/docs/sql-ref-syntax-aux-show-columns.md b/docs/sql-ref-syntax-aux-show-columns.md index 8f73aac..c8c90a9 100644 --- a/docs/sql-ref-syntax-aux-show-columns.md +++ b/docs/sql-ref-syntax-aux-show-columns.md @@ -25,41 +25,34 @@ Return the list of columns in a table. If the table does not exist, an exception ### Syntax -{% highlight sql %} +```sql SHOW COLUMNS table_identifier [ database ] -{% endhighlight %} +``` ### Parameters -<dl> - <dt><code><em>table_identifier</em></code></dt> - <dd> +* **table_identifier** + Specifies the table name of an existing table. The table may be optionally qualified - with a database name.<br><br> - <b>Syntax:</b> - <code> - { IN | FROM } [ database_name . ] table_name - </code><br><br> - <b>Note:</b> - Keywords <code>IN</code> and <code>FROM</code> are interchangeable. - </dd> - <dt><code><em>database</em></code></dt> - <dd> + with a database name. + + **Syntax:** `{ IN | FROM } [ database_name . ] table_name` + + **Note:** Keywords `IN` and `FROM` are interchangeable. + +* **database** + Specifies an optional database name. The table is resolved from this database when it - is specified. Please note that when this parameter is specified then table - name should not be qualified with a different database name. <br><br> - <b>Syntax:</b> - <code> - { IN | FROM } database_name - </code><br><br> - <b>Note:</b> - Keywords <code>IN</code> and <code>FROM</code> are interchangeable. - </dd> -</dl> + is specified. When this parameter is specified then table + name should not be qualified with a different database name. + + **Syntax:** `{ IN | FROM } database_name` + + **Note:** Keywords `IN` and `FROM` are interchangeable. ### Examples -{% highlight sql %} +```sql -- Create `customer` table in `salesdb` database; USE salesdb; CREATE TABLE customer( @@ -96,9 +89,9 @@ SHOW COLUMNS IN customer IN salesdb; | name| |cust_addr| +---------+ -{% endhighlight %} +``` ### Related Statements - * [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html) - * [SHOW TABLE](sql-ref-syntax-aux-show-table.html) +* [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html) +* [SHOW TABLE](sql-ref-syntax-aux-show-table.html) --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org