a75dc80a76
### What changes were proposed in this pull request? Remove the unneeded embedded inline HTML markup by using the basic markdown syntax. Please see #28414 ### 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? Manually build and check Closes #28451 from huaxingao/html_cleanup. Authored-by: Huaxin Gao <huaxing@us.ibm.com> Signed-off-by: Sean Owen <srowen@gmail.com>
114 lines
3.5 KiB
Markdown
114 lines
3.5 KiB
Markdown
---
|
|
layout: global
|
|
title: SHOW TBLPROPERTIES
|
|
displayTitle: SHOW TBLPROPERTIES
|
|
license: |
|
|
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
|
|
|
|
This statement returns the value of a table property given an optional value for
|
|
a property key. If no key is specified then all the properties are returned.
|
|
|
|
### Syntax
|
|
|
|
```sql
|
|
SHOW TBLPROPERTIES table_identifier
|
|
[ ( unquoted_property_key | property_key_as_string_literal ) ]
|
|
```
|
|
|
|
### Parameters
|
|
|
|
* **table_identifier**
|
|
|
|
Specifies the table name of an existing table. The table may be optionally qualified
|
|
with a database name.
|
|
|
|
**Syntax:** `[ database_name. ] table_name`
|
|
|
|
* **unquoted_property_key**
|
|
|
|
Specifies the property key in unquoted form. The key may consists of multiple
|
|
parts separated by dot.
|
|
|
|
**Syntax:** `[ key_part1 ] [ .key_part2 ] [ ... ]`
|
|
|
|
* **property_key_as_string_literal**
|
|
|
|
Specifies a property key value as a string literal.
|
|
|
|
**Note**
|
|
- Property value returned by this statement excludes some properties
|
|
that are internal to spark and hive. The excluded properties are :
|
|
- All the properties that start with prefix `spark.sql`
|
|
- Property keys such as: `EXTERNAL`, `comment`
|
|
- All the properties generated internally by hive to store statistics. Some of these
|
|
properties are: `numFiles`, `numPartitions`, `numRows`.
|
|
|
|
### Examples
|
|
|
|
```sql
|
|
-- create a table `customer` in database `salesdb`
|
|
USE salesdb;
|
|
CREATE TABLE customer(cust_code INT, name VARCHAR(100), cust_addr STRING)
|
|
TBLPROPERTIES ('created.by.user' = 'John', 'created.date' = '01-01-2001');
|
|
|
|
-- show all the user specified properties for table `customer`
|
|
SHOW TBLPROPERTIES customer;
|
|
+---------------------+----------+
|
|
| key| value|
|
|
+---------------------+----------+
|
|
| created.by.user| John|
|
|
| created.date|01-01-2001|
|
|
|transient_lastDdlTime|1567554931|
|
|
+---------------------+----------+
|
|
|
|
-- show all the user specified properties for a qualified table `customer`
|
|
-- in database `salesdb`
|
|
SHOW TBLPROPERTIES salesdb.customer;
|
|
+---------------------+----------+
|
|
| key| value|
|
|
+---------------------+----------+
|
|
| created.by.user| John|
|
|
| created.date|01-01-2001|
|
|
|transient_lastDdlTime|1567554931|
|
|
+---------------------+----------+
|
|
|
|
-- show value for unquoted property key `created.by.user`
|
|
SHOW TBLPROPERTIES customer (created.by.user);
|
|
+-----+
|
|
|value|
|
|
+-----+
|
|
| John|
|
|
+-----+
|
|
|
|
-- show value for property `created.date`` specified as string literal
|
|
SHOW TBLPROPERTIES customer ('created.date');
|
|
+----------+
|
|
| value|
|
|
+----------+
|
|
|01-01-2001|
|
|
+----------+
|
|
```
|
|
|
|
### Related Statements
|
|
|
|
* [CREATE TABLE](sql-ref-syntax-ddl-create-table.html)
|
|
* [ALTER TABLE SET TBLPROPERTIES](sql-ref-syntax-ddl-alter-table.html)
|
|
* [SHOW TABLES](sql-ref-syntax-aux-show-tables.html)
|
|
* [SHOW TABLE EXTENDED](sql-ref-syntax-aux-show-table.html)
|