| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Planner (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.tools, interface: Planner"> |
| <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.tools</a></div> |
| <h1 title="Interface Planner" class="title">Interface Planner</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../prepare/PlannerImpl.html" title="class in org.apache.calcite.prepare">PlannerImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Planner</span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div> |
| <div class="block">A façade that covers Calcite's query planning process: parse SQL, |
| validate the parse tree, convert the parse tree to a relational expression, |
| and optimize the relational expression. |
| |
| <p>Planner is NOT thread safe. However, it can be reused for |
| different queries. The consumer of this interface is responsible for calling |
| reset() after each use of Planner that corresponds to a different |
| query.</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><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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Releases all internal resources utilized while this <code>Planner</code> |
| exists.</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><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></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="#convert(org.apache.calcite.sql.SqlNode)" class="member-name-link">convert</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sql)</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 <a href="#rel(org.apache.calcite.sql.SqlNode)"><code>rel(org.apache.calcite.sql.SqlNode)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEmptyTraitSet()" class="member-name-link">getEmptyTraitSet</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#getParameterRowType()" class="member-name-link">getParameterRowType</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 record type that contains the name and type of each parameter.</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/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTypeFactory()" class="member-name-link">getTypeFactory</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 type factory.</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="#parse(java.io.Reader)" class="member-name-link">parse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Parses and validates a SQL statement.</div> |
| </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="#parse(java.lang.String)" class="member-name-link">parse</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> sql)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Parses and validates a SQL statement.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rel(org.apache.calcite.sql.SqlNode)" class="member-name-link">rel</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sql)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts a SQL parse tree into a tree of relational expressions.</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="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Resets this <code>Planner</code> to be used with a new query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)" class="member-name-link">transform</a><wbr>(int ruleSetIndex, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> requiredOutputTraits, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts one relational expression tree into another relational expression |
| based on a particular rule set and requires set of traits.</div> |
| </div> |
| <div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#validate(org.apache.calcite.sql.SqlNode)" class="member-name-link">validate</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sqlNode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Validates a SQL statement.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><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="#validateAndGetType(org.apache.calcite.sql.SqlNode)" class="member-name-link">validateAndGetType</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sqlNode)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Validates a SQL statement.</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="parse(java.lang.String)"> |
| <h3>parse</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">parse</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> sql)</span> |
| throws <span class="exceptions"><a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses and validates a SQL statement.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sql</code> - The SQL statement to parse.</dd> |
| <dt>Returns:</dt> |
| <dd>The root node of the SQL parse tree.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - on parse error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parse(java.io.Reader)"> |
| <h3>parse</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">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> source)</span> |
| throws <span class="exceptions"><a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></span></div> |
| <div class="block">Parses and validates a SQL statement.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - A reader which will provide the SQL statement to parse.</dd> |
| <dt>Returns:</dt> |
| <dd>The root node of the SQL parse tree.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - on parse error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(org.apache.calcite.sql.SqlNode)"> |
| <h3>validate</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">validate</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sqlNode)</span> |
| throws <span class="exceptions"><a href="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></span></div> |
| <div class="block">Validates a SQL statement.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sqlNode</code> - Root node of the SQL parse tree.</dd> |
| <dt>Returns:</dt> |
| <dd>Validated node</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></code> - if not valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateAndGetType(org.apache.calcite.sql.SqlNode)"> |
| <h3>validateAndGetType</h3> |
| <div class="member-signature"><span class="return-type"><a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>></span> <span class="element-name">validateAndGetType</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sqlNode)</span> |
| throws <span class="exceptions"><a href="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></span></div> |
| <div class="block">Validates a SQL statement.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sqlNode</code> - Root node of the SQL parse tree.</dd> |
| <dt>Returns:</dt> |
| <dd>Validated node and its validated type.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></code> - if not valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParameterRowType()"> |
| <h3>getParameterRowType</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">getParameterRowType</span>()</div> |
| <div class="block">Returns a record type that contains the name and type of each parameter. |
| Returns a record type with no fields if there are no parameters.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Record type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rel(org.apache.calcite.sql.SqlNode)"> |
| <h3>rel</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></span> <span class="element-name">rel</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sql)</span> |
| throws <span class="exceptions"><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></span></div> |
| <div class="block">Converts a SQL parse tree into a tree of relational expressions. |
| |
| <p>You must call <a href="#validate(org.apache.calcite.sql.SqlNode)"><code>validate(org.apache.calcite.sql.SqlNode)</code></a> first.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sql</code> - The root node of the SQL parse tree.</dd> |
| <dt>Returns:</dt> |
| <dd>The root node of the newly generated RelNode tree.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code> - if the node |
| cannot be converted or has not been validated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convert(org.apache.calcite.sql.SqlNode)"> |
| <h3>convert</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"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">convert</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> sql)</span> |
| throws <span class="exceptions"><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#rel(org.apache.calcite.sql.SqlNode)"><code>rel(org.apache.calcite.sql.SqlNode)</code></a>.</div> |
| </div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeFactory()"> |
| <h3>getTypeFactory</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></span> <span class="element-name">getTypeFactory</span>()</div> |
| <div class="block">Returns the type factory.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)"> |
| <h3>transform</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">transform</span><wbr><span class="parameters">(int ruleSetIndex, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> requiredOutputTraits, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span> |
| throws <span class="exceptions"><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></span></div> |
| <div class="block">Converts one relational expression tree into another relational expression |
| based on a particular rule set and requires set of traits.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ruleSetIndex</code> - The RuleSet to use for conversion purposes. Note that |
| this is zero-indexed and is based on the list and order |
| of RuleSets provided in the construction of this |
| Planner.</dd> |
| <dd><code>requiredOutputTraits</code> - The set of RelTraits required of the root node |
| at the termination of the planning cycle.</dd> |
| <dd><code>rel</code> - The root of the RelNode tree to convert.</dd> |
| <dt>Returns:</dt> |
| <dd>The root of the new RelNode tree.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code> - on conversion |
| error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reset()"> |
| <h3>reset</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">reset</span>()</div> |
| <div class="block">Resets this <code>Planner</code> to be used with a new query. This |
| should be called between each new query.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block">Releases all internal resources utilized while this <code>Planner</code> |
| exists. Once called, this Planner object is no longer valid.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEmptyTraitSet()"> |
| <h3>getEmptyTraitSet</h3> |
| <div class="member-signature"><span class="return-type"><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="element-name">getEmptyTraitSet</span>()</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> |
