| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>FlinkSchemaUtil</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="FlinkSchemaUtil"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":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 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: </li> |
| <li>Nested | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.iceberg.flink</a></div> |
| <h2 title="Class FlinkSchemaUtil" class="title">Class FlinkSchemaUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.flink.FlinkSchemaUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">FlinkSchemaUtil</span> |
| extends java.lang.Object</pre> |
| <div class="block">Converter between Flink types and Iceberg type. |
| The conversion is not a 1:1 mapping that not allows back-and-forth conversion. So some information might get lost |
| during the back-and-forth conversion. |
| <p> |
| This inconsistent types: |
| <ul> |
| <li>map Iceberg UUID type to Flink BinaryType(16)</li> |
| <li>map Flink VarCharType(_) and CharType(_) to Iceberg String type</li> |
| <li>map Flink VarBinaryType(_) to Iceberg Binary type</li> |
| <li>map Flink TimeType(_) to Iceberg Time type (microseconds)</li> |
| <li>map Flink TimestampType(_) to Iceberg Timestamp without zone type (microseconds)</li> |
| <li>map Flink LocalZonedTimestampType(_) to Iceberg Timestamp with zone type (microseconds)</li> |
| <li>map Flink MultiSetType to Iceberg Map type(element, int)</li> |
| </ul> |
| <p></div> |
| </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"> </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="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(org.apache.flink.table.api.TableSchema)">convert</a></span>​(org.apache.flink.table.api.TableSchema schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert the flink table schema to apache iceberg schema.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.flink.table.types.logical.RowType</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.iceberg.Schema)">convert</a></span>​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> to a <code>Flink type</code>.</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(org.apache.iceberg.Schema,org.apache.flink.table.api.TableSchema)">convert</a></span>​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> baseSchema, |
| org.apache.flink.table.api.TableSchema flinkSchema)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert a Flink <code>TableSchema</code> to a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> based on the given schema.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.flink.table.types.logical.LogicalType</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.iceberg.types.Type)">convert</a></span>​(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert a <a href="../types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> to a <code>Flink type</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static org.apache.flink.table.api.TableSchema</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSchema(org.apache.flink.table.types.logical.RowType)">toSchema</a></span>​(org.apache.flink.table.types.logical.RowType rowType)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert a <code>RowType</code> to a <code>TableSchema</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.flink.table.api.TableSchema</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSchema(org.apache.iceberg.Schema)">toSchema</a></span>​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> to a <code>TableSchema</code>.</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 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.flink.table.api.TableSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre class="methodSignature">public static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> convert​(org.apache.flink.table.api.TableSchema schema)</pre> |
| <div class="block">Convert the flink table schema to apache iceberg schema.</div> |
| </li> |
| </ul> |
| <a id="convert(org.apache.iceberg.Schema,org.apache.flink.table.api.TableSchema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre class="methodSignature">public static <a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> convert​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> baseSchema, |
| org.apache.flink.table.api.TableSchema flinkSchema)</pre> |
| <div class="block">Convert a Flink <code>TableSchema</code> to a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> based on the given schema. |
| <p> |
| This conversion does not assign new ids; it uses ids from the base schema. |
| <p> |
| Data types, field order, and nullability will match the Flink type. This conversion may return |
| a schema that is not compatible with base schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>baseSchema</code> - a Schema on which conversion is based</dd> |
| <dd><code>flinkSchema</code> - a Flink TableSchema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the equivalent Schema</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the type cannot be converted or there are missing ids</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="convert(org.apache.iceberg.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre class="methodSignature">public static org.apache.flink.table.types.logical.RowType convert​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">Convert a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> to a <code>Flink type</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - a Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the equivalent Flink type</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the type cannot be converted to Flink</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 org.apache.flink.table.types.logical.LogicalType convert​(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</pre> |
| <div class="block">Convert a <a href="../types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> to a <code>Flink type</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - a Type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the equivalent Flink type</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the type cannot be converted to Flink</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toSchema(org.apache.flink.table.types.logical.RowType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSchema</h4> |
| <pre class="methodSignature">public static org.apache.flink.table.api.TableSchema toSchema​(org.apache.flink.table.types.logical.RowType rowType)</pre> |
| <div class="block">Convert a <code>RowType</code> to a <code>TableSchema</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rowType</code> - a RowType</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Flink TableSchema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toSchema(org.apache.iceberg.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toSchema</h4> |
| <pre class="methodSignature">public static org.apache.flink.table.api.TableSchema toSchema​(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">Convert a <a href="../Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> to a <code>TableSchema</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - iceberg schema to convert.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Flink TableSchema.</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 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: </li> |
| <li>Nested | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
