ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[SPARK-28806][DOCS][FOLLOW-UP] Remove unneeded HTML from the MD file

Browse source 
### 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 <gatorsmile@gmail.com>
Co-authored-by: gatorsmile <gatorsmile@gmail.com>
Signed-off-by: gatorsmile <gatorsmile@gmail.com>
This commit is contained in:
Xiao Li 2020-04-30 09:34:56 -07:00 committed by gatorsmile
parent c09cfb9808
commit b5ecc41c73
1 changed files with 22 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
docs/sql-ref-syntax-aux-show-columns.md
View file

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