Google Git
Sign in
apache / spark-website / asf-site / . / site / docs / 4.1.0-preview1 / sql-ref-syntax-aux-describe-table.html
blob: d5c8123f8d4c58ed8423680a2862e88aff7c4ddb [file] [log] [blame]
<!DOCTYPE html>
<html class="no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DESCRIBE TABLE - Spark 4.1.0-preview1 Documentation</title>
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,wght@0,400;0,500;0,700;1,400;1,500;1,700&Courier+Prime:wght@400;700&display=swap" rel="stylesheet">
<link href="css/custom.css" rel="stylesheet">
<script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script>
<link rel="stylesheet" href="css/pygments-default.css">
<link rel="stylesheet" href="css/docsearch.min.css" />
<link rel="stylesheet" href="css/docsearch.css">
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '40']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body class="global">
<!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html -->
<nav class="navbar navbar-expand-lg navbar-dark p-0 px-4 fixed-top" style="background: #1d6890;" id="topbar">
<div class="navbar-brand"><a href="index.html">
<img src="https://spark.apache.org/images/spark-logo-rev.svg" width="141" height="72"/></a><span class="version">4.1.0-preview1</span>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#navbarCollapse" aria-controls="navbarCollapse"
aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="navbar-nav me-auto">
<li class="nav-item"><a href="index.html" class="nav-link">Overview</a></li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" id="navbarQuickStart" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Programming Guides</a>
<div class="dropdown-menu" aria-labelledby="navbarQuickStart">
<a class="dropdown-item" href="quick-start.html">Quick Start</a>
<a class="dropdown-item" href="rdd-programming-guide.html">RDDs, Accumulators, Broadcasts Vars</a>
<a class="dropdown-item" href="sql-programming-guide.html">SQL, DataFrames, and Datasets</a>
<a class="dropdown-item" href="streaming/index.html">Structured Streaming</a>
<a class="dropdown-item" href="streaming-programming-guide.html">Spark Streaming (DStreams)</a>
<a class="dropdown-item" href="ml-guide.html">MLlib (Machine Learning)</a>
<a class="dropdown-item" href="graphx-programming-guide.html">GraphX (Graph Processing)</a>
<a class="dropdown-item" href="sparkr.html">SparkR (R on Spark)</a>
<a class="dropdown-item" href="api/python/getting_started/index.html">PySpark (Python on Spark)</a>
<a class="dropdown-item" href="declarative-pipelines-programming-guide.html">Declarative Pipelines</a>
</div>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" id="navbarAPIDocs" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">API Docs</a>
<div class="dropdown-menu" aria-labelledby="navbarAPIDocs">
<a class="dropdown-item" href="api/python/index.html">Python</a>
<a class="dropdown-item" href="api/scala/org/apache/spark/index.html">Scala</a>
<a class="dropdown-item" href="api/java/index.html">Java</a>
<a class="dropdown-item" href="api/R/index.html">R</a>
<a class="dropdown-item" href="api/sql/index.html">SQL, Built-in Functions</a>
</div>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" id="navbarDeploying" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Deploying</a>
<div class="dropdown-menu" aria-labelledby="navbarDeploying">
<a class="dropdown-item" href="cluster-overview.html">Overview</a>
<a class="dropdown-item" href="submitting-applications.html">Submitting Applications</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="spark-standalone.html">Spark Standalone</a>
<a class="dropdown-item" href="running-on-yarn.html">YARN</a>
<a class="dropdown-item" href="running-on-kubernetes.html">Kubernetes</a>
</div>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" id="navbarMore" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">More</a>
<div class="dropdown-menu" aria-labelledby="navbarMore">
<a class="dropdown-item" href="configuration.html">Configuration</a>
<a class="dropdown-item" href="monitoring.html">Monitoring</a>
<a class="dropdown-item" href="tuning.html">Tuning Guide</a>
<a class="dropdown-item" href="job-scheduling.html">Job Scheduling</a>
<a class="dropdown-item" href="security.html">Security</a>
<a class="dropdown-item" href="hardware-provisioning.html">Hardware Provisioning</a>
<a class="dropdown-item" href="migration-guide.html">Migration Guide</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="building-spark.html">Building Spark</a>
<a class="dropdown-item" href="https://spark.apache.org/contributing.html">Contributing to Spark</a>
<a class="dropdown-item" href="https://spark.apache.org/third-party-projects.html">Third Party Projects</a>
</div>
</li>
<li class="nav-item">
<input type="text" id="docsearch-input" placeholder="Search the docs…">
</li>
</ul>
<!--<span class="navbar-text navbar-right"><span class="version-text">v4.1.0-preview1</span></span>-->
</div>
</nav>
<div class="container">
<div class="left-menu-wrapper">
<div class="left-menu">
<h3><a href="sql-programming-guide.html">Spark SQL Guide</a></h3>
<ul>
<li>
<a href="sql-getting-started.html">
Getting Started
</a>
</li>
<li>
<a href="sql-data-sources.html">
Data Sources
</a>
</li>
<li>
<a href="sql-performance-tuning.html">
Performance Tuning
</a>
</li>
<li>
<a href="sql-distributed-sql-engine.html">
Distributed SQL Engine
</a>
</li>
<li>
<a href="sql-pyspark-pandas-with-arrow.html">
PySpark Usage Guide for Pandas with Apache Arrow
</a>
</li>
<li>
<a href="sql-migration-guide.html">
Migration Guide
</a>
</li>
<li>
<a href="sql-ref.html">
SQL Reference
</a>
</li>
<ul>
<li>
<a href="sql-ref-ansi-compliance.html">
ANSI Compliance
</a>
</li>
<li>
<a href="sql-ref-datatypes.html">
Data Types
</a>
</li>
<li>
<a href="sql-ref-datetime-pattern.html">
Datetime Pattern
</a>
</li>
<li>
<a href="sql-ref-number-pattern.html">
Number Pattern
</a>
</li>
<li>
<a href="sql-ref-operators.html">
Operators
</a>
</li>
<li>
<a href="sql-ref-functions.html">
Functions
</a>
</li>
<li>
<a href="sql-ref-identifier.html">
Identifiers
</a>
</li>
<li>
<a href="sql-ref-identifier-clause.html">
IDENTIFIER clause
</a>
</li>
<li>
<a href="sql-ref-literals.html">
Literals
</a>
</li>
<li>
<a href="sql-ref-null-semantics.html">
Null Semantics
</a>
</li>
<li>
<a href="sql-ref-syntax.html">
SQL Syntax
</a>
</li>
<ul>
<li>
<a href="sql-ref-syntax.html#ddl-statements">
Data Definition Statements
</a>
</li>
<li>
<a href="sql-ref-syntax.html#dml-statements">
Data Manipulation Statements
</a>
</li>
<li>
<a href="sql-ref-syntax.html#data-retrieval-statements">
Data Retrieval(Queries)
</a>
</li>
<li>
<a href="sql-ref-syntax.html#auxiliary-statements">
Auxiliary Statements
</a>
</li>
<li>
<a href="sql-pipe-syntax.html">
Pipe Syntax
</a>
</li>
</ul>
</ul>
<li>
<a href="sql-error-conditions.html">
Error Conditions
</a>
</li>
</ul>
</div>
</div>
<input id="nav-trigger" class="nav-trigger" checked type="checkbox">
<label for="nav-trigger"></label>
<div class="content-with-sidebar mr-3" id="content">
<h1 class="title">DESCRIBE TABLE</h1>
<h3 id="description">Description</h3>
<p><code class="language-plaintext highlighter-rouge">DESCRIBE TABLE</code> statement returns the basic metadata information of a
table. The metadata information includes column name, column type
and column comment. Optionally a partition spec or column name may be specified
to return the metadata pertaining to a partition or column respectively.</p>
<h3 id="syntax">Syntax</h3>
<div class="language-sql highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span> <span class="k">DESC</span> <span class="o">|</span> <span class="k">DESCRIBE</span> <span class="p">}</span> <span class="p">[</span> <span class="k">TABLE</span> <span class="p">]</span> <span class="p">[</span> <span class="n">format</span> <span class="p">]</span> <span class="n">table_identifier</span> <span class="p">[</span> <span class="n">partition_spec</span> <span class="p">]</span> <span class="p">[</span> <span class="n">col_name</span> <span class="p">]</span> <span class="p">[</span> <span class="k">AS</span> <span class="n">JSON</span> <span class="p">]</span>
</code></pre></div></div>
<h3 id="parameters">Parameters</h3>
<ul>
<li>
<p><strong>format</strong></p>
<p>Specifies the optional format of describe output. If <code class="language-plaintext highlighter-rouge">EXTENDED</code> or <code class="language-plaintext highlighter-rouge">FORMATTED</code> is specified
then additional metadata information (such as parent database, owner, and access time)
is returned. Also if <code class="language-plaintext highlighter-rouge">EXTENDED</code> or <code class="language-plaintext highlighter-rouge">FORMATTED</code> is specified, then the metadata can be returned
in JSON format by specifying <code class="language-plaintext highlighter-rouge">AS JSON</code> at the end of the statement.</p>
</li>
<li>
<p><strong>table_identifier</strong></p>
<p>Specifies a table name, which may be optionally qualified with a database name.</p>
<p><strong>Syntax:</strong> <code class="language-plaintext highlighter-rouge">[ database_name. ] table_name</code></p>
</li>
<li>
<p><strong>partition_spec</strong></p>
<p>An optional parameter that specifies a comma separated list of key and value pairs
for partitions. When specified, additional partition metadata is returned.</p>
<p><strong>Syntax:</strong> <code class="language-plaintext highlighter-rouge">PARTITION ( partition_col_name = partition_col_val [ , ... ] )</code></p>
</li>
<li>
<p><strong>col_name</strong></p>
<p>An optional parameter that specifies the column name that needs to be described.
The supplied column name may be optionally qualified. Parameters <code class="language-plaintext highlighter-rouge">partition_spec</code>
and <code class="language-plaintext highlighter-rouge">col_name</code> are mutually exclusive and can not be specified together. Currently
nested columns are not allowed to be specified.</p>
<p>JSON format is not currently supported for individual columns.</p>
<p><strong>Syntax:</strong> <code class="language-plaintext highlighter-rouge">[ database_name. ] [ table_name. ] column_name</code></p>
</li>
<li>
<p><strong>AS JSON</strong></p>
<p>An optional parameter to return the table metadata in JSON format. Only supported when <code class="language-plaintext highlighter-rouge">EXTENDED</code>
or <code class="language-plaintext highlighter-rouge">FORMATTED</code> format is specified (both produce equivalent JSON).</p>
<p><strong>Syntax:</strong> <code class="language-plaintext highlighter-rouge">[ AS JSON ]</code></p>
<p><strong>Schema:</strong></p>
<p>Below is the full JSON schema.
In actual output, null fields are omitted and the JSON is not pretty-printed (see Examples).</p>
<div class="language-sql highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="p">{</span>
<span class="nv">"table_name"</span><span class="p">:</span> <span class="nv">"&lt;table_name&gt;"</span><span class="p">,</span>
<span class="nv">"catalog_name"</span><span class="p">:</span> <span class="nv">"&lt;catalog_name&gt;"</span><span class="p">,</span>
<span class="nv">"schema_name"</span><span class="p">:</span> <span class="nv">"&lt;innermost_namespace_name&gt;"</span><span class="p">,</span>
<span class="nv">"namespace"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"&lt;namespace_names&gt;"</span><span class="p">],</span>
<span class="nv">"type"</span><span class="p">:</span> <span class="nv">"&lt;table_type&gt;"</span><span class="p">,</span>
<span class="nv">"provider"</span><span class="p">:</span> <span class="nv">"&lt;provider&gt;"</span><span class="p">,</span>
<span class="nv">"columns"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nv">"name"</span><span class="p">:</span> <span class="nv">"&lt;name&gt;"</span><span class="p">,</span>
<span class="nv">"type"</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">type_json</span><span class="o">&gt;</span><span class="p">,</span>
<span class="nv">"comment"</span><span class="p">:</span> <span class="nv">"&lt;comment&gt;"</span><span class="p">,</span>
<span class="nv">"nullable"</span><span class="p">:</span> <span class="o">&lt;</span><span class="nb">boolean</span><span class="o">&gt;</span><span class="p">,</span>
<span class="nv">"default"</span><span class="p">:</span> <span class="nv">"&lt;default_val&gt;"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="nv">"partition_values"</span><span class="p">:</span> <span class="p">{</span>
<span class="nv">"&lt;col_name&gt;"</span><span class="p">:</span> <span class="nv">"&lt;val&gt;"</span>
<span class="p">},</span>
<span class="nv">"partition_columns"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"col1"</span><span class="p">,</span> <span class="nv">"col2"</span><span class="p">],</span>
<span class="nv">"clustering_columns"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"col1"</span><span class="p">,</span> <span class="nv">"col2"</span><span class="p">],</span>
<span class="nv">"location"</span><span class="p">:</span> <span class="nv">"&lt;path&gt;"</span><span class="p">,</span>
<span class="nv">"view_text"</span><span class="p">:</span> <span class="nv">"&lt;view_text&gt;"</span><span class="p">,</span>
<span class="nv">"view_original_text"</span><span class="p">:</span> <span class="nv">"&lt;view_original_text&gt;"</span><span class="p">,</span>
<span class="nv">"view_schema_mode"</span><span class="p">:</span> <span class="nv">"&lt;view_schema_mode&gt;"</span><span class="p">,</span>
<span class="nv">"view_catalog_and_namespace"</span><span class="p">:</span> <span class="nv">"&lt;view_catalog_and_namespace&gt;"</span><span class="p">,</span>
<span class="nv">"view_query_output_columns"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"col1"</span><span class="p">,</span> <span class="nv">"col2"</span><span class="p">],</span>
<span class="o">//</span> <span class="n">Spark</span> <span class="k">SQL</span> <span class="n">configurations</span> <span class="n">captured</span> <span class="k">at</span> <span class="n">the</span> <span class="nb">time</span> <span class="k">of</span> <span class="n">permanent</span> <span class="k">view</span> <span class="n">creation</span>
<span class="nv">"view_creation_spark_configuration"</span><span class="p">:</span> <span class="p">{</span>
<span class="nv">"conf1"</span><span class="p">:</span> <span class="nv">"&lt;value1&gt;"</span><span class="p">,</span>
<span class="nv">"conf2"</span><span class="p">:</span> <span class="nv">"&lt;value2&gt;"</span>
<span class="p">},</span>
<span class="nv">"comment"</span><span class="p">:</span> <span class="nv">"&lt;comment&gt;"</span><span class="p">,</span>
<span class="nv">"table_properties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nv">"property1"</span><span class="p">:</span> <span class="nv">"&lt;property1&gt;"</span><span class="p">,</span>
<span class="nv">"property2"</span><span class="p">:</span> <span class="nv">"&lt;property2&gt;"</span>
<span class="p">},</span>
<span class="nv">"storage_properties"</span><span class="p">:</span> <span class="p">{</span>
<span class="nv">"property1"</span><span class="p">:</span> <span class="nv">"&lt;property1&gt;"</span><span class="p">,</span>
<span class="nv">"property2"</span><span class="p">:</span> <span class="nv">"&lt;property2&gt;"</span>
<span class="p">},</span>
<span class="nv">"serde_library"</span><span class="p">:</span> <span class="nv">"&lt;serde_library&gt;"</span><span class="p">,</span>
<span class="nv">"input_format"</span><span class="p">:</span> <span class="nv">"&lt;input_format&gt;"</span><span class="p">,</span>
<span class="nv">"output_format"</span><span class="p">:</span> <span class="nv">"&lt;output_format&gt;"</span><span class="p">,</span>
<span class="nv">"num_buckets"</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">num_buckets</span><span class="o">&gt;</span><span class="p">,</span>
<span class="nv">"bucket_columns"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"&lt;col_name&gt;"</span><span class="p">],</span>
<span class="nv">"sort_columns"</span><span class="p">:</span> <span class="p">[</span><span class="nv">"&lt;col_name&gt;"</span><span class="p">],</span>
<span class="nv">"created_time"</span><span class="p">:</span> <span class="nv">"&lt;yyyy-MM-dd'T'HH:mm:ss'Z'&gt;"</span><span class="p">,</span>
<span class="nv">"created_by"</span><span class="p">:</span> <span class="nv">"&lt;created_by&gt;"</span><span class="p">,</span>
<span class="nv">"last_access"</span><span class="p">:</span> <span class="nv">"&lt;yyyy-MM-dd'T'HH:mm:ss'Z'&gt;"</span><span class="p">,</span>
<span class="nv">"partition_provider"</span><span class="p">:</span> <span class="nv">"&lt;partition_provider&gt;"</span><span class="p">,</span>
<span class="nv">"collation"</span><span class="p">:</span> <span class="nv">"&lt;default_collation&gt;"</span>
<span class="p">}</span>
</code></pre></div> </div>
<p>Below are the schema definitions for <code class="language-plaintext highlighter-rouge">&lt;type_json&gt;</code>:</p>
</li>
</ul>
<table>
<thead>
<tr>
<th>Spark SQL Data Types</th>
<th>JSON Representation</th>
</tr>
</thead>
<tbody>
<tr>
<td>ByteType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "tinyint" }</code></td>
</tr>
<tr>
<td>ShortType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "smallint" }</code></td>
</tr>
<tr>
<td>IntegerType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "int" }</code></td>
</tr>
<tr>
<td>LongType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "bigint" }</code></td>
</tr>
<tr>
<td>FloatType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "float" }</code></td>
</tr>
<tr>
<td>DoubleType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "double" }</code></td>
</tr>
<tr>
<td>DecimalType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "decimal", "precision": p, "scale": s }</code></td>
</tr>
<tr>
<td>StringType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "string", "collation": "&lt;collation&gt;" }</code></td>
</tr>
<tr>
<td>VarCharType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "varchar", "length": n }</code></td>
</tr>
<tr>
<td>CharType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "char", "length": n }</code></td>
</tr>
<tr>
<td>BinaryType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "binary" }</code></td>
</tr>
<tr>
<td>BooleanType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "boolean" }</code></td>
</tr>
<tr>
<td>DateType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "date" }</code></td>
</tr>
<tr>
<td>VariantType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "variant" }</code></td>
</tr>
<tr>
<td>TimestampType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "timestamp_ltz" }</code></td>
</tr>
<tr>
<td>TimestampNTZType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "timestamp_ntz" }</code></td>
</tr>
<tr>
<td>YearMonthIntervalType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "interval", "start_unit": "&lt;start_unit&gt;", "end_unit": "&lt;end_unit&gt;" }</code></td>
</tr>
<tr>
<td>DayTimeIntervalType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "interval", "start_unit": "&lt;start_unit&gt;", "end_unit": "&lt;end_unit&gt;" }</code></td>
</tr>
<tr>
<td>ArrayType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "array", "element_type": &lt;type_json&gt;, "element_nullable": &lt;boolean&gt; }</code></td>
</tr>
<tr>
<td>MapType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "map", "key_type": &lt;type_json&gt;, "value_type": &lt;type_json&gt;, "value_nullable": &lt;boolean&gt; }</code></td>
</tr>
<tr>
<td>StructType</td>
<td><code class="language-plaintext highlighter-rouge">{ "name" : "struct", "fields": [ {"name" : "field1", "type" : &lt;type_json&gt;, “nullable”: &lt;boolean&gt;, "comment": “&lt;comment&gt;”, "default": “&lt;default_val&gt;”}, ... ] }</code></td>
</tr>
</tbody>
</table>
<h3 id="examples">Examples</h3>
<div class="language-sql highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">-- Creates a table `customer`. Assumes current database is `salesdb`.</span>
<span class="k">CREATE</span> <span class="k">TABLE</span> <span class="n">customer</span><span class="p">(</span>
<span class="n">cust_id</span> <span class="nb">INT</span><span class="p">,</span>
<span class="k">state</span> <span class="nb">VARCHAR</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span>
<span class="n">name</span> <span class="n">STRING</span> <span class="k">COMMENT</span> <span class="s1">'Short name'</span>
<span class="p">)</span>
<span class="k">USING</span> <span class="n">parquet</span>
<span class="n">PARTITIONED</span> <span class="k">BY</span> <span class="p">(</span><span class="k">state</span><span class="p">);</span>
<span class="k">INSERT</span> <span class="k">INTO</span> <span class="n">customer</span> <span class="k">PARTITION</span> <span class="p">(</span><span class="k">state</span> <span class="o">=</span> <span class="s1">'AR'</span><span class="p">)</span> <span class="k">VALUES</span> <span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="s1">'Mike'</span><span class="p">);</span>
<span class="c1">-- Returns basic metadata information for unqualified table `customer`</span>
<span class="k">DESCRIBE</span> <span class="k">TABLE</span> <span class="n">customer</span><span class="p">;</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="o">|</span> <span class="n">col_name</span><span class="o">|</span><span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="o">|</span> <span class="n">cust_id</span><span class="o">|</span> <span class="nb">int</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="n">name</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span><span class="n">Short</span> <span class="n">name</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|#</span> <span class="k">Partition</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="n">col_name</span><span class="o">|</span><span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="c1">-- Returns basic metadata information for qualified table `customer`</span>
<span class="k">DESCRIBE</span> <span class="k">TABLE</span> <span class="n">salesdb</span><span class="p">.</span><span class="n">customer</span><span class="p">;</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="o">|</span> <span class="n">col_name</span><span class="o">|</span><span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="o">|</span> <span class="n">cust_id</span><span class="o">|</span> <span class="nb">int</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="n">name</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span><span class="n">Short</span> <span class="n">name</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|#</span> <span class="k">Partition</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="n">col_name</span><span class="o">|</span><span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">+</span><span class="c1">-----------------------+---------+----------+</span>
<span class="c1">-- Returns additional metadata such as parent database, owner, access time etc.</span>
<span class="k">DESCRIBE</span> <span class="k">TABLE</span> <span class="n">EXTENDED</span> <span class="n">customer</span><span class="p">;</span>
<span class="o">+</span><span class="c1">----------------------------+------------------------------+----------+</span>
<span class="o">|</span> <span class="n">col_name</span><span class="o">|</span> <span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">+</span><span class="c1">----------------------------+------------------------------+----------+</span>
<span class="o">|</span> <span class="n">cust_id</span><span class="o">|</span> <span class="nb">int</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="n">name</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span><span class="n">Short</span> <span class="n">name</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="k">Partition</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="n">col_name</span><span class="o">|</span> <span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|#</span> <span class="n">Detailed</span> <span class="k">Table</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Database</span><span class="o">|</span> <span class="k">default</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Table</span><span class="o">|</span> <span class="n">customer</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Owner</span><span class="o">|</span> <span class="o">&lt;</span><span class="k">TABLE</span> <span class="k">OWNER</span><span class="o">&gt;|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Created</span> <span class="nb">Time</span><span class="o">|</span> <span class="n">Tue</span> <span class="n">Apr</span> <span class="mi">07</span> <span class="mi">22</span><span class="p">:</span><span class="mi">56</span><span class="p">:</span><span class="mi">34</span> <span class="n">JST</span> <span class="mi">2020</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Last</span> <span class="k">Access</span><span class="o">|</span> <span class="k">UNKNOWN</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Created</span> <span class="k">By</span><span class="o">|</span> <span class="o">&lt;</span><span class="n">SPARK</span> <span class="k">VERSION</span><span class="o">&gt;|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Type</span><span class="o">|</span> <span class="n">MANAGED</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Provider</span><span class="o">|</span> <span class="n">parquet</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Location</span><span class="o">|</span><span class="n">file</span><span class="p">:</span><span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">salesdb</span><span class="p">.</span><span class="n">db</span><span class="o">/</span><span class="n">custom</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Serde</span> <span class="n">Library</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">InputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">OutputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Partition</span> <span class="n">Provider</span><span class="o">|</span> <span class="k">Catalog</span><span class="o">|</span> <span class="o">|</span>
<span class="o">+</span><span class="c1">----------------------------+------------------------------+----------+</span>
<span class="c1">-- Returns partition metadata such as partitioning column name, column type and comment.</span>
<span class="k">DESCRIBE</span> <span class="k">TABLE</span> <span class="n">EXTENDED</span> <span class="n">customer</span> <span class="k">PARTITION</span> <span class="p">(</span><span class="k">state</span> <span class="o">=</span> <span class="s1">'AR'</span><span class="p">);</span>
<span class="o">+</span><span class="c1">------------------------------+------------------------------+----------+</span>
<span class="o">|</span> <span class="n">col_name</span><span class="o">|</span> <span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">+</span><span class="c1">------------------------------+------------------------------+----------+</span>
<span class="o">|</span> <span class="n">cust_id</span><span class="o">|</span> <span class="nb">int</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="n">name</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span><span class="n">Short</span> <span class="n">name</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="k">Partition</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="n">col_name</span><span class="o">|</span> <span class="n">data_type</span><span class="o">|</span> <span class="k">comment</span><span class="o">|</span>
<span class="o">|</span> <span class="k">state</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span> <span class="k">null</span><span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|#</span> <span class="n">Detailed</span> <span class="k">Partition</span> <span class="n">Inform</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Database</span><span class="o">|</span> <span class="k">default</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Table</span><span class="o">|</span> <span class="n">customer</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Partition</span> <span class="k">Values</span><span class="o">|</span> <span class="p">[</span><span class="k">state</span><span class="o">=</span><span class="n">AR</span><span class="p">]</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Location</span><span class="o">|</span><span class="n">file</span><span class="p">:</span><span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">salesdb</span><span class="p">.</span><span class="n">db</span><span class="o">/</span><span class="n">custom</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Serde</span> <span class="n">Library</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">InputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">OutputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Storage</span> <span class="n">Properties</span><span class="o">|</span><span class="p">[</span><span class="n">serialization</span><span class="p">.</span><span class="n">format</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">pa</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Partition</span> <span class="k">Parameters</span><span class="o">|</span><span class="p">{</span><span class="n">transient_lastDdlTime</span><span class="o">=</span><span class="mi">1586</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Created</span> <span class="nb">Time</span><span class="o">|</span> <span class="n">Tue</span> <span class="n">Apr</span> <span class="mi">07</span> <span class="mi">23</span><span class="p">:</span><span class="mi">05</span><span class="p">:</span><span class="mi">43</span> <span class="n">JST</span> <span class="mi">2020</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Last</span> <span class="k">Access</span><span class="o">|</span> <span class="k">UNKNOWN</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Partition</span> <span class="k">Statistics</span><span class="o">|</span> <span class="mi">659</span> <span class="n">bytes</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">#</span> <span class="k">Storage</span> <span class="n">Information</span><span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="k">Location</span><span class="o">|</span><span class="n">file</span><span class="p">:</span><span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">salesdb</span><span class="p">.</span><span class="n">db</span><span class="o">/</span><span class="n">custom</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Serde</span> <span class="n">Library</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">InputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">OutputFormat</span><span class="o">|</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">hadoop</span><span class="p">.</span><span class="n">hive</span><span class="p">.</span><span class="n">ql</span><span class="p">.</span><span class="n">i</span><span class="p">...</span><span class="o">|</span> <span class="o">|</span>
<span class="o">+</span><span class="c1">------------------------------+------------------------------+----------+</span>
<span class="c1">-- Returns the metadata for `name` column.</span>
<span class="c1">-- Optional `TABLE` clause is omitted and column is fully qualified.</span>
<span class="k">DESCRIBE</span> <span class="n">customer</span> <span class="n">salesdb</span><span class="p">.</span><span class="n">customer</span><span class="p">.</span><span class="n">name</span><span class="p">;</span>
<span class="o">+</span><span class="c1">---------+----------+</span>
<span class="o">|</span><span class="n">info_name</span><span class="o">|</span><span class="n">info_value</span><span class="o">|</span>
<span class="o">+</span><span class="c1">---------+----------+</span>
<span class="o">|</span> <span class="n">col_name</span><span class="o">|</span> <span class="n">name</span><span class="o">|</span>
<span class="o">|</span><span class="n">data_type</span><span class="o">|</span> <span class="n">string</span><span class="o">|</span>
<span class="o">|</span> <span class="k">comment</span><span class="o">|</span><span class="n">Short</span> <span class="n">name</span><span class="o">|</span>
<span class="o">+</span><span class="c1">---------+----------+</span>
<span class="c1">-- Returns the table metadata in JSON format.</span>
<span class="k">DESC</span> <span class="n">FORMATTED</span> <span class="n">customer</span> <span class="k">AS</span> <span class="n">JSON</span><span class="p">;</span>
<span class="p">{</span><span class="nv">"table_name"</span><span class="p">:</span><span class="nv">"customer"</span><span class="p">,</span><span class="nv">"catalog_name"</span><span class="p">:</span><span class="nv">"spark_catalog"</span><span class="p">,</span><span class="nv">"schema_name"</span><span class="p">:</span><span class="nv">"default"</span><span class="p">,</span><span class="nv">"namespace"</span><span class="p">:[</span><span class="nv">"default"</span><span class="p">],</span><span class="nv">"columns"</span><span class="p">:[{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"cust_id"</span><span class="p">,</span><span class="nv">"type"</span><span class="p">:{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"integer"</span><span class="p">},</span><span class="nv">"nullable"</span><span class="p">:</span><span class="k">true</span><span class="p">},{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"name"</span><span class="p">,</span><span class="nv">"type"</span><span class="p">:{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"string"</span><span class="p">},</span><span class="nv">"comment"</span><span class="p">:</span><span class="nv">"Short name"</span><span class="p">,</span><span class="nv">"nullable"</span><span class="p">:</span><span class="k">true</span><span class="p">},{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"state"</span><span class="p">,</span><span class="nv">"type"</span><span class="p">:{</span><span class="nv">"name"</span><span class="p">:</span><span class="nv">"varchar"</span><span class="p">,</span><span class="nv">"length"</span><span class="p">:</span><span class="mi">20</span><span class="p">},</span><span class="nv">"nullable"</span><span class="p">:</span><span class="k">true</span><span class="p">}],</span><span class="nv">"location"</span><span class="p">:</span> <span class="nv">"file:/tmp/salesdb.db/custom..."</span><span class="p">,</span><span class="nv">"created_time"</span><span class="p">:</span><span class="nv">"2020-04-07T14:05:43Z"</span><span class="p">,</span><span class="nv">"last_access"</span><span class="p">:</span><span class="nv">"UNKNOWN"</span><span class="p">,</span><span class="nv">"created_by"</span><span class="p">:</span><span class="nv">"None"</span><span class="p">,</span><span class="nv">"type"</span><span class="p">:</span><span class="nv">"MANAGED"</span><span class="p">,</span><span class="nv">"provider"</span><span class="p">:</span><span class="nv">"parquet"</span><span class="p">,</span><span class="nv">"partition_provider"</span><span class="p">:</span><span class="nv">"Catalog"</span><span class="p">,</span><span class="nv">"partition_columns"</span><span class="p">:[</span><span class="nv">"state"</span><span class="p">]}</span>
</code></pre></div></div>
<h3 id="related-statements">Related Statements</h3>
<ul>
<li><a href="sql-ref-syntax-aux-describe-database.html">DESCRIBE DATABASE</a></li>
<li><a href="sql-ref-syntax-aux-describe-query.html">DESCRIBE QUERY</a></li>
<li><a href="sql-ref-syntax-aux-describe-function.html">DESCRIBE FUNCTION</a></li>
</ul>
</div>
<!-- /container -->
</div>
<script src="js/vendor/jquery-3.5.1.min.js"></script>
<script src="js/vendor/bootstrap.bundle.min.js"></script>
<script src="js/vendor/anchor.min.js"></script>
<script src="js/main.js"></script>
<script type="text/javascript" src="js/vendor/docsearch.min.js"></script>
<script type="text/javascript">
// DocSearch is entirely free and automated. DocSearch is built in two parts:
// 1. a crawler which we run on our own infrastructure every 24 hours. It follows every link
// in your website and extract content from every page it traverses. It then pushes this
// content to an Algolia index.
// 2. a JavaScript snippet to be inserted in your website that will bind this Algolia index
// to your search input and display its results in a dropdown UI. If you want to find more
// details on how works DocSearch, check the docs of DocSearch.
docsearch({
apiKey: 'd62f962a82bc9abb53471cb7b89da35e',
appId: 'RAI69RXRSK',
indexName: 'apache_spark',
inputSelector: '#docsearch-input',
enhancedSearchInput: true,
algoliaOptions: {
'facetFilters': ["version:4.1.0-preview1"]
},
debug: false // Set debug to true if you want to inspect the dropdown
});
</script>
<!-- MathJax Section -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
<script>
// Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS.
// We could use "//cdn.mathjax...", but that won't support "file://".
(function(d, script) {
script = d.createElement('script');
script.type = 'text/javascript';
script.async = true;
script.onload = function(){
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ],
displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
processEscapes: true,
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
}
});
};
script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
'cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js' +
'?config=TeX-AMS-MML_HTMLorMML';
d.getElementsByTagName('head')[0].appendChild(script);
}(document));
</script>
</body>
</html>