| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>InitializerExpressionFactory (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: InitializerExpressionFactory"> |
| <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 InitializerExpressionFactory" class="title">Interface InitializerExpressionFactory</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../test/catalog/CountingFactory.html" title="class in org.apache.calcite.test.catalog">CountingFactory</a></code>, <code><a href="NullInitializerExpressionFactory.html" title="class in org.apache.calcite.sql2rel">NullInitializerExpressionFactory</a></code>, <code><a href="../test/catalog/VirtualColumnsExpressionFactory.html" title="class in org.apache.calcite.test.catalog">VirtualColumnsExpressionFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">InitializerExpressionFactory</span></div> |
| <div class="block">InitializerExpressionFactory supplies default values for INSERT, UPDATE, and NEW.</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-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><a href="../schema/ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#generationStrategy(org.apache.calcite.plan.RelOptTable,int)" class="member-name-link">generationStrategy</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns how a column is populated.</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>boolean</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="#isGeneratedAlways(org.apache.calcite.plan.RelOptTable,int)" class="member-name-link">isGeneratedAlways</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</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 class="deprecation-comment">Use <code>c.generationStrategy(t, i) == VIRTUAL |
| || c.generationStrategy(t, i) == STORED</code></div> |
| </div> |
| </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="#newAttributeInitializer(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlFunction,int,java.util.List,org.apache.calcite.sql2rel.InitializerContext)" class="member-name-link">newAttributeInitializer</a><wbr>(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| <a href="../sql/SqlFunction.html" title="class in org.apache.calcite.sql">SqlFunction</a> constructor, |
| int iAttribute, |
| <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="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> constructorArgs, |
| <a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates an expression which evaluates to the initializer expression for a |
| particular attribute of a structured type.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newColumnDefaultValue(org.apache.calcite.plan.RelOptTable,int,org.apache.calcite.sql2rel.InitializerContext)" class="member-name-link">newColumnDefaultValue</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn, |
| <a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates an expression which evaluates to the default value for a |
| particular column.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html" title="class or interface in java.util.function" class="external-link">BiFunction</a><<a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a>,<wbr><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#postExpressionConversionHook()" class="member-name-link">postExpressionConversionHook</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a hook function to customize the relational expression right after the column |
| expressions are converted.</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="isGeneratedAlways(org.apache.calcite.plan.RelOptTable,int)"> |
| <h3>isGeneratedAlways</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">boolean</span> <span class="element-name">isGeneratedAlways</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <code>c.generationStrategy(t, i) == VIRTUAL |
| || c.generationStrategy(t, i) == STORED</code></div> |
| </div> |
| <div class="block">Whether a column is always generated. If a column is always generated, |
| then non-generated values cannot be inserted into the column.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#generationStrategy(org.apache.calcite.plan.RelOptTable,int)"><code>generationStrategy(RelOptTable, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generationStrategy(org.apache.calcite.plan.RelOptTable,int)"> |
| <h3>generationStrategy</h3> |
| <div class="member-signature"><span class="return-type"><a href="../schema/ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></span> <span class="element-name">generationStrategy</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</span></div> |
| <div class="block">Returns how a column is populated.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - the table containing the column</dd> |
| <dd><code>iColumn</code> - the 0-based offset of the column in the table</dd> |
| <dt>Returns:</dt> |
| <dd>generation strategy, never null</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../plan/RelOptTable.html#getColumnStrategies()"><code>RelOptTable.getColumnStrategies()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newColumnDefaultValue(org.apache.calcite.plan.RelOptTable,int,org.apache.calcite.sql2rel.InitializerContext)"> |
| <h3>newColumnDefaultValue</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">newColumnDefaultValue</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn, |
| <a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</span></div> |
| <div class="block">Creates an expression which evaluates to the default value for a |
| particular column. |
| |
| <p>If the default value comes from a un-validated <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a>, |
| make sure to invoke <a href="InitializerContext.html#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)"><code>InitializerContext.validateExpression(org.apache.calcite.rel.type.RelDataType, org.apache.calcite.sql.SqlNode)</code></a> first before you actually |
| do the conversion with method <a href="InitializerContext.html#convertExpression(org.apache.calcite.sql.SqlNode)"><code>InitializerContext.convertExpression(org.apache.calcite.sql.SqlNode)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - the table containing the column</dd> |
| <dd><code>iColumn</code> - the 0-based offset of the column in the table</dd> |
| <dd><code>context</code> - Context for creating the expression</dd> |
| <dt>Returns:</dt> |
| <dd>default value expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="postExpressionConversionHook()"> |
| <h3>postExpressionConversionHook</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html" title="class or interface in java.util.function" class="external-link">BiFunction</a><<a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a>,<wbr><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="element-name">postExpressionConversionHook</span>()</div> |
| <div class="block">Creates a hook function to customize the relational expression right after the column |
| expressions are converted. Usually the relational expression is a projection |
| above a table scan.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a hook function to transform the relational expression |
| right after the column expression conversion to a customized one</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#newColumnDefaultValue(org.apache.calcite.plan.RelOptTable,int,org.apache.calcite.sql2rel.InitializerContext)"><code>newColumnDefaultValue(RelOptTable, int, InitializerContext)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAttributeInitializer(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlFunction,int,java.util.List,org.apache.calcite.sql2rel.InitializerContext)"> |
| <h3>newAttributeInitializer</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">newAttributeInitializer</span><wbr><span class="parameters">(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| <a href="../sql/SqlFunction.html" title="class in org.apache.calcite.sql">SqlFunction</a> constructor, |
| int iAttribute, |
| <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="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> constructorArgs, |
| <a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</span></div> |
| <div class="block">Creates an expression which evaluates to the initializer expression for a |
| particular attribute of a structured type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the structured type</dd> |
| <dd><code>constructor</code> - the constructor invoked to initialize the type</dd> |
| <dd><code>iAttribute</code> - the 0-based offset of the attribute in the type</dd> |
| <dd><code>constructorArgs</code> - arguments passed to the constructor invocation</dd> |
| <dd><code>context</code> - Context for creating the expression</dd> |
| <dt>Returns:</dt> |
| <dd>default value expression</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> |
