javadocAggregate/org/apache/calcite/prepare/PlannerImpl.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>PlannerImpl (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.prepare, class: PlannerImpl">
 <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:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.prepare</a></div>
 <h1 title="Class PlannerImpl" class="title">Class PlannerImpl</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.calcite.prepare.PlannerImpl</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</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>, <code><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code>, <code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PlannerImpl</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 implements <a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a>, <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></span></div>
 <div class="block">Implementation of <a href="../tools/Planner.html" title="interface in org.apache.calcite.tools"><code>Planner</code></a>.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>class&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="PlannerImpl.ViewExpanderImpl.html" class="type-name-link" title="class in org.apache.calcite.prepare">PlannerImpl.ViewExpanderImpl</a></code></div>
 <div class="col-last even-row-color">
 <div class="block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Now <a href="PlannerImpl.html" title="class in org.apache.calcite.prepare"><code>PlannerImpl</code></a> implements <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan"><code>RelOptTable.ViewExpander</code></a>
  directly.</div>
 </div>
 </div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.tools.FrameworkConfig)" class="member-name-link">PlannerImpl</a><wbr>(<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a planner.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
 <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-tab4"><code>final <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-tab4"><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>&nbsp;sql)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)" class="member-name-link">expandView</a><wbr>(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
  <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>&nbsp;queryString,
  <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>&lt;<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>&gt;&nbsp;schemaPath,
  @Nullable <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>&lt;<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>&gt;&nbsp;viewPath)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a relational expression that is to be substituted for an access
  to a SQL view.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEmptyTraitSet()" class="member-name-link">getEmptyTraitSet</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameterRowType()" class="member-name-link">getParameterRowType</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a record type that contains the name and type of each parameter.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTypeFactory()" class="member-name-link">getTypeFactory</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the type factory.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><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>&nbsp;reader)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <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-tab4"><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-tab4"><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>&nbsp;sql)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <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-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
 <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-tab4"><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-tab4"><code><a href="#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)" class="member-name-link">transform</a><wbr>(int&nbsp;ruleSetIndex,
  <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;requiredOutputTraits,
  <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <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-tab4"><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-tab4"><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>&nbsp;sqlNode)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <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-tab4"><code><a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<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>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;sqlNode)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Validates a SQL statement.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.calcite.tools.Planner">Methods inherited from interface&nbsp;org.apache.calcite.tools.<a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></h3>
 <code><a href="../tools/Planner.html#parse(java.lang.String)">parse</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.calcite.tools.FrameworkConfig)">
 <h3>PlannerImpl</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PlannerImpl</span><wbr><span class="parameters">(<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config)</span></div>
 <div class="block">Creates a planner. Not a public API; call
  <a href="../tools/Frameworks.html#getPlanner(org.apache.calcite.tools.FrameworkConfig)"><code>Frameworks.getPlanner(org.apache.calcite.tools.FrameworkConfig)</code></a> instead.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getEmptyTraitSet()">
 <h3>getEmptyTraitSet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span>&nbsp;<span class="element-name">getEmptyTraitSet</span>()</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#getEmptyTraitSet()">getEmptyTraitSet</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="close()">
 <h3>close</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#close()">Planner</a></code></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>&nbsp;in interface&nbsp;<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>
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="reset()">
 <h3>reset</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">reset</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#reset()">Planner</a></code></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>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="parse(java.io.Reader)">
 <h3>parse</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<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>&nbsp;reader)</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#parse(java.io.Reader)">Planner</a></code></span></div>
 <div class="block">Parses and validates a SQL statement.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#parse(java.io.Reader)">parse</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>reader</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="annotations">@EnsuresNonNull("validator")
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<span class="element-name">validate</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)</span>
                  throws <span class="exceptions"><a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
 <div class="block">Validates a SQL statement.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)">validate</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <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="../tools/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="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">validateAndGetType</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)</span>
                                              throws <span class="exceptions"><a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#validateAndGetType(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
 <div class="block">Validates a SQL statement.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#validateAndGetType(org.apache.calcite.sql.SqlNode)">validateAndGetType</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <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="../tools/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="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="element-name">getParameterRowType</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#getParameterRowType()">Planner</a></code></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>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#getParameterRowType()">getParameterRowType</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <dt>Returns:</dt>
 <dd>Record type</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="convert(org.apache.calcite.sql.SqlNode)">
 <h3>convert</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">convert</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)</span></div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#convert(org.apache.calcite.sql.SqlNode)">convert</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="rel(org.apache.calcite.sql.SqlNode)">
 <h3>rel</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></span>&nbsp;<span class="element-name">rel</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#rel(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
 <div class="block">Converts a SQL parse tree into a tree of relational expressions.

  <p>You must call <a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)"><code>Planner.validate(org.apache.calcite.sql.SqlNode)</code></a> first.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#rel(org.apache.calcite.sql.SqlNode)">rel</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <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>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">
 <h3>expandView</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></span>&nbsp;<span class="element-name">expandView</span><wbr><span class="parameters">(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
  <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>&nbsp;queryString,
  <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>&lt;<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>&gt;&nbsp;schemaPath,
  @Nullable <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>&lt;<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>&gt;&nbsp;viewPath)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../plan/RelOptTable.ViewExpander.html#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">RelOptTable.ViewExpander</a></code></span></div>
 <div class="block">Returns a relational expression that is to be substituted for an access
  to a SQL view.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelOptTable.ViewExpander.html#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">expandView</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>rowType</code> - Row type of the view</dd>
 <dd><code>queryString</code> - Body of the view</dd>
 <dd><code>schemaPath</code> - Path of a schema wherein to find referenced tables</dd>
 <dd><code>viewPath</code> - Path of the view, ending with its name; may be null</dd>
 <dt>Returns:</dt>
 <dd>Relational expression</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getTypeFactory()">
 <h3>getTypeFactory</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a></span>&nbsp;<span class="element-name">getTypeFactory</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#getTypeFactory()">Planner</a></code></span></div>
 <div class="block">Returns the type factory.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#getTypeFactory()">getTypeFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 </dl>
 </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="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">transform</span><wbr><span class="parameters">(int&nbsp;ruleSetIndex,
  <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;requiredOutputTraits,
  <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">Planner</a></code></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>Specified by:</dt>
 <dd><code><a href="../tools/Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">transform</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
 <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>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>