| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>InitializerContext (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.sql2rel, interface: InitializerContext"> |
| <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.sql2rel</a></div> |
| <h1 title="Interface InitializerContext" class="title">Interface InitializerContext</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="SqlToRelConverter.Blackboard.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter.Blackboard</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">InitializerContext</span></div> |
| <div class="block">Provides context for <a href="InitializerExpressionFactory.html" title="interface in org.apache.calcite.sql2rel"><code>InitializerExpressionFactory</code></a> methods.</div> |
| </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></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><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convertExpression(org.apache.calcite.sql.SqlNode)" class="member-name-link">convertExpression</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts a <code>SqlNode</code> to <code>RexNode</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRexBuilder()" class="member-name-link">getRexBuilder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../sql/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-tab5"><code><a href="#parseExpression(org.apache.calcite.sql.parser.SqlParser.Config,java.lang.String)" class="member-name-link">parseExpression</a><wbr>(<a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config, |
| <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> expr)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Parses a column computation expression for a table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../sql/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="#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)" class="member-name-link">validateExpression</a><wbr>(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Validate the expression with a base table row type.</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="getRexBuilder()"> |
| <h3>getRexBuilder</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a></span> <span class="element-name">getRexBuilder</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseExpression(org.apache.calcite.sql.parser.SqlParser.Config,java.lang.String)"> |
| <h3>parseExpression</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">parseExpression</span><wbr><span class="parameters">(<a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> config, |
| <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> expr)</span></div> |
| <div class="block">Parses a column computation expression for a table. |
| |
| <p>Usually this expression is declared in the <code>CREATE TABLE</code> |
| statement, e.g. |
| |
| <blockquote><pre><code> |
| create table t( |
| a int not null, |
| b varchar(5) as (my_udf(a)) virtual, |
| c int not null as (a + 1)); |
| </code></pre></blockquote> |
| |
| <p>You can use the string format expression "my_udf(a)" and "a + 1" |
| as the initializer expression of column b and c. |
| |
| <p>Calcite doesn't really need this now because the DDL nodes |
| can be executed directly from <code>SqlNode</code>s, but we still provide the way |
| to initialize from a SQL-like string, because a string can be used to persist easily and |
| the column expressions are important part of the table metadata.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - parse config</dd> |
| <dd><code>expr</code> - the SQL-style column expression</dd> |
| <dt>Returns:</dt> |
| <dd>a <code>SqlNode</code> instance</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)"> |
| <h3>validateExpression</h3> |
| <div class="member-signature"><span class="return-type"><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">validateExpression</span><wbr><span class="parameters">(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</span></div> |
| <div class="block">Validate the expression with a base table row type. The expression may reference the fields |
| of the row type defines.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rowType</code> - the table row type</dd> |
| <dd><code>expr</code> - the expression</dd> |
| <dt>Returns:</dt> |
| <dd>a validated <code>SqlNode</code>, usually it transforms |
| from a <code>SqlUnresolvedFunction</code> to a resolved one</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExpression(org.apache.calcite.sql.SqlNode)"> |
| <h3>convertExpression</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">convertExpression</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</span></div> |
| <div class="block">Converts a <code>SqlNode</code> to <code>RexNode</code>. |
| |
| <p>Caution that the <code>SqlNode</code> must be validated, |
| you can use <a href="#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)"><code>validateExpression(org.apache.calcite.rel.type.RelDataType, org.apache.calcite.sql.SqlNode)</code></a> to validate if the <code>SqlNode</code> |
| is un-validated.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>expr</code> - the expression of sql node to convert</dd> |
| <dt>Returns:</dt> |
| <dd>a converted <code>RexNode</code> instance</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> |
