blob: 13d4d43dc5aa4177e5287f345c966e1d54229b98 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Programs (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Programs (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":41,"i14":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/tools/Programs.html" target="_top">Frames</a></li>
<li><a href="Programs.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.tools</div>
<h2 title="Class Programs" class="title">Class Programs</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.tools.Programs</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Programs</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utilities for creating <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools"><code>Program</code></a>s.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#CALC_PROGRAM">CALC_PROGRAM</a></span></code>
<div class="block">Program that converts filters and projects to <a href="../../../../org/apache/calcite/rel/core/Calc.html" title="class in org.apache.calcite.rel.core"><code>Calc</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.common.collect.ImmutableList&lt;<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#CALC_RULES">CALC_RULES</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.common.collect.ImmutableSet&lt;<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#RULE_SET">RULE_SET</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#SUB_QUERY_PROGRAM">SUB_QUERY_PROGRAM</a></span></code>
<div class="block">Program that expands sub-queries.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#calc-org.apache.calcite.rel.metadata.RelMetadataProvider-">calc</a></span>(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#getProgram--">getProgram</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#hep-java.lang.Iterable-boolean-org.apache.calcite.rel.metadata.RelMetadataProvider-">hep</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;noDag,
<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>
<div class="block">Creates a program that executes a list of rules in a HEP planner.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#heuristicJoinOrder-java.lang.Iterable-boolean-int-">heuristicJoinOrder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;bushy,
int&nbsp;minJoinCount)</code>
<div class="block">Creates a program that invokes heuristic join-order optimization
(via <a href="../../../../org/apache/calcite/rel/rules/JoinToMultiJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>JoinToMultiJoinRule</code></a>,
<a href="../../../../org/apache/calcite/rel/rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules"><code>MultiJoin</code></a> and
<a href="../../../../org/apache/calcite/rel/rules/LoptOptimizeJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>LoptOptimizeJoinRule</code></a>)
if there are 6 or more joins (7 or more relations).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#listOf-java.util.List-">listOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>&gt;&nbsp;ruleSets)</code>
<div class="block">Creates a list of programs based on a list of rule sets.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#listOf-org.apache.calcite.tools.RuleSet...-">listOf</a></span>(<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>...&nbsp;ruleSets)</code>
<div class="block">Creates a list of programs based on an array of rule sets.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#of-org.apache.calcite.plan.hep.HepProgram-boolean-org.apache.calcite.rel.metadata.RelMetadataProvider-">of</a></span>(<a href="../../../../org/apache/calcite/plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;hepProgram,
boolean&nbsp;noDag,
<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>
<div class="block">Creates a program that executes a <a href="../../../../org/apache/calcite/plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep"><code>HepProgram</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#of-org.apache.calcite.tools.RuleSet-">of</a></span>(<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>&nbsp;ruleSet)</code>
<div class="block">Creates a program that executes a rule set.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#ofRules-java.lang.Iterable-">ofRules</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules)</code>
<div class="block">Creates a program from a list of rules.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#ofRules-org.apache.calcite.plan.RelOptRule...-">ofRules</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>...&nbsp;rules)</code>
<div class="block">Creates a program from a list of rules.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#sequence-org.apache.calcite.tools.Program...-">sequence</a></span>(<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>...&nbsp;programs)</code>
<div class="block">Creates a program that executes a sequence of programs.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#standard--">standard</a></span>()</code>
<div class="block">Returns the standard program used by Prepare.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#standard-org.apache.calcite.rel.metadata.RelMetadataProvider-">standard</a></span>(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>
<div class="block">Returns the standard program with user metadata provider.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#subquery-org.apache.calcite.rel.metadata.RelMetadataProvider-">subquery</a></span>(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/tools/Programs.html#subQuery-org.apache.calcite.rel.metadata.RelMetadataProvider-">subQuery</a></span>(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CALC_RULES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CALC_RULES</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static final&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt; CALC_RULES</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="CALC_PROGRAM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CALC_PROGRAM</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a> CALC_PROGRAM</pre>
<div class="block">Program that converts filters and projects to <a href="../../../../org/apache/calcite/rel/core/Calc.html" title="class in org.apache.calcite.rel.core"><code>Calc</code></a>s.</div>
</li>
</ul>
<a name="SUB_QUERY_PROGRAM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUB_QUERY_PROGRAM</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a> SUB_QUERY_PROGRAM</pre>
<div class="block">Program that expands sub-queries.</div>
</li>
</ul>
<a name="RULE_SET">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RULE_SET</h4>
<pre>public static final&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt; RULE_SET</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="of-org.apache.calcite.tools.RuleSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;of(<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>&nbsp;ruleSet)</pre>
<div class="block">Creates a program that executes a rule set.</div>
</li>
</ul>
<a name="listOf-org.apache.calcite.tools.RuleSet...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listOf</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;&nbsp;listOf(<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>...&nbsp;ruleSets)</pre>
<div class="block">Creates a list of programs based on an array of rule sets.</div>
</li>
</ul>
<a name="listOf-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listOf</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;&nbsp;listOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/calcite/tools/RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>&gt;&nbsp;ruleSets)</pre>
<div class="block">Creates a list of programs based on a list of rule sets.</div>
</li>
</ul>
<a name="ofRules-org.apache.calcite.plan.RelOptRule...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofRules</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;ofRules(<a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>...&nbsp;rules)</pre>
<div class="block">Creates a program from a list of rules.</div>
</li>
</ul>
<a name="ofRules-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofRules</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;ofRules(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules)</pre>
<div class="block">Creates a program from a list of rules.</div>
</li>
</ul>
<a name="sequence-org.apache.calcite.tools.Program...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sequence</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;sequence(<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>...&nbsp;programs)</pre>
<div class="block">Creates a program that executes a sequence of programs.</div>
</li>
</ul>
<a name="hep-java.lang.Iterable-boolean-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hep</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;hep(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;noDag,
<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
<div class="block">Creates a program that executes a list of rules in a HEP planner.</div>
</li>
</ul>
<a name="of-org.apache.calcite.plan.hep.HepProgram-boolean-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;of(<a href="../../../../org/apache/calcite/plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;hepProgram,
boolean&nbsp;noDag,
<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
<div class="block">Creates a program that executes a <a href="../../../../org/apache/calcite/plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep"><code>HepProgram</code></a>.</div>
</li>
</ul>
<a name="heuristicJoinOrder-java.lang.Iterable-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heuristicJoinOrder</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;heuristicJoinOrder(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;? extends <a href="../../../../org/apache/calcite/plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;bushy,
int&nbsp;minJoinCount)</pre>
<div class="block">Creates a program that invokes heuristic join-order optimization
(via <a href="../../../../org/apache/calcite/rel/rules/JoinToMultiJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>JoinToMultiJoinRule</code></a>,
<a href="../../../../org/apache/calcite/rel/rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules"><code>MultiJoin</code></a> and
<a href="../../../../org/apache/calcite/rel/rules/LoptOptimizeJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>LoptOptimizeJoinRule</code></a>)
if there are 6 or more joins (7 or more relations).</div>
</li>
</ul>
<a name="calc-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calc</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;calc(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
</li>
</ul>
<a name="subquery-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subquery</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;subquery(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="subQuery-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subQuery</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;subQuery(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
</li>
</ul>
<a name="getProgram--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgram</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;getProgram()</pre>
</li>
</ul>
<a name="standard--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>standard</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;standard()</pre>
<div class="block">Returns the standard program used by Prepare.</div>
</li>
</ul>
<a name="standard-org.apache.calcite.rel.metadata.RelMetadataProvider-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>standard</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&nbsp;standard(<a href="../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&nbsp;metadataProvider)</pre>
<div class="block">Returns the standard program with user metadata provider.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/tools/Program.html" title="interface in org.apache.calcite.tools"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/tools/Programs.html" target="_top">Frames</a></li>
<li><a href="Programs.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>