| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlTableFunction (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, interface: SqlTableFunction"> |
| <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</a></div> |
| <h1 title="Interface SqlTableFunction" class="title">Interface SqlTableFunction</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../test/MockSqlOperatorTable.BadTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.BadTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.DedupFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.DedupFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.DynamicTypeFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.DynamicTypeFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.InvalidTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.InvalidTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.RampFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.RampFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.RowFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.RowFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.ScoreTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.ScoreTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.SimilarlityTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.SimilarlityTableFunction</a></code>, <code><a href="../test/MockSqlOperatorTable.TopNTableFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.TopNTableFunction</a></code>, <code><a href="SqlHopTableFunction.html" title="class in org.apache.calcite.sql">SqlHopTableFunction</a></code>, <code><a href="SqlSessionTableFunction.html" title="class in org.apache.calcite.sql">SqlSessionTableFunction</a></code>, <code><a href="SqlTumbleTableFunction.html" title="class in org.apache.calcite.sql">SqlTumbleTableFunction</a></code>, <code><a href="validate/SqlUserDefinedTableFunction.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedTableFunction</a></code>, <code><a href="validate/SqlUserDefinedTableMacro.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedTableMacro</a></code>, <code><a href="SqlWindowTableFunction.html" title="class in org.apache.calcite.sql">SqlWindowTableFunction</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlTableFunction</span></div> |
| <div class="block">A function that returns a table.</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="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowTypeInference()" class="member-name-link">getRowTypeInference</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 record type of the table yielded by this function when |
| applied to given arguments.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @Nullable <a href="TableCharacteristic.html" title="class in org.apache.calcite.sql">TableCharacteristic</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#tableCharacteristic(int)" class="member-name-link">tableCharacteristic</a><wbr>(int ordinal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the table parameter characteristics for <code>ordinal</code>th |
| parameter to this table function.</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="getRowTypeInference()"> |
| <h3>getRowTypeInference</h3> |
| <div class="member-signature"><span class="return-type"><a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a></span> <span class="element-name">getRowTypeInference</span>()</div> |
| <div class="block">Returns the record type of the table yielded by this function when |
| applied to given arguments. Only literal arguments are passed, |
| non-literal are replaced with default values (null, 0, false, etc).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>strategy to infer the row type of a call to this function</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tableCharacteristic(int)"> |
| <h3>tableCharacteristic</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">@Nullable <a href="TableCharacteristic.html" title="class in org.apache.calcite.sql">TableCharacteristic</a></span> <span class="element-name">tableCharacteristic</span><wbr><span class="parameters">(int ordinal)</span></div> |
| <div class="block">Returns the table parameter characteristics for <code>ordinal</code>th |
| parameter to this table function. |
| |
| <p>Returns <code>null</code> if the <code>ordinal</code>th argument is |
| not table parameter or the <code>ordinal</code> is smaller than 0 or |
| the <code>ordinal</code> is greater than or equals to the number of |
| parameters.</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> |
