spark-instrumented-optimizer/docs/sql-ref-syntax-aux-show-table.md
shivusondur eee45f83c6 [SPARK-28809][DOC][SQL] Document SHOW TABLE in SQL Reference
### What changes were proposed in this pull request?
Added the document reference for SHOW TABLE EXTENDED sql command

### Why are the changes needed?
For User reference

### Does this PR introduce any user-facing change?
yes, it provides document reference for SHOW TABLE EXTENDED sql command

### How was this patch tested?
verified in snap
<details>
<summary> Attached the Snap</summary>

![image](https://user-images.githubusercontent.com/7912929/68142029-b4f80680-ff54-11e9-99a0-f39f2dac09e4.png)
![image](https://user-images.githubusercontent.com/7912929/64019738-95f08900-cb4d-11e9-9769-ee2be926fdc1.png)
![image](https://user-images.githubusercontent.com/7912929/64019775-ab65b300-cb4d-11e9-9e7e-140616af7790.png)
![image](https://user-images.githubusercontent.com/7912929/67963910-65000380-fc25-11e9-9cd0-8ee43bf206b1.png)
</details>

Closes #25632 from shivusondur/jiraSHOWTABLE.

Authored-by: shivusondur <shivusondur@gmail.com>
Signed-off-by: Sean Owen <sean.owen@databricks.com>
2019-11-04 11:58:41 -06:00

9.9 KiB

layout title displayTitle license
global SHOW TABLE EXTENDED SHOW TABLE EXTENDED 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

SHOW TABLE EXTENDED will show information for all tables matching the given regular expression. Output includes basic table information and file system information like Last Access, Created By, Type, Provider, Table Properties, Location, Serde Library, InputFormat, OutputFormat, Storage Properties, Partition Provider, Partition Columns and Schema.

If a partition specification is present, it outputs the given partition's file-system-specific information such as Partition Parameters and Partition Statistics. Note that a table regex cannot be used with a partition specification.

Syntax

{% highlight sql %} SHOW TABLE EXTENDED [IN|FROM database_name] LIKE 'identifier_with_wildcards' [PARTITION(partition_spec)]; {% endhighlight %}

Parameters

IN|FROM database_name
Specifies database name. If not provided, will use the current database.
LIKE string_pattern
Specifies the regular expression pattern that is used to filter out unwanted tables.
  • Except for `*` and `|` character, the pattern works like a regex.
  • `*` alone matches 0 or more characters and `|` is used to separate multiple different regexes, any of which can match.
  • The leading and trailing blanks are trimmed in the input pattern before processing.
PARTITION(partition_spec)
Specifies partition column and its value which is exists in the table. Note that a table regex cannot be used with a partition specification..
### Examples {% highlight sql %} -- Assumes `employee` table created with partitioned by column `grade` -- +-------+--------+--+ -- | name | grade | -- +-------+--------+--+ -- | sam | 1 | -- | suj | 2 | -- +-------+--------+--+

-- Show the details of the table SHOW TABLE EXTENDED LIKE employee; +--------+---------+-----------+--------------------------------------------------------------- |database|tableName|isTemporary| information +--------+---------+-----------+--------------------------------------------------------------- |default |employee |false |Database: default Table: employee Owner: root Created Time: Fri Aug 30 15:10:21 IST 2019 Last Access: Thu Jan 01 05:30:00 IST 1970 Created By: Spark 3.0.0-SNAPSHOT Type: MANAGED Provider: hive Table Properties: [transient_lastDdlTime=1567158021] Location: file:/opt/spark1/spark/spark-warehouse/employee Serde Library: org.apache.hadoop.hive.serde2.lazy
.LazySimpleSerDe InputFormat: org.apache.hadoop.mapred.TextInputFormat OutputFormat: org.apache.hadoop.hive.ql.io .HiveIgnoreKeyTextOutputFormat Storage Properties: [serialization.format=1] Partition Provider: Catalog Partition Columns: [grade] Schema: root |-- name: string (nullable = true) |-- grade: integer (nullable = true)

+--------+---------+-----------+---------------------------------------------------------------

-- showing the multiple table details with pattern matching SHOW TABLE EXTENDED LIKE employe*; +--------+---------+-----------+--------------------------------------------------------------- |database|tableName|isTemporary| information +--------+---------+-----------+--------------------------------------------------------------- |default |employee |false |Database: default Table: employee Owner: root Created Time: Fri Aug 30 15:10:21 IST 2019 Last Access: Thu Jan 01 05:30:00 IST 1970 Created By: Spark 3.0.0-SNAPSHOT Type: MANAGED Provider: hive Table Properties: [transient_lastDdlTime=1567158021] Location: file:/opt/spark1/spark/spark-warehouse/employee Serde Library: org.apache.hadoop.hive.serde2.lazy .LazySimpleSerDe InputFormat: org.apache.hadoop.mapred.TextInputFormat OutputFormat: org.apache.hadoop.hive.ql.io .HiveIgnoreKeyTextOutputFormat Storage Properties: [serialization.format=1] Partition Provider: Catalog Partition Columns: [grade] Schema: root |-- name: string (nullable = true) |-- grade: integer (nullable = true)

|default |employee1|false |Database: default Table: employee1 Owner: root Created Time: Fri Aug 30 15:22:33 IST 2019 Last Access: Thu Jan 01 05:30:00 IST 1970 Created By: Spark 3.0.0-SNAPSHOT Type: MANAGED Provider: hive Table Properties: [transient_lastDdlTime=1567158753] Location: file:/opt/spark1/spark/spark-warehouse/employee1 Serde Library: org.apache.hadoop.hive.serde2.lazy .LazySimpleSerDe InputFormat: org.apache.hadoop.mapred.TextInputFormat OutputFormat: org.apache.hadoop.hive.ql.io .HiveIgnoreKeyTextOutputFormat Storage Properties: [serialization.format=1] Partition Provider: Catalog Schema: root |-- name: string (nullable = true)

+--------+---------+----------+----------------------------------------------------------------

-- show partition file system details SHOW TABLE EXTENDED IN default LIKE employee PARTITION (grade=1); +--------+---------+-----------+--------------------------------------------------------------- |database|tableName|isTemporary| information
+--------+---------+-----------+--------------------------------------------------------------- |default |employee |false | Partition Values: [grade=1] Location: file:/opt/spark1/spark/spark-warehouse/employee /grade=1 Serde Library: org.apache.hadoop.hive.serde2.lazy .LazySimpleSerDe InputFormat: org.apache.hadoop.mapred.TextInputFormat OutputFormat: org.apache.hadoop.hive.ql.io .HiveIgnoreKeyTextOutputFormat Storage Properties: [serialization.format=1] Partition Parameters: {rawDataSize=-1, numFiles=1, transient_lastDdlTime=1567158221, totalSize=4, COLUMN_STATS_ACCURATE=false, numRows=-1} Created Time: Fri Aug 30 15:13:41 IST 2019 Last Access: Thu Jan 01 05:30:00 IST 1970 Partition Statistics: 4 bytes | +--------+---------+-----------+---------------------------------------------------------------

-- show partition file system details with regex fails as shown below SHOW TABLE EXTENDED IN default LIKE empl* PARTITION (grade=1); Error: Error running query: org.apache.spark.sql.catalyst.analysis.NoSuchTableException: Table or view 'emplo*' not found in database 'default'; (state=,code=0)

{% endhighlight %}