blob: 444c6da2f645071256f2b2f8a1bb0235c2edbe22 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>FrameworkConfig (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.tools, interface: FrameworkConfig">
<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>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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.tools</a></div>
<h1 title="Interface FrameworkConfig" class="title">Interface FrameworkConfig</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">FrameworkConfig</span></div>
<div class="block">Interface that describes how to configure planning sessions generated
using the Frameworks tools.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="Frameworks.html#newConfigBuilder()"><code>Frameworks.newConfigBuilder()</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the PlannerContext that should be made available during planning by
calling <a href="../plan/RelOptPlanner.html#getContext()"><code>RelOptPlanner.getContext()</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab3"><code><a href="#getConvertletTable()" class="member-name-link">getConvertletTable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the convertlet table that should be used when converting from SQL
to row expressions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCostFactory()" class="member-name-link">getCostFactory</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the cost factory that should be used when creating the planner.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDefaultSchema()" class="member-name-link">getDefaultSchema</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the default schema that should be checked before looking at the
root schema.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getExecutor()" class="member-name-link">getExecutor</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the executor used to evaluate constant expressions.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOperatorTable()" class="member-name-link">getOperatorTable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns operator table that should be used to
resolve functions and operators during query validation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getParserConfig()" class="member-name-link">getParserConfig</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The configuration of SQL parser.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>com.google.common.collect.ImmutableList&lt;<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPrograms()" class="member-name-link">getPrograms</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a list of one or more programs used during the course of query
evaluation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSqlToRelConverterConfig()" class="member-name-link">getSqlToRelConverterConfig</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The configuration of <a href="../sql2rel/SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel"><code>SqlToRelConverter</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../sql/validate/SqlValidator.Config.html" title="interface in org.apache.calcite.sql.validate">SqlValidator.Config</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSqlValidatorConfig()" class="member-name-link">getSqlValidatorConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The configuration of <a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../materialize/SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStatisticProvider()" class="member-name-link">getStatisticProvider</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the 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>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTraitDefs()" class="member-name-link">getTraitDefs</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a list of trait definitions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/type/RelDataTypeSystem.html" title="interface in org.apache.calcite.rel.type">RelDataTypeSystem</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTypeSystem()" class="member-name-link">getTypeSystem</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the type system.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getViewExpander()" class="member-name-link">getViewExpander</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a view expander.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEvolveLattice()" class="member-name-link">isEvolveLattice</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns 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>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getParserConfig()">
<h3>getParserConfig</h3>
<div class="member-signature"><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">getParserConfig</span>()</div>
<div class="block">The configuration of SQL parser.</div>
</section>
</li>
<li>
<section class="detail" id="getSqlValidatorConfig()">
<h3>getSqlValidatorConfig</h3>
<div class="member-signature"><span class="return-type"><a href="../sql/validate/SqlValidator.Config.html" title="interface in org.apache.calcite.sql.validate">SqlValidator.Config</a></span>&nbsp;<span class="element-name">getSqlValidatorConfig</span>()</div>
<div class="block">The configuration of <a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="getSqlToRelConverterConfig()">
<h3>getSqlToRelConverterConfig</h3>
<div class="member-signature"><span class="return-type"><a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span>&nbsp;<span class="element-name">getSqlToRelConverterConfig</span>()</div>
<div class="block">The configuration of <a href="../sql2rel/SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel"><code>SqlToRelConverter</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="getDefaultSchema()">
<h3>getDefaultSchema</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></span>&nbsp;<span class="element-name">getDefaultSchema</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getExecutor()">
<h3>getExecutor</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></span>&nbsp;<span class="element-name">getExecutor</span>()</div>
<div class="block">Returns the executor used to evaluate constant expressions.</div>
</section>
</li>
<li>
<section class="detail" id="getPrograms()">
<h3>getPrograms</h3>
<div class="member-signature"><span class="return-type">com.google.common.collect.ImmutableList&lt;<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</span>&nbsp;<span class="element-name">getPrograms</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getOperatorTable()">
<h3>getOperatorTable</h3>
<div class="member-signature"><span class="return-type"><a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></span>&nbsp;<span class="element-name">getOperatorTable</span>()</div>
<div class="block">Returns operator table that should be used to
resolve functions and operators during query validation.</div>
</section>
</li>
<li>
<section class="detail" id="getCostFactory()">
<h3>getCostFactory</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../plan/RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></span>&nbsp;<span class="element-name">getCostFactory</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getTraitDefs()">
<h3>getTraitDefs</h3>
<div class="member-signature"><span class="return-type">@Nullable com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;</span>&nbsp;<span class="element-name">getTraitDefs</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getConvertletTable()">
<h3>getConvertletTable</h3>
<div class="member-signature"><span class="return-type"><a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a></span>&nbsp;<span class="element-name">getConvertletTable</span>()</div>
<div class="block">Returns the convertlet table that should be used when converting from SQL
to row expressions.</div>
</section>
</li>
<li>
<section class="detail" id="getContext()">
<h3>getContext</h3>
<div class="member-signature"><span class="return-type"><a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></span>&nbsp;<span class="element-name">getContext</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getTypeSystem()">
<h3>getTypeSystem</h3>
<div class="member-signature"><span class="return-type"><a href="../rel/type/RelDataTypeSystem.html" title="interface in org.apache.calcite.rel.type">RelDataTypeSystem</a></span>&nbsp;<span class="element-name">getTypeSystem</span>()</div>
<div class="block">Returns the type system.</div>
</section>
</li>
<li>
<section class="detail" id="isEvolveLattice()">
<h3>isEvolveLattice</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isEvolveLattice</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getStatisticProvider()">
<h3>getStatisticProvider</h3>
<div class="member-signature"><span class="return-type"><a href="../materialize/SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></span>&nbsp;<span class="element-name">getStatisticProvider</span>()</div>
<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>
</section>
</li>
<li>
<section class="detail" id="getViewExpander()">
<h3>getViewExpander</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></span>&nbsp;<span class="element-name">getViewExpander</span>()</div>
<div class="block">Returns a view expander.</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>