| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StructKind (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.rel.type, enum: StructKind"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#enum-constant-summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum-constant-detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.rel.type</a></div> |
| <h1 title="Enum StructKind" class="title">Enum StructKind</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a>> |
| <div class="inheritance">org.apache.calcite.rel.type.StructKind</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">StructKind</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a>></span></div> |
| <div class="block">Describes a policy for resolving fields in record types. |
| |
| <p>The usual value is <a href="#FULLY_QUALIFIED"><code>FULLY_QUALIFIED</code></a>. |
| |
| <p>A field whose record type is labeled <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a> can be omitted. |
| In Phoenix, column families are represented by fields like this. |
| <a href="#PEEK_FIELDS_DEFAULT"><code>PEEK_FIELDS_DEFAULT</code></a> is similar, but represents the default column |
| family, so it will win in the event of a tie. |
| |
| <p>SQL usually disallows a record type. For instance, |
| |
| <blockquote><pre>SELECT address.zip FROM Emp AS e</pre></blockquote> |
| |
| <p>is disallowed because <code>address</code> "looks like" a table alias. You'd |
| have to write |
| |
| <blockquote><pre>SELECT e.address.zip FROM Emp AS e</pre></blockquote> |
| |
| <p>But if a table has one or more columns that are record-typed and are |
| labeled <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a> or <a href="#PEEK_FIELDS_DEFAULT"><code>PEEK_FIELDS_DEFAULT</code></a> we suspend that |
| rule and would allow <code>address.zip</code>. |
| |
| <p>If there are multiple matches, we choose the one that is: |
| <ol> |
| <li>Shorter. If you write <code>zipcode</code>, <code>address.zipcode</code> will |
| be preferred over <code>product.supplier.zipcode</code>. |
| <li>Uses as little skipping as possible. A match that is fully-qualified |
| will beat one that uses <code>PEEK_FIELDS_DEFAULT</code> at some point, which |
| will beat one that uses <code>PEEK_FIELDS</code> at some point. |
| </ol></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#FULLY_QUALIFIED" class="member-name-link">FULLY_QUALIFIED</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This is a traditional structured type, where each field must be |
| referenced explicitly.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#NONE" class="member-name-link">NONE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">This is not a structured type.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#PEEK_FIELDS" class="member-name-link">PEEK_FIELDS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">If a field has this type, you can see its fields without qualifying them |
| with the name of this field.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#PEEK_FIELDS_DEFAULT" class="member-name-link">PEEK_FIELDS_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">As <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a>, but takes priority if another struct-typed |
| field also has a field of the name being sought.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#PEEK_FIELDS_NO_EXPAND" class="member-name-link">PEEK_FIELDS_NO_EXPAND</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">As <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a>, but fields are not expanded in "SELECT *".</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="NONE"> |
| <h3>NONE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">NONE</span></div> |
| <div class="block">This is not a structured type.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FULLY_QUALIFIED"> |
| <h3>FULLY_QUALIFIED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">FULLY_QUALIFIED</span></div> |
| <div class="block">This is a traditional structured type, where each field must be |
| referenced explicitly. |
| |
| <p>Also, when referencing a struct column, you |
| need to qualify it with the table alias, per standard SQL. For instance, |
| <code>SELECT c.address.zipcode FROM customer AS c</code> |
| is valid but |
| <code>SELECT address.zipcode FROM customer</code> |
| it not valid.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PEEK_FIELDS_DEFAULT"> |
| <h3>PEEK_FIELDS_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">PEEK_FIELDS_DEFAULT</span></div> |
| <div class="block">As <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a>, but takes priority if another struct-typed |
| field also has a field of the name being sought. |
| |
| <p>In Phoenix, only one of a table's columns is labeled |
| <code>PEEK_FIELDS_DEFAULT</code> - the default column family - but in principle |
| there could be more than one.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PEEK_FIELDS"> |
| <h3>PEEK_FIELDS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">PEEK_FIELDS</span></div> |
| <div class="block">If a field has this type, you can see its fields without qualifying them |
| with the name of this field. |
| |
| <p>For example, if <code>address</code> is labeled <code>PEEK_FIELDS</code>, you |
| could write <code>zipcode</code> as shorthand for <code>address.zipcode</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PEEK_FIELDS_NO_EXPAND"> |
| <h3>PEEK_FIELDS_NO_EXPAND</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">PEEK_FIELDS_NO_EXPAND</span></div> |
| <div class="block">As <a href="#PEEK_FIELDS"><code>PEEK_FIELDS</code></a>, but fields are not expanded in "SELECT *". |
| |
| <p>Used in Flink, not Phoenix.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |