blob: eae4c8903873b6df1f6fbb81dd7ee09d76fe74af [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>CalcitePrepareImpl (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: CalcitePrepareImpl">
<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><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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 CalcitePrepareImpl" class="title">Class CalcitePrepareImpl</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.CalcitePrepareImpl</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CalcitePrepareImpl</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="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></span></div>
<div class="block">Shit just got real.
<p>This class is public so that projects that create their own JDBC driver
and server can fine-tune preferences. However, this class and its methods are
subject to change without notice.</p></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="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.calcite.jdbc.CalcitePrepare">Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.jdbc.<a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></h2>
<code><a href="../jdbc/CalcitePrepare.AnalyzeViewResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.AnalyzeViewResult</a>, <a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;<a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="type parameter in CalcitePrepare.CalciteSignature">T</a>&gt;, <a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>, <a href="../jdbc/CalcitePrepare.ConvertResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ConvertResult</a>, <a href="../jdbc/CalcitePrepare.Dummy.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Dummy</a>, <a href="../jdbc/CalcitePrepare.ParseResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ParseResult</a>, <a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Query</a>&lt;<a href="../jdbc/CalcitePrepare.Query.html" title="type parameter in CalcitePrepare.Query">T</a>&gt;, <a href="../jdbc/CalcitePrepare.SparkHandler.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.SparkHandler</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#ENABLE_ENUMERABLE" class="member-name-link">ENABLE_ENUMERABLE</a></code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first odd-row-color"><code>static final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#ENABLE_STREAM" class="member-name-link">ENABLE_STREAM</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first even-row-color"><code>final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#enableBindable" class="member-name-link">enableBindable</a></code></div>
<div class="col-last even-row-color">
<div class="block">Whether the bindable convention should be the root convention of any
plan.</div>
</div>
<div class="col-first odd-row-color"><code>static final <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="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#ENUMERABLE_RULES" class="member-name-link">ENUMERABLE_RULES</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.jdbc.CalcitePrepare">Fields inherited from interface&nbsp;org.apache.calcite.jdbc.<a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></h3>
<code><a href="../jdbc/CalcitePrepare.html#DEFAULT_FACTORY">DEFAULT_FACTORY</a>, <a href="../jdbc/CalcitePrepare.html#THREAD_CONTEXT_STACK">THREAD_CONTEXT_STACK</a></code></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()" class="member-name-link">CalcitePrepareImpl</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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><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-tab4"><code><a href="../jdbc/CalcitePrepare.AnalyzeViewResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.AnalyzeViewResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String,boolean)" class="member-name-link">analyzeView</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;sql,
boolean&nbsp;fail)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Analyzes a view.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../jdbc/CalcitePrepare.ConvertResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ConvertResult</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.jdbc.CalcitePrepare.Context,java.lang.String)" class="member-name-link">convert</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;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>protected <a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createCluster(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rex.RexBuilder)" class="member-name-link">createCluster</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Factory method for cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createConvertletTable()" class="member-name-link">createConvertletTable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Factory method for default convertlet table.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createParser(java.lang.String)" class="member-name-link">createParser</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>&nbsp;sql)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Factory method for default SQL parser.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createParser(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)" class="member-name-link">createParser</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>&nbsp;sql,
<a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;parserConfig)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Factory method for SQL parser with a given configuration.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>protected <a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createParser(java.lang.String,org.apache.calcite.sql.parser.SqlParser.ConfigBuilder)" class="member-name-link">createParser</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>&nbsp;sql,
<a href="../sql/parser/SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a>&nbsp;parserConfig)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>protected <a href="../sql/parser/SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createParserConfig()" class="member-name-link">createParserConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context)" class="member-name-link">createPlanner</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;prepareContext)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a query planner and initializes it with a default set of
rules.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.plan.Context,org.apache.calcite.plan.RelOptCostFactory)" class="member-name-link">createPlanner</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;prepareContext,
@Nullable <a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;externalContext,
@Nullable <a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a query planner and initializes it with a default set of
rules.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>,<wbr><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createPlannerFactories()" class="member-name-link">createPlannerFactories</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates a collection of planner factories.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#executeDdl(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.sql.SqlNode)" class="member-name-link">executeDdl</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;node)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Executes a DDL statement.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../jdbc/CalcitePrepare.ParseResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ParseResult</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(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String)" class="member-name-link">parse</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;sql)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parserConfig()" class="member-name-link">parserConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Factory method for SQL parser configuration.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;R&gt;&nbsp;R</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#perform(org.apache.calcite.server.CalciteServerStatement,org.apache.calcite.tools.FrameworkConfig,org.apache.calcite.tools.Frameworks.BasePrepareAction)" class="member-name-link">perform</a><wbr>(<a href="../server/CalciteServerStatement.html" title="interface in org.apache.calcite.server">CalciteServerStatement</a>&nbsp;statement,
<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config,
<a href="../tools/Frameworks.BasePrepareAction.html" title="interface in org.apache.calcite.tools">Frameworks.BasePrepareAction</a>&lt;R&gt;&nbsp;action)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Executes a prepare action.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>&lt;R&gt;&nbsp;R</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#perform(org.apache.calcite.server.CalciteServerStatement,org.apache.calcite.tools.Frameworks.PrepareAction)" class="member-name-link">perform</a><wbr>(<a href="../server/CalciteServerStatement.html" title="interface in org.apache.calcite.server">CalciteServerStatement</a>&nbsp;statement,
<a href="../tools/Frameworks.PrepareAction.html" title="class in org.apache.calcite.tools">Frameworks.PrepareAction</a>&lt;R&gt;&nbsp;action)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#populateMaterializations(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.plan.RelOptCluster,org.apache.calcite.prepare.Prepare.Materialization)" class="member-name-link">populateMaterializations</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a>&nbsp;cluster,
<a href="Prepare.Materialization.html" title="class in org.apache.calcite.prepare">Prepare.Materialization</a>&nbsp;materialization)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;T&gt;&nbsp;<a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;T&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepareQueryable(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.linq4j.Queryable)" class="member-name-link">prepareQueryable</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a>&lt;T&gt;&nbsp;queryable)</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>&lt;T&gt;&nbsp;<a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;T&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepareSql(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.jdbc.CalcitePrepare.Query,java.lang.reflect.Type,long)" class="member-name-link">prepareSql</a><wbr>(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Query</a>&lt;T&gt;&nbsp;query,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a>&nbsp;elementType,
long&nbsp;maxRowCount)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="ENABLE_ENUMERABLE">
<h3>ENABLE_ENUMERABLE</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="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">ENABLE_ENUMERABLE</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="ENABLE_STREAM">
<h3>ENABLE_STREAM</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="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">ENABLE_STREAM</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="ENUMERABLE_RULES">
<h3>ENUMERABLE_RULES</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="modifiers">public static final</span>&nbsp;<span class="return-type"><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="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</span>&nbsp;<span class="element-name">ENUMERABLE_RULES</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="enableBindable">
<h3>enableBindable</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">enableBindable</span></div>
<div class="block">Whether the bindable convention should be the root convention of any
plan. If not, enumerable convention is the default.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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;()">
<h3>CalcitePrepareImpl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CalcitePrepareImpl</span>()</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="parse(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String)">
<h3>parse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../jdbc/CalcitePrepare.ParseResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ParseResult</a></span>&nbsp;<span class="element-name">parse</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;sql)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#parse(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String)">parse</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convert(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String)">
<h3>convert</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../jdbc/CalcitePrepare.ConvertResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ConvertResult</a></span>&nbsp;<span class="element-name">convert</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;sql)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#convert(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String)">convert</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String,boolean)">
<h3>analyzeView</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../jdbc/CalcitePrepare.AnalyzeViewResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.AnalyzeViewResult</a></span>&nbsp;<span class="element-name">analyzeView</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<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;sql,
boolean&nbsp;fail)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../jdbc/CalcitePrepare.html#analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String,boolean)">CalcitePrepare</a></code></span></div>
<div class="block">Analyzes a view.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context,java.lang.String,boolean)">analyzeView</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - Context</dd>
<dd><code>sql</code> - View SQL</dd>
<dd><code>fail</code> - Whether to fail (and throw a descriptive error message) if the
view is not modifiable</dd>
<dt>Returns:</dt>
<dd>Result of analyzing the view</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="executeDdl(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.sql.SqlNode)">
<h3>executeDdl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">executeDdl</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;node)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../jdbc/CalcitePrepare.html#executeDdl(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.sql.SqlNode)">CalcitePrepare</a></code></span></div>
<div class="block">Executes a DDL statement.
<p>The statement identified itself as DDL in the
<a href="../jdbc/CalcitePrepare.ParseResult.html#kind()"><code>CalcitePrepare.ParseResult.kind()</code></a> field.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#executeDdl(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.sql.SqlNode)">executeDdl</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createParser(java.lang.String)">
<h3>createParser</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span>&nbsp;<span class="element-name">createParser</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>&nbsp;sql)</span></div>
<div class="block">Factory method for default SQL parser.</div>
</section>
</li>
<li>
<section class="detail" id="createParser(java.lang.String,org.apache.calcite.sql.parser.SqlParser.Config)">
<h3>createParser</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span>&nbsp;<span class="element-name">createParser</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>&nbsp;sql,
<a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;parserConfig)</span></div>
<div class="block">Factory method for SQL parser with a given configuration.</div>
</section>
</li>
<li>
<section class="detail" id="createParser(java.lang.String,org.apache.calcite.sql.parser.SqlParser.ConfigBuilder)">
<h3>createParser</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="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser">SqlParser</a></span>&nbsp;<span class="element-name">createParser</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>&nbsp;sql,
<a href="../sql/parser/SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a>&nbsp;parserConfig)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="parserConfig()">
<h3>parserConfig</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></span>&nbsp;<span class="element-name">parserConfig</span>()</div>
<div class="block">Factory method for SQL parser configuration.</div>
</section>
</li>
<li>
<section class="detail" id="createParserConfig()">
<h3>createParserConfig</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="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql/parser/SqlParser.ConfigBuilder.html" title="class in org.apache.calcite.sql.parser">SqlParser.ConfigBuilder</a></span>&nbsp;<span class="element-name">createParserConfig</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="createConvertletTable()">
<h3>createConvertletTable</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a></span>&nbsp;<span class="element-name">createConvertletTable</span>()</div>
<div class="block">Factory method for default convertlet table.</div>
</section>
</li>
<li>
<section class="detail" id="createCluster(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rex.RexBuilder)">
<h3>createCluster</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a></span>&nbsp;<span class="element-name">createCluster</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder)</span></div>
<div class="block">Factory method for cluster.</div>
</section>
</li>
<li>
<section class="detail" id="createPlannerFactories()">
<h3>createPlannerFactories</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><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="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>,<wbr><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&gt;&gt;</span>&nbsp;<span class="element-name">createPlannerFactories</span>()</div>
<div class="block">Creates a collection of planner factories.
<p>The collection must have at least one factory, and each factory must
create a planner. If the collection has more than one planner, Calcite will
try each planner in turn.</p>
<p>One of the things you can do with this mechanism is to try a simpler,
faster, planner with a smaller rule set first, then fall back to a more
complex planner for complex and costly queries.</p>
<p>The default implementation returns a factory that calls
<a href="#createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context)"><code>createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context)</code></a>.</p></div>
</section>
</li>
<li>
<section class="detail" id="createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context)">
<h3>createPlanner</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></span>&nbsp;<span class="element-name">createPlanner</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;prepareContext)</span></div>
<div class="block">Creates a query planner and initializes it with a default set of
rules.</div>
</section>
</li>
<li>
<section class="detail" id="createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.plan.Context,org.apache.calcite.plan.RelOptCostFactory)">
<h3>createPlanner</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></span>&nbsp;<span class="element-name">createPlanner</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;prepareContext,
@Nullable <a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;externalContext,
@Nullable <a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory)</span></div>
<div class="block">Creates a query planner and initializes it with a default set of
rules.</div>
</section>
</li>
<li>
<section class="detail" id="prepareQueryable(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.linq4j.Queryable)">
<h3>prepareQueryable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type"><a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;T&gt;</span>&nbsp;<span class="element-name">prepareQueryable</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a>&lt;T&gt;&nbsp;queryable)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#prepareQueryable(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.linq4j.Queryable)">prepareQueryable</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="prepareSql(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.jdbc.CalcitePrepare.Query,java.lang.reflect.Type,long)">
<h3>prepareSql</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type"><a href="../jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;T&gt;</span>&nbsp;<span class="element-name">prepareSql</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Query</a>&lt;T&gt;&nbsp;query,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a>&nbsp;elementType,
long&nbsp;maxRowCount)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../jdbc/CalcitePrepare.html#prepareSql(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.jdbc.CalcitePrepare.Query,java.lang.reflect.Type,long)">prepareSql</a></code>&nbsp;in interface&nbsp;<code><a href="../jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="populateMaterializations(org.apache.calcite.jdbc.CalcitePrepare.Context,org.apache.calcite.plan.RelOptCluster,org.apache.calcite.prepare.Prepare.Materialization)">
<h3>populateMaterializations</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">populateMaterializations</span><wbr><span class="parameters">(<a href="../jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a>&nbsp;context,
<a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a>&nbsp;cluster,
<a href="Prepare.Materialization.html" title="class in org.apache.calcite.prepare">Prepare.Materialization</a>&nbsp;materialization)</span></div>
</section>
</li>
<li>
<section class="detail" id="perform(org.apache.calcite.server.CalciteServerStatement,org.apache.calcite.tools.Frameworks.PrepareAction)">
<h3>perform</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="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type">R</span>&nbsp;<span class="element-name">perform</span><wbr><span class="parameters">(<a href="../server/CalciteServerStatement.html" title="interface in org.apache.calcite.server">CalciteServerStatement</a>&nbsp;statement,
<a href="../tools/Frameworks.PrepareAction.html" title="class in org.apache.calcite.tools">Frameworks.PrepareAction</a>&lt;R&gt;&nbsp;action)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="perform(org.apache.calcite.server.CalciteServerStatement,org.apache.calcite.tools.FrameworkConfig,org.apache.calcite.tools.Frameworks.BasePrepareAction)">
<h3>perform</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type">R</span>&nbsp;<span class="element-name">perform</span><wbr><span class="parameters">(<a href="../server/CalciteServerStatement.html" title="interface in org.apache.calcite.server">CalciteServerStatement</a>&nbsp;statement,
<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config,
<a href="../tools/Frameworks.BasePrepareAction.html" title="interface in org.apache.calcite.tools">Frameworks.BasePrepareAction</a>&lt;R&gt;&nbsp;action)</span></div>
<div class="block">Executes a prepare action.</div>
</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>