blob: c4d24a9377c635472424b8c1a398eaafae6eb1c8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FrameworkConfig (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FrameworkConfig (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FrameworkConfig.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.tools</a></div>
<h2 title="Interface FrameworkConfig" class="title">Interface FrameworkConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="Frameworks.StdFrameworkConfig.html" title="class in org.apache.calcite.tools">Frameworks.StdFrameworkConfig</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">FrameworkConfig</span></pre>
<div class="block">Interface that describes how to configure planning sessions generated
using the Frameworks tools.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Frameworks.html#newConfigBuilder()"><code>Frameworks.newConfigBuilder()</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the PlannerContext that should be made available during planning by
calling <a href="../plan/RelOptPlanner.html#getContext()"><code>RelOptPlanner.getContext()</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConvertletTable()">getConvertletTable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the convertlet table that should be used when converting from SQL
to row expressions</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCostFactory()">getCostFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the cost factory that should be used when creating the planner.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultSchema()">getDefaultSchema</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the default schema that should be checked before looking at the
root schema.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the executor used to evaluate constant expressions.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperatorTable()">getOperatorTable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns operator table that should be used to
resolve functions and operators during query validation.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParserConfig()">getParserConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">The configuration of SQL parser.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrograms()">getPrograms</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of one or more programs used during the course of query
evaluation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlToRelConverterConfig()">getSqlToRelConverterConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">The configuration of <a href="../sql2rel/SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel"><code>SqlToRelConverter</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../materialize/SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatisticProvider()">getStatisticProvider</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the source of statistics about tables and columns to be used
by the lattice suggester to deduce primary keys, foreign keys, and the
direction of relationships.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraitDefs()">getTraitDefs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of trait definitions.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../rel/type/RelDataTypeSystem.html" title="interface in org.apache.calcite.rel.type">RelDataTypeSystem</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeSystem()">getTypeSystem</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type system.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getViewExpander()">getViewExpander</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a view expander.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEvolveLattice()">isEvolveLattice</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the lattice suggester should try to widen a lattice when a
new query arrives that doesn't quite fit, as opposed to creating a new
lattice.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getParserConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParserConfig</h4>
<pre class="methodSignature"><a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a>&nbsp;getParserConfig()</pre>
<div class="block">The configuration of SQL parser.</div>
</li>
</ul>
<a id="getSqlToRelConverterConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSqlToRelConverterConfig</h4>
<pre class="methodSignature"><a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a>&nbsp;getSqlToRelConverterConfig()</pre>
<div class="block">The configuration of <a href="../sql2rel/SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel"><code>SqlToRelConverter</code></a>.</div>
</li>
</ul>
<a id="getDefaultSchema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultSchema</h4>
<pre class="methodSignature"><a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;getDefaultSchema()</pre>
<div class="block">Returns the default schema that should be checked before looking at the
root schema. Returns null to only consult the root schema.</div>
</li>
</ul>
<a id="getExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutor</h4>
<pre class="methodSignature"><a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a>&nbsp;getExecutor()</pre>
<div class="block">Returns the executor used to evaluate constant expressions.</div>
</li>
</ul>
<a id="getPrograms()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrograms</h4>
<pre class="methodSignature">com.google.common.collect.ImmutableList&lt;<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;&nbsp;getPrograms()</pre>
<div class="block">Returns a list of one or more programs used during the course of query
evaluation.
<p>The common use case is when there is a single program
created using <a href="Programs.html#of(org.apache.calcite.tools.RuleSet)"><code>Programs.of(RuleSet)</code></a>
and <a href="Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)"><code>Planner.transform(int, org.apache.calcite.plan.RelTraitSet, org.apache.calcite.rel.RelNode)</code></a>
will only be called once.
<p>However, consumers may also create programs
not based on rule sets, register multiple programs,
and do multiple repetitions
of <a href="Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)"><code>Planner.transform(int, org.apache.calcite.plan.RelTraitSet, org.apache.calcite.rel.RelNode)</code></a> planning cycles using different indices.
<p>The order of programs provided here determines the zero-based indices
of programs elsewhere in this class.</div>
</li>
</ul>
<a id="getOperatorTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperatorTable</h4>
<pre class="methodSignature"><a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a>&nbsp;getOperatorTable()</pre>
<div class="block">Returns operator table that should be used to
resolve functions and operators during query validation.</div>
</li>
</ul>
<a id="getCostFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCostFactory</h4>
<pre class="methodSignature"><a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;getCostFactory()</pre>
<div class="block">Returns the cost factory that should be used when creating the planner.
If null, use the default cost factory for that planner.</div>
</li>
</ul>
<a id="getTraitDefs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitDefs</h4>
<pre class="methodSignature">com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;&nbsp;getTraitDefs()</pre>
<div class="block">Returns a list of trait definitions.
<p>If the list is not null, the planner first de-registers any
existing <a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan"><code>RelTraitDef</code></a>s, then registers the <code>RelTraitDef</code>s in
this list.</p>
<p>The order of <code>RelTraitDef</code>s in the list matters if the
planner is VolcanoPlanner. The planner calls <a href="../plan/RelTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)"><code>RelTraitDef.convert(org.apache.calcite.plan.RelOptPlanner, org.apache.calcite.rel.RelNode, T, boolean)</code></a> in
the order of this list. The most important trait comes first in the list,
followed by the second most important one, etc.</p></div>
</li>
</ul>
<a id="getConvertletTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConvertletTable</h4>
<pre class="methodSignature"><a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a>&nbsp;getConvertletTable()</pre>
<div class="block">Returns the convertlet table that should be used when converting from SQL
to row expressions</div>
</li>
</ul>
<a id="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre class="methodSignature"><a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;getContext()</pre>
<div class="block">Returns the PlannerContext that should be made available during planning by
calling <a href="../plan/RelOptPlanner.html#getContext()"><code>RelOptPlanner.getContext()</code></a>.</div>
</li>
</ul>
<a id="getTypeSystem()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeSystem</h4>
<pre class="methodSignature"><a href="../rel/type/RelDataTypeSystem.html" title="interface in org.apache.calcite.rel.type">RelDataTypeSystem</a>&nbsp;getTypeSystem()</pre>
<div class="block">Returns the type system.</div>
</li>
</ul>
<a id="isEvolveLattice()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEvolveLattice</h4>
<pre class="methodSignature">boolean&nbsp;isEvolveLattice()</pre>
<div class="block">Returns whether the lattice suggester should try to widen a lattice when a
new query arrives that doesn't quite fit, as opposed to creating a new
lattice.</div>
</li>
</ul>
<a id="getStatisticProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatisticProvider</h4>
<pre class="methodSignature"><a href="../materialize/SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a>&nbsp;getStatisticProvider()</pre>
<div class="block">Returns the source of statistics about tables and columns to be used
by the lattice suggester to deduce primary keys, foreign keys, and the
direction of relationships.</div>
</li>
</ul>
<a id="getViewExpander()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getViewExpander</h4>
<pre class="methodSignature"><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a>&nbsp;getViewExpander()</pre>
<div class="block">Returns a view expander.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FrameworkConfig.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>