spark-instrumented-optimizer/docs/sql-ref-syntax-aux-show-columns.md
Huaxin Gao babefdee1c [SPARK-30085][SQL][DOC] Standardize sql reference
### What changes were proposed in this pull request?
Standardize sql reference

### Why are the changes needed?
To have consistent docs

### Does this PR introduce any user-facing change?
Yes

### How was this patch tested?
Tested using jykyll build --serve

Closes #26721 from huaxingao/spark-30085.

Authored-by: Huaxin Gao <huaxing@us.ibm.com>
Signed-off-by: Sean Owen <sean.owen@databricks.com>
2019-12-02 09:05:40 -06:00

2.8 KiB

layout title displayTitle license
global SHOW COLUMNS SHOW COLUMNS Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Description

Return the list of columns in a table. If the table does not exist, an exception is thrown.

Syntax

{% highlight sql %} SHOW COLUMNS table_identifier [ database ] {% endhighlight %}

Parameters

table_identifier
Specifies the table name of an existing table. The table may be optionally qualified 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.

Syntax: { IN | FROM } database_name

Note: Keywords IN and FROM are interchangeable.

Examples

{% highlight sql %} -- Create customer table in salesdb database; USE salesdb; CREATE TABLE customer(cust_cd INT, name VARCHAR(100), cust_addr STRING);

-- List the columns of customer table in current database. SHOW COLUMNS IN customer; +---------+ |col_name | +---------+ |cust_cd | |name | |cust_addr| +---------+

-- List the columns of customer table in salesdb database. SHOW COLUMNS IN salesdb.customer; +---------+ |col_name | +---------+ |cust_cd | |name | |cust_addr| +---------+

-- List the columns of customer table in salesdb database SHOW COLUMNS IN customer IN salesdb; +---------+ |col_name | +---------+ |cust_cd | |name | |cust_addr| +---------+ {% endhighlight %}