blob: f9aadf98b831fb7e9ec27a21d0ba1f7b64c0443e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>HiveSchemaUtil</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HiveSchemaUtil";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.hive</a></div>
<h2 title="Class HiveSchemaUtil" class="title">Class HiveSchemaUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.hive.HiveSchemaUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">HiveSchemaUtil</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(java.util.List,java.util.List,java.util.List)">convert</a></span>&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;names,
java.util.List&lt;org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&gt;&nbsp;types,
java.util.List&lt;java.lang.String&gt;&nbsp;comments)</code></th>
<td class="colLast">
<div class="block">Converts the Hive list of column names and column types to an Iceberg schema.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(java.util.List,java.util.List,java.util.List,boolean)">convert</a></span>&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;names,
java.util.List&lt;org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&gt;&nbsp;types,
java.util.List&lt;java.lang.String&gt;&nbsp;comments,
boolean&nbsp;autoConvert)</code></th>
<td class="colLast">
<div class="block">Converts the Hive list of column names and column types to an Iceberg schema.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(java.util.List)">convert</a></span>&#8203;(java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas)</code></th>
<td class="colLast">
<div class="block">Converts a Hive schema (list of FieldSchema objects) to an Iceberg schema.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(java.util.List,boolean)">convert</a></span>&#8203;(java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas,
boolean&nbsp;autoConvert)</code></th>
<td class="colLast">
<div class="block">Converts a Hive schema (list of FieldSchema objects) to an Iceberg schema.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.hadoop.hive.serde2.typeinfo.TypeInfo)">convert</a></span>&#8203;(org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&nbsp;typeInfo)</code></th>
<td class="colLast">
<div class="block">Converts a Hive typeInfo object to an Iceberg type.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.iceberg.Schema)">convert</a></span>&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</code></th>
<td class="colLast">
<div class="block">Converts the Iceberg schema to a Hive schema (list of FieldSchema objects).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static org.apache.hadoop.hive.serde2.typeinfo.TypeInfo</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.iceberg.types.Type)">convert</a></span>&#8203;(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Converts an Iceberg type to a Hive TypeInfo object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spec(org.apache.iceberg.Schema,java.util.List)">spec</a></span>&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas)</code></th>
<td class="colLast">
<div class="block">Converts the Hive partition columns to Iceberg identity partition specification.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="convert(org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;convert&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</pre>
<div class="block">Converts the Iceberg schema to a Hive schema (list of FieldSchema objects).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - The original Iceberg schema to convert</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Hive column list generated from the Iceberg schema</dd>
</dl>
</li>
</ul>
<a id="convert(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;convert&#8203;(java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas)</pre>
<div class="block">Converts a Hive schema (list of FieldSchema objects) to an Iceberg schema. If some of the types are not convertible
then exception is thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldSchemas</code> - The list of the columns</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An equivalent Iceberg Schema</dd>
</dl>
</li>
</ul>
<a id="convert(java.util.List,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;convert&#8203;(java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas,
boolean&nbsp;autoConvert)</pre>
<div class="block">Converts a Hive schema (list of FieldSchema objects) to an Iceberg schema.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldSchemas</code> - The list of the columns</dd>
<dd><code>autoConvert</code> - If <code>true</code> then TINYINT and SMALLINT is converted to INTEGER and VARCHAR and CHAR is
converted to STRING. Otherwise if these types are used in the Hive schema then exception is
thrown.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An equivalent Iceberg Schema</dd>
</dl>
</li>
</ul>
<a id="spec(org.apache.iceberg.Schema,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spec</h4>
<pre class="methodSignature">public static&nbsp;<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
java.util.List&lt;org.apache.hadoop.hive.metastore.api.FieldSchema&gt;&nbsp;fieldSchemas)</pre>
<div class="block">Converts the Hive partition columns to Iceberg identity partition specification.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - The Iceberg schema</dd>
<dd><code>fieldSchemas</code> - The partition column specification</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Iceberg partition specification</dd>
</dl>
</li>
</ul>
<a id="convert(java.util.List,java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;convert&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;names,
java.util.List&lt;org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&gt;&nbsp;types,
java.util.List&lt;java.lang.String&gt;&nbsp;comments)</pre>
<div class="block">Converts the Hive list of column names and column types to an Iceberg schema. If some of the types are not
convertible then exception is thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>names</code> - The list of the Hive column names</dd>
<dd><code>types</code> - The list of the Hive column types</dd>
<dd><code>comments</code> - The list of the Hive column comments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Iceberg schema</dd>
</dl>
</li>
</ul>
<a id="convert(java.util.List,java.util.List,java.util.List,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;convert&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;names,
java.util.List&lt;org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&gt;&nbsp;types,
java.util.List&lt;java.lang.String&gt;&nbsp;comments,
boolean&nbsp;autoConvert)</pre>
<div class="block">Converts the Hive list of column names and column types to an Iceberg schema.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>names</code> - The list of the Hive column names</dd>
<dd><code>types</code> - The list of the Hive column types</dd>
<dd><code>comments</code> - The list of the Hive column comments, can be null</dd>
<dd><code>autoConvert</code> - If <code>true</code> then TINYINT and SMALLINT is converted to INTEGER and VARCHAR and CHAR is
converted to STRING. Otherwise if these types are used in the Hive schema then exception is
thrown.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Iceberg schema</dd>
</dl>
</li>
</ul>
<a id="convert(org.apache.iceberg.types.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&nbsp;convert&#8203;(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a>&nbsp;type)</pre>
<div class="block">Converts an Iceberg type to a Hive TypeInfo object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The Iceberg type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Hive type</dd>
</dl>
</li>
</ul>
<a id="convert(org.apache.hadoop.hive.serde2.typeinfo.TypeInfo)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public static&nbsp;<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a>&nbsp;convert&#8203;(org.apache.hadoop.hive.serde2.typeinfo.TypeInfo&nbsp;typeInfo)</pre>
<div class="block">Converts a Hive typeInfo object to an Iceberg type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeInfo</code> - The Hive type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Iceberg type</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>