| <!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 (1.8.0_231) on Tue Jan 26 14:32:17 PST 2021 --> |
| <title>Schema</title> |
| <meta name="date" content="2021-01-26"> |
| <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="Schema"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/ScanTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/SchemaParser.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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</div> |
| <h2 title="Class Schema" class="title">Class Schema</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.Schema</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Schema</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">The schema of a data table.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#org.apache.iceberg.Schema">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#Schema-java.util.List-">Schema</a></span>(java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>> columns)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#Schema-java.util.List-java.util.Map-">Schema</a></span>(java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>> columns, |
| java.util.Map<java.lang.String,java.lang.Integer> aliases)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#Schema-org.apache.iceberg.types.Types.NestedField...-">Schema</a></span>(<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>... columns)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../org/apache/iceberg/Accessor.html" title="interface in org.apache.iceberg">Accessor</a><<a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg">StructLike</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#accessorForField-int-">accessorForField</a></span>(int id)</code> |
| <div class="block">Returns an accessor for retrieving the data from <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#aliasToId-java.lang.String-">aliasToId</a></span>(java.lang.String alias)</code> |
| <div class="block">Returns the column id for the given column alias.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#asStruct--">asStruct</a></span>()</code> |
| <div class="block">Returns the underlying <a href="../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types"><code>struct type</code></a> for this schema.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#caseInsensitiveFindField-java.lang.String-">caseInsensitiveFindField</a></span>(java.lang.String name)</code> |
| <div class="block">Returns a sub-field by name as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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/Schema.html#caseInsensitiveSelect-java.util.Collection-">caseInsensitiveSelect</a></span>(java.util.Collection<java.lang.String> names)</code> |
| <div class="block">Creates a projection schema for a subset of columns, selected by case insensitive names</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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/Schema.html#caseInsensitiveSelect-java.lang.String...-">caseInsensitiveSelect</a></span>(java.lang.String... names)</code> |
| <div class="block">Creates a projection schema for a subset of columns, selected by case insensitive names</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#columns--">columns</a></span>()</code> |
| <div class="block">Returns a List of the <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>columns</code></a> in this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#findColumnName-int-">findColumnName</a></span>(int id)</code> |
| <div class="block">Returns the full column name for the given id.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#findField-int-">findField</a></span>(int id)</code> |
| <div class="block">Returns the sub-field identified by the field id as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#findField-java.lang.String-">findField</a></span>(java.lang.String name)</code> |
| <div class="block">Returns a sub-field by name as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#findType-int-">findType</a></span>(int id)</code> |
| <div class="block">Returns the <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> of a sub-field identified by the field id.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#findType-java.lang.String-">findType</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> of a sub-field identified by the field name.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Integer></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#getAliases--">getAliases</a></span>()</code> |
| <div class="block">Returns an alias map for this schema, if set.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#idToAlias-java.lang.Integer-">idToAlias</a></span>(java.lang.Integer fieldId)</code> |
| <div class="block">Returns the full column name in the unconverted data schema for the given column id.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><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/Schema.html#select-java.util.Collection-">select</a></span>(java.util.Collection<java.lang.String> names)</code> |
| <div class="block">Creates a projection schema for a subset of columns, selected by name.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><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/Schema.html#select-java.lang.String...-">select</a></span>(java.lang.String... names)</code> |
| <div class="block">Creates a projection schema for a subset of columns, selected by name.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Schema.html#toString--">toString</a></span>()</code> </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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Schema-java.util.List-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Schema</h4> |
| <pre>public Schema(java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>> columns, |
| java.util.Map<java.lang.String,java.lang.Integer> aliases)</pre> |
| </li> |
| </ul> |
| <a name="Schema-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Schema</h4> |
| <pre>public Schema(java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>> columns)</pre> |
| </li> |
| </ul> |
| <a name="Schema-org.apache.iceberg.types.Types.NestedField...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Schema</h4> |
| <pre>public Schema(<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>... columns)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAliases--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAliases</h4> |
| <pre>public java.util.Map<java.lang.String,java.lang.Integer> getAliases()</pre> |
| <div class="block">Returns an alias map for this schema, if set. |
| <p> |
| Alias maps are created when translating an external schema, like an Avro Schema, to this |
| format. The original column names can be provided in a Map when constructing this Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map of column aliases to field ids</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asStruct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asStruct</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> asStruct()</pre> |
| <div class="block">Returns the underlying <a href="../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types"><code>struct type</code></a> for this schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the StructType version of this schema.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="columns--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columns</h4> |
| <pre>public java.util.List<<a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a>> columns()</pre> |
| <div class="block">Returns a List of the <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>columns</code></a> in this Schema.</div> |
| </li> |
| </ul> |
| <a name="findType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findType</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> findType(java.lang.String name)</pre> |
| <div class="block">Returns the <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> of a sub-field identified by the field name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a field name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Type for the sub-field or null if it is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findType-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findType</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> findType(int id)</pre> |
| <div class="block">Returns the <a href="../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> of a sub-field identified by the field id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - a field id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Type for the sub-field or null if it is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findField-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findField</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> findField(int id)</pre> |
| <div class="block">Returns the sub-field identified by the field id as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - a field id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sub-field or null if it is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findField</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> findField(java.lang.String name)</pre> |
| <div class="block">Returns a sub-field by name as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>. |
| <p> |
| The result may be a top-level or a nested field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a String name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Type for the sub-field or null if it is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="caseInsensitiveFindField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caseInsensitiveFindField</h4> |
| <pre>public <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> caseInsensitiveFindField(java.lang.String name)</pre> |
| <div class="block">Returns a sub-field by name as a <a href="../../../org/apache/iceberg/types/Types.NestedField.html" title="class in org.apache.iceberg.types"><code>Types.NestedField</code></a>. |
| <p> |
| The result may be a top-level or a nested field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a String name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sub-field or null if it is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findColumnName-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findColumnName</h4> |
| <pre>public java.lang.String findColumnName(int id)</pre> |
| <div class="block">Returns the full column name for the given id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - a field id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full column name in this schema that resolves to the id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="aliasToId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aliasToId</h4> |
| <pre>public java.lang.Integer aliasToId(java.lang.String alias)</pre> |
| <div class="block">Returns the column id for the given column alias. Column aliases are set |
| by conversions from Parquet or Avro to this Schema type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>alias</code> - a full column name in the unconverted data schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the column id in this schema, or null if the column wasn't found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="idToAlias-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>idToAlias</h4> |
| <pre>public java.lang.String idToAlias(java.lang.Integer fieldId)</pre> |
| <div class="block">Returns the full column name in the unconverted data schema for the given column id. |
| Column aliases are set by conversions from Parquet or Avro to this Schema type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldId</code> - a column id in this schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full column name in the unconverted data schema, or null if one wasn't found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accessorForField-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accessorForField</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Accessor.html" title="interface in org.apache.iceberg">Accessor</a><<a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg">StructLike</a>> accessorForField(int id)</pre> |
| <div class="block">Returns an accessor for retrieving the data from <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>. |
| <p> |
| Accessors do not retrieve data contained in lists or maps.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - a column id in this schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <a href="../../../org/apache/iceberg/Accessor.html" title="interface in org.apache.iceberg"><code>Accessor</code></a> to retrieve values from a <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a> row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> select(java.lang.String... names)</pre> |
| <div class="block">Creates a projection schema for a subset of columns, selected by name. |
| <p> |
| Names that identify nested fields will select part or all of the field's top-level column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - String names for selected columns</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a projection schema from this schema, by name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> select(java.util.Collection<java.lang.String> names)</pre> |
| <div class="block">Creates a projection schema for a subset of columns, selected by name. |
| <p> |
| Names that identify nested fields will select part or all of the field's top-level column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a List of String names for selected columns</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a projection schema from this schema, by name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="caseInsensitiveSelect-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caseInsensitiveSelect</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> caseInsensitiveSelect(java.lang.String... names)</pre> |
| <div class="block">Creates a projection schema for a subset of columns, selected by case insensitive names |
| <p> |
| Names that identify nested fields will select part or all of the field's top-level column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a List of String names for selected columns</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a projection schema from this schema, by names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="caseInsensitiveSelect-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caseInsensitiveSelect</h4> |
| <pre>public <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> caseInsensitiveSelect(java.util.Collection<java.lang.String> names)</pre> |
| <div class="block">Creates a projection schema for a subset of columns, selected by case insensitive names |
| <p> |
| Names that identify nested fields will select part or all of the field's top-level column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a List of String names for selected columns</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a projection schema from this schema, by names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </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/ScanTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/SchemaParser.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
