| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ParquetSchemaUtil</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ParquetSchemaUtil"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/iceberg/parquet/ParquetReader.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.HasIds.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/parquet/ParquetSchemaUtil.html" target="_top">Frames</a></li> |
| <li><a href="ParquetSchemaUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.parquet</div> |
| <h2 title="Class ParquetSchemaUtil" class="title">Class ParquetSchemaUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.parquet.ParquetSchemaUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ParquetSchemaUtil</span> |
| extends java.lang.Object</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.HasIds.html" title="class in org.apache.iceberg.parquet">ParquetSchemaUtil.HasIds</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.MessageType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#addFallbackIds-org.apache.parquet.schema.MessageType-">addFallbackIds</a></span>(org.apache.parquet.schema.MessageType fileSchema)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.MessageType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#applyNameMapping-org.apache.parquet.schema.MessageType-org.apache.iceberg.mapping.NameMapping-">applyNameMapping</a></span>(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/mapping/NameMapping.html" title="class in org.apache.iceberg.mapping">NameMapping</a> nameMapping)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#convert-org.apache.parquet.schema.MessageType-">convert</a></span>(org.apache.parquet.schema.MessageType parquetSchema)</code> |
| <div class="block">Converts a Parquet schema to an Iceberg schema.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.MessageType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#convert-org.apache.iceberg.Schema-java.lang.String-">convert</a></span>(<a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| java.lang.String name)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#convertAndPrune-org.apache.parquet.schema.MessageType-">convertAndPrune</a></span>(org.apache.parquet.schema.MessageType parquetSchema)</code> |
| <div class="block">Converts a Parquet schema to an Iceberg schema and prunes fields without IDs.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.Type</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#determineListElementType-org.apache.parquet.schema.GroupType-">determineListElementType</a></span>(org.apache.parquet.schema.GroupType array)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#hasIds-org.apache.parquet.schema.MessageType-">hasIds</a></span>(org.apache.parquet.schema.MessageType fileSchema)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.MessageType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#pruneColumns-org.apache.parquet.schema.MessageType-org.apache.iceberg.Schema-">pruneColumns</a></span>(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> expectedSchema)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static org.apache.parquet.schema.MessageType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.html#pruneColumnsFallback-org.apache.parquet.schema.MessageType-org.apache.iceberg.Schema-">pruneColumnsFallback</a></span>(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> expectedSchema)</code> |
| <div class="block">Prunes columns from a Parquet file schema that was written without field ids.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="convert-org.apache.iceberg.Schema-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre>public static org.apache.parquet.schema.MessageType convert(<a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| java.lang.String name)</pre> |
| </li> |
| </ul> |
| <a name="convert-org.apache.parquet.schema.MessageType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> convert(org.apache.parquet.schema.MessageType parquetSchema)</pre> |
| <div class="block">Converts a Parquet schema to an Iceberg schema. Fields without IDs are kept and assigned |
| fallback IDs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parquetSchema</code> - a Parquet schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a matching Iceberg schema for the provided Parquet schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertAndPrune-org.apache.parquet.schema.MessageType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertAndPrune</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> convertAndPrune(org.apache.parquet.schema.MessageType parquetSchema)</pre> |
| <div class="block">Converts a Parquet schema to an Iceberg schema and prunes fields without IDs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parquetSchema</code> - a Parquet schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a matching Iceberg schema for the provided Parquet schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pruneColumns-org.apache.parquet.schema.MessageType-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pruneColumns</h4> |
| <pre>public static org.apache.parquet.schema.MessageType pruneColumns(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> expectedSchema)</pre> |
| </li> |
| </ul> |
| <a name="pruneColumnsFallback-org.apache.parquet.schema.MessageType-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pruneColumnsFallback</h4> |
| <pre>public static org.apache.parquet.schema.MessageType pruneColumnsFallback(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> expectedSchema)</pre> |
| <div class="block">Prunes columns from a Parquet file schema that was written without field ids. |
| |
| <p>Files that were written without field ids are read assuming that schema evolution preserved |
| column order. Deleting columns was not allowed. |
| |
| <p>The order of columns in the resulting Parquet schema matches the Parquet file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileSchema</code> - schema from a Parquet file that does not have field ids.</dd> |
| <dd><code>expectedSchema</code> - expected schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a parquet schema pruned using the expected schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasIds-org.apache.parquet.schema.MessageType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasIds</h4> |
| <pre>public static boolean hasIds(org.apache.parquet.schema.MessageType fileSchema)</pre> |
| </li> |
| </ul> |
| <a name="addFallbackIds-org.apache.parquet.schema.MessageType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFallbackIds</h4> |
| <pre>public static org.apache.parquet.schema.MessageType addFallbackIds(org.apache.parquet.schema.MessageType fileSchema)</pre> |
| </li> |
| </ul> |
| <a name="applyNameMapping-org.apache.parquet.schema.MessageType-org.apache.iceberg.mapping.NameMapping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyNameMapping</h4> |
| <pre>public static org.apache.parquet.schema.MessageType applyNameMapping(org.apache.parquet.schema.MessageType fileSchema, |
| <a href="../../../../org/apache/iceberg/mapping/NameMapping.html" title="class in org.apache.iceberg.mapping">NameMapping</a> nameMapping)</pre> |
| </li> |
| </ul> |
| <a name="determineListElementType-org.apache.parquet.schema.GroupType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>determineListElementType</h4> |
| <pre>public static org.apache.parquet.schema.Type determineListElementType(org.apache.parquet.schema.GroupType array)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/iceberg/parquet/ParquetReader.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/parquet/ParquetSchemaUtil.HasIds.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/parquet/ParquetSchemaUtil.html" target="_top">Frames</a></li> |
| <li><a href="ParquetSchemaUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
