| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ModifiableView (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.schema, interface: ModifiableView"> |
| <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.schema</a></div> |
| <h1 title="Interface ModifiableView" class="title">Interface ModifiableView</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../test/AbstractModifiableView.html" title="class in org.apache.calcite.test">AbstractModifiableView</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable</a></code>, <code><a href="impl/ModifiableViewTable.html" title="class in org.apache.calcite.schema.impl">ModifiableViewTable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ModifiableView</span><span class="extends-implements"> |
| extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span></div> |
| <div class="block">A modifiable view onto <a href="ModifiableTable.html" title="interface in org.apache.calcite.schema"><code>ModifiableTable</code></a>. |
| |
| <p>It describes how its columns map onto the underlying table's columns, |
| and any constraints that incoming rows must satisfy. |
| |
| <p>For example, given |
| |
| <blockquote><pre> |
| CREATE TABLE emps (empno INTEGER, gender VARCHAR(1), deptno INTEGER); |
| CREATE VIEW female_emps AS |
| SELECT empno, deptno FROM emps WHERE gender = 'F'; |
| </pre></blockquote> |
| |
| <p>constraint is <code>$1 = 'F'</code> |
| and column mapping is <code>[0, 2]</code>. |
| |
| <p>NOTE: The current API is inefficient and experimental. It will change |
| without notice.</p></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></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="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getColumnMapping()" class="member-name-link">getColumnMapping</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 column mapping onto another table.</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="#getConstraint(org.apache.calcite.rex.RexBuilder,org.apache.calcite.rel.type.RelDataType)" class="member-name-link">getConstraint</a><wbr>(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a> rexBuilder, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> tableRowType)</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 constraint that each candidate row must satisfy.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</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.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Path.html" title="interface in org.apache.calcite.schema">Path</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTablePath()" class="member-name-link">getTablePath</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 full path of the underlying table.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Table">Methods inherited from interface org.apache.calcite.schema.<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></h3> |
| <code><a href="Table.html#getJdbcTableType()">getJdbcTableType</a>, <a href="Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a>, <a href="Table.html#getStatistic()">getStatistic</a>, <a href="Table.html#isRolledUp(java.lang.String)">isRolledUp</a>, <a href="Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code></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="getConstraint(org.apache.calcite.rex.RexBuilder,org.apache.calcite.rel.type.RelDataType)"> |
| <h3>getConstraint</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">getConstraint</span><wbr><span class="parameters">(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a> rexBuilder, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> tableRowType)</span></div> |
| <div class="block">Returns a constraint that each candidate row must satisfy. |
| |
| <p>Never null; if there is no constraint, returns "true".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rexBuilder</code> - Rex builder</dd> |
| <dd><code>tableRowType</code> - Row type of the table that this view maps onto</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getColumnMapping()"> |
| <h3>getColumnMapping</h3> |
| <div class="member-signature"><span class="return-type"><a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a></span> <span class="element-name">getColumnMapping</span>()</div> |
| <div class="block">Returns the column mapping onto another table. |
| |
| <p><code>mapping[i]</code> contains the column of the underlying table that the |
| <code>i</code>th column of the view comes from, or -1 if it is based on an |
| expression.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable()"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="return-type"><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span> <span class="element-name">getTable</span>()</div> |
| <div class="block">Returns the underlying table.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTablePath()"> |
| <h3>getTablePath</h3> |
| <div class="member-signature"><span class="return-type"><a href="Path.html" title="interface in org.apache.calcite.schema">Path</a></span> <span class="element-name">getTablePath</span>()</div> |
| <div class="block">Returns the full path of the underlying table.</div> |
| </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> |
