| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlValidatorNamespace (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.sql.validate, interface: SqlValidatorNamespace"> |
| <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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.sql.validate</a></div> |
| <h1 title="Interface SqlValidatorNamespace" class="title">Interface SqlValidatorNamespace</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AliasNamespace.html" title="class in org.apache.calcite.sql.validate">AliasNamespace</a></code>, <code><a href="CollectNamespace.html" title="class in org.apache.calcite.sql.validate">CollectNamespace</a></code>, <code><a href="DelegatingNamespace.html" title="class in org.apache.calcite.sql.validate">DelegatingNamespace</a></code>, <code><a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate">IdentifierNamespace</a></code>, <code><a href="MatchRecognizeNamespace.html" title="class in org.apache.calcite.sql.validate">MatchRecognizeNamespace</a></code>, <code><a href="PivotNamespace.html" title="class in org.apache.calcite.sql.validate">PivotNamespace</a></code>, <code><a href="ProcedureNamespace.html" title="class in org.apache.calcite.sql.validate">ProcedureNamespace</a></code>, <code><a href="SelectNamespace.html" title="class in org.apache.calcite.sql.validate">SelectNamespace</a></code>, <code><a href="SetopNamespace.html" title="class in org.apache.calcite.sql.validate">SetopNamespace</a></code>, <code><a href="SqlValidatorImpl.DmlNamespace.html" title="class in org.apache.calcite.sql.validate">SqlValidatorImpl.DmlNamespace</a></code>, <code><a href="TableConstructorNamespace.html" title="class in org.apache.calcite.sql.validate">TableConstructorNamespace</a></code>, <code><a href="UnpivotNamespace.html" title="class in org.apache.calcite.sql.validate">UnpivotNamespace</a></code>, <code><a href="WithNamespace.html" title="class in org.apache.calcite.sql.validate">WithNamespace</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlValidatorNamespace</span></div> |
| <div class="block">A namespace describes the relation returned by a section of a SQL query. |
| |
| <p>For example, in the query <code>SELECT emp.deptno, age FROM emp, |
| dept</code>, the FROM clause forms a namespace consisting of two tables EMP |
| and DEPT, and a row type consisting of the combined columns of those tables. |
| |
| <p>Other examples of namespaces include a table in the from list (the |
| namespace contains the constituent columns) and a sub-query (the namespace |
| contains the columns in the SELECT clause of the sub-query). |
| |
| <p>These various kinds of namespace are implemented by classes |
| <a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate"><code>IdentifierNamespace</code></a> for table names, <a href="SelectNamespace.html" title="class in org.apache.calcite.sql.validate"><code>SelectNamespace</code></a> for |
| SELECT queries, <a href="SetopNamespace.html" title="class in org.apache.calcite.sql.validate"><code>SetopNamespace</code></a> for UNION, EXCEPT and INTERSECT, and |
| so forth. But if you are looking at a SELECT query and call |
| <a href="SqlValidator.html#getNamespace(org.apache.calcite.sql.SqlNode)"><code>SqlValidator.getNamespace(org.apache.calcite.sql.SqlNode)</code></a>, you may |
| not get a SelectNamespace. Why? Because the validator is allowed to wrap |
| namespaces in other objects which implement |
| <a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidatorNamespace</code></a>. Your SelectNamespace will be there somewhere, |
| but might be one or two levels deep. Don't try to cast the namespace or use |
| <code>instanceof</code>; use <a href="#unwrap(java.lang.Class)"><code>unwrap(Class)</code></a> and |
| <a href="#isWrapperFor(java.lang.Class)"><code>isWrapperFor(Class)</code></a> instead.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a></li> |
| <li><a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidatorScope</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#field(java.lang.String)" class="member-name-link">field</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-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a field of a given name, or null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#fieldExists(java.lang.String)" class="member-name-link">fieldExists</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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns whether this namespace has a field of a given name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEnclosingNode()" class="member-name-link">getEnclosingNode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the parse tree node that at is at the root of this namespace and |
| includes all decorations.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMonotonicExprs()" class="member-name-link">getMonotonicExprs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a list of expressions which are monotonic in this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMonotonicity(java.lang.String)" class="member-name-link">getMonotonicity</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> columnName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether and how a given column is sorted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNode()" class="member-name-link">getNode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the parse tree node at the root of this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowType()" class="member-name-link">getRowType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the row type of this namespace, which comprises a list of names |
| and types of the output columns.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowTypeSansSystemColumns()" class="member-name-link">getRowTypeSansSystemColumns</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the row type of this namespace, sans any system columns.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="SqlValidatorTable.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorTable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTable()" class="member-name-link">getTable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the underlying table, or null if there is none.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the type of this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValidator()" class="member-name-link">getValidator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the validator.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isWrapperFor(java.lang.Class)" class="member-name-link">isWrapperFor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this namespace implements a given interface, or wraps a |
| class which does.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#lookupChild(java.lang.String)" class="member-name-link">lookupChild</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-tab2 method-summary-table-tab3"> |
| <div class="block">Looks up a child namespace of a given name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#makeNullable()" class="member-name-link">makeNullable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resolve()" class="member-name-link">resolve</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">If this namespace resolves to another namespace, returns that namespace, |
| following links to the end of the chain.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setType(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">setType</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the type of this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#supportsModality(org.apache.calcite.sql.validate.SqlModality)" class="member-name-link">supportsModality</a><wbr>(<a href="SqlModality.html" title="enum in org.apache.calcite.sql.validate">SqlModality</a> modality)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this namespace is capable of giving results of the desired |
| modality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unwrap(java.lang.Class)" class="member-name-link">unwrap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns this namespace, or a wrapped namespace, cast to a particular |
| class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#validate(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">validate</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Validates this namespace.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getValidator()"> |
| <h3>getValidator</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></span> <span class="element-name">getValidator</span>()</div> |
| <div class="block">Returns the validator.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>validator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable()"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="SqlValidatorTable.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorTable</a></span> <span class="element-name">getTable</span>()</div> |
| <div class="block">Returns the underlying table, or null if there is none.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowType()"> |
| <h3>getRowType</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowType</span>()</div> |
| <div class="block">Returns the row type of this namespace, which comprises a list of names |
| and types of the output columns. If the scope's type has not yet been |
| derived, derives it.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Row type of this namespace, never null, always a struct</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getType</span>()</div> |
| <div class="block">Returns the type of this namespace.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Row type converted to struct</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setType(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>setType</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setType</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| <div class="block">Sets the type of this namespace. |
| |
| <p>Allows the type for the namespace to be explicitly set, but usually is |
| called during <a href="#validate(org.apache.calcite.rel.type.RelDataType)"><code>validate(RelDataType)</code></a>.</p> |
| |
| <p>Implicitly also sets the row type. If the type is not a struct, then |
| the row type is the type wrapped as a struct with a single column, |
| otherwise the type and row type are the same.</p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowTypeSansSystemColumns()"> |
| <h3>getRowTypeSansSystemColumns</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowTypeSansSystemColumns</span>()</div> |
| <div class="block">Returns the row type of this namespace, sans any system columns.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Row type sans system columns</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">validate</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</span></div> |
| <div class="block">Validates this namespace. |
| |
| <p>If the scope has already been validated, does nothing.</p> |
| |
| <p>Please call <a href="SqlValidatorImpl.html#validateNamespace(org.apache.calcite.sql.validate.SqlValidatorNamespace,org.apache.calcite.rel.type.RelDataType)"><code>SqlValidatorImpl.validateNamespace(org.apache.calcite.sql.validate.SqlValidatorNamespace, org.apache.calcite.rel.type.RelDataType)</code></a> rather than |
| calling this method directly.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>targetRowType</code> - Desired row type, must not be null, may be the data |
| type 'unknown'.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNode()"> |
| <h3>getNode</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getNode</span>()</div> |
| <div class="block">Returns the parse tree node at the root of this namespace.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>parse tree node; null for <code>TableNamespace</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEnclosingNode()"> |
| <h3>getEnclosingNode</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getEnclosingNode</span>()</div> |
| <div class="block">Returns the parse tree node that at is at the root of this namespace and |
| includes all decorations. If there are no decorations, returns the same |
| as <a href="#getNode()"><code>getNode()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupChild(java.lang.String)"> |
| <h3>lookupChild</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></span> <span class="element-name">lookupChild</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">Looks up a child namespace of a given name. |
| |
| <p>For example, in the query <code>select e.name from emps as e</code>, |
| <code>e</code> is an <a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate"><code>IdentifierNamespace</code></a> which has a child <code> |
| name</code> which is a <code>FieldNamespace</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Name of namespace</dd> |
| <dt>Returns:</dt> |
| <dd>Namespace</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fieldExists(java.lang.String)"> |
| <h3>fieldExists</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">fieldExists</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 whether this namespace has a field of a given name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Field name</dd> |
| <dt>Returns:</dt> |
| <dd>Whether field exists</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="field(java.lang.String)"> |
| <h3>field</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="../../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span> <span class="element-name">field</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 a field of a given name, or null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Field name</dd> |
| <dt>Returns:</dt> |
| <dd>Field, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonotonicExprs()"> |
| <h3>getMonotonicExprs</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>>></span> <span class="element-name">getMonotonicExprs</span>()</div> |
| <div class="block">Returns a list of expressions which are monotonic in this namespace. For |
| example, if the namespace represents a relation ordered by a column |
| called "TIMESTAMP", then the list would contain a |
| <a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> called "TIMESTAMP".</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonotonicity(java.lang.String)"> |
| <h3>getMonotonicity</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="element-name">getMonotonicity</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> columnName)</span></div> |
| <div class="block">Returns whether and how a given column is sorted.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeNullable()"> |
| <h3>makeNullable</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">void</span> <span class="element-name">makeNullable</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unwrap(java.lang.Class)"> |
| <h3>unwrap</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">unwrap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</span></div> |
| <div class="block">Returns this namespace, or a wrapped namespace, cast to a particular |
| class.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - Desired type</dd> |
| <dt>Returns:</dt> |
| <dd>This namespace cast to desired type</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if no such interface is available</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isWrapperFor(java.lang.Class)"> |
| <h3>isWrapperFor</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isWrapperFor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> |
| <div class="block">Returns whether this namespace implements a given interface, or wraps a |
| class which does.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - Interface</dd> |
| <dt>Returns:</dt> |
| <dd>Whether namespace implements given interface</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resolve()"> |
| <h3>resolve</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></span> <span class="element-name">resolve</span>()</div> |
| <div class="block">If this namespace resolves to another namespace, returns that namespace, |
| following links to the end of the chain. |
| |
| <p>A <code>WITH</code>) clause defines table names that resolve to queries |
| (the body of the with-item). An <a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate"><code>IdentifierNamespace</code></a> typically |
| resolves to a <code>TableNamespace</code>.</p> |
| |
| <p>You must not call this method before <a href="#validate(org.apache.calcite.rel.type.RelDataType)"><code>validate(RelDataType)</code></a> has |
| completed.</p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="supportsModality(org.apache.calcite.sql.validate.SqlModality)"> |
| <h3>supportsModality</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">supportsModality</span><wbr><span class="parameters">(<a href="SqlModality.html" title="enum in org.apache.calcite.sql.validate">SqlModality</a> modality)</span></div> |
| <div class="block">Returns whether this namespace is capable of giving results of the desired |
| modality. <code>true</code> means streaming, <code>false</code> means relational.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>modality</code> - Modality</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> |
