Skip to content

Commit b5ecc41

Browse files
committed
[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 apache#28414 from gatorsmile/cleanupShowColumns. Lead-authored-by: Xiao Li <[email protected]> Co-authored-by: gatorsmile <[email protected]> Signed-off-by: gatorsmile <[email protected]>
1 parent c09cfb9 commit b5ecc41

File tree

1 file changed

+22
-29
lines changed

1 file changed

+22
-29
lines changed

docs/sql-ref-syntax-aux-show-columns.md

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,41 +25,34 @@ Return the list of columns in a table. If the table does not exist, an exception
2525

2626
### Syntax
2727

28-
{% highlight sql %}
28+
```sql
2929
SHOW COLUMNS table_identifier [ database ]
30-
{% endhighlight %}
30+
```
3131

3232
### Parameters
3333

34-
<dl>
35-
<dt><code><em>table_identifier</em></code></dt>
36-
<dd>
34+
* **table_identifier**
35+
3736
Specifies the table name of an existing table. The table may be optionally qualified
38-
with a database name.<br><br>
39-
<b>Syntax:</b>
40-
<code>
41-
{ IN | FROM } [ database_name . ] table_name
42-
</code><br><br>
43-
<b>Note:</b>
44-
Keywords <code>IN</code> and <code>FROM</code> are interchangeable.
45-
</dd>
46-
<dt><code><em>database</em></code></dt>
47-
<dd>
37+
with a database name.
38+
39+
**Syntax:** `{ IN | FROM } [ database_name . ] table_name`
40+
41+
**Note:** Keywords `IN` and `FROM` are interchangeable.
42+
43+
* **database**
44+
4845
Specifies an optional database name. The table is resolved from this database when it
49-
is specified. Please note that when this parameter is specified then table
50-
name should not be qualified with a different database name. <br><br>
51-
<b>Syntax:</b>
52-
<code>
53-
{ IN | FROM } database_name
54-
</code><br><br>
55-
<b>Note:</b>
56-
Keywords <code>IN</code> and <code>FROM</code> are interchangeable.
57-
</dd>
58-
</dl>
46+
is specified. When this parameter is specified then table
47+
name should not be qualified with a different database name.
48+
49+
**Syntax:** `{ IN | FROM } database_name`
50+
51+
**Note:** Keywords `IN` and `FROM` are interchangeable.
5952

6053
### Examples
6154

62-
{% highlight sql %}
55+
```sql
6356
-- Create `customer` table in `salesdb` database;
6457
USE salesdb;
6558
CREATE TABLE customer(
@@ -96,9 +89,9 @@ SHOW COLUMNS IN customer IN salesdb;
9689
| name|
9790
|cust_addr|
9891
+---------+
99-
{% endhighlight %}
92+
```
10093

10194
### Related Statements
10295

103-
* [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html)
104-
* [SHOW TABLE](sql-ref-syntax-aux-show-table.html)
96+
* [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html)
97+
* [SHOW TABLE](sql-ref-syntax-aux-show-table.html)

0 commit comments

Comments
 (0)