| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Programs (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, class: Programs"> |
| <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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.calcite.tools</a></div> |
| <h1 title="Class Programs" class="title">Class Programs</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.tools.Programs</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Programs</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></span></div> |
| <div class="block">Utilities for creating <a href="Program.html" title="interface in org.apache.calcite.tools"><code>Program</code></a>s.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CALC_PROGRAM" class="member-name-link">CALC_PROGRAM</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Program that converts filters and projects to <a href="../rel/core/Calc.html" title="class in org.apache.calcite.rel.core"><code>Calc</code></a>s.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final com.google.common.collect.ImmutableList<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CALC_RULES" class="member-name-link">CALC_RULES</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>static final com.google.common.collect.ImmutableSet<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#RULE_SET" class="member-name-link">RULE_SET</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SUB_QUERY_PROGRAM" class="member-name-link">SUB_QUERY_PROGRAM</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Program that expands sub-queries.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calc(org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">calc</a><wbr>(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getProgram()" class="member-name-link">getProgram</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 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-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#hep(java.lang.Iterable,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">hep</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules, |
| boolean noDag, |
| <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program that executes a list of rules in a HEP planner.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#heuristicJoinOrder(java.lang.Iterable,boolean,int)" class="member-name-link">heuristicJoinOrder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules, |
| boolean bushy, |
| int minJoinCount)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program that invokes heuristic join-order optimization |
| (via <a href="../rel/rules/JoinToMultiJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>JoinToMultiJoinRule</code></a>, |
| <a href="../rel/rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules"><code>MultiJoin</code></a> and |
| <a href="../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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listOf(java.util.List)" class="member-name-link">listOf</a><wbr>(<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><<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>> ruleSets)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a list of programs based on a list of rule sets.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listOf(org.apache.calcite.tools.RuleSet...)" class="member-name-link">listOf</a><wbr>(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>... ruleSets)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a list of programs based on an array of rule sets.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.calcite.plan.hep.HepProgram,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">of</a><wbr>(<a href="../plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a> hepProgram, |
| boolean noDag, |
| <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program that executes a <a href="../plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep"><code>HepProgram</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.calcite.tools.RuleSet)" class="member-name-link">of</a><wbr>(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a> ruleSet)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program that executes a rule set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ofRules(java.lang.Iterable)" class="member-name-link">ofRules</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program from a list of rules.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ofRules(org.apache.calcite.plan.RelOptRule...)" class="member-name-link">ofRules</a><wbr>(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>... rules)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program from a list of rules.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sequence(org.apache.calcite.tools.Program...)" class="member-name-link">sequence</a><wbr>(<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>... programs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a program that executes a sequence of programs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#standard()" class="member-name-link">standard</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the standard program used by Prepare.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#standard(org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">standard</a><wbr>(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the standard program with user metadata provider.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#subquery(org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">subquery</a><wbr>(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 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-tab1 method-summary-table-tab4"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#subQuery(org.apache.calcite.rel.metadata.RelMetadataProvider)" class="member-name-link">subQuery</a><wbr>(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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="CALC_RULES"> |
| <h3>CALC_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> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="element-name">CALC_RULES</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CALC_PROGRAM"> |
| <h3>CALC_PROGRAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">CALC_PROGRAM</span></div> |
| <div class="block">Program that converts filters and projects to <a href="../rel/core/Calc.html" title="class in org.apache.calcite.rel.core"><code>Calc</code></a>s.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SUB_QUERY_PROGRAM"> |
| <h3>SUB_QUERY_PROGRAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">SUB_QUERY_PROGRAM</span></div> |
| <div class="block">Program that expands sub-queries.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="RULE_SET"> |
| <h3>RULE_SET</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">com.google.common.collect.ImmutableSet<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="element-name">RULE_SET</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="of(org.apache.calcite.tools.RuleSet)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a> ruleSet)</span></div> |
| <div class="block">Creates a program that executes a rule set.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listOf(org.apache.calcite.tools.RuleSet...)"> |
| <h3>listOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></span> <span class="element-name">listOf</span><wbr><span class="parameters">(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>... ruleSets)</span></div> |
| <div class="block">Creates a list of programs based on an array of rule sets.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listOf(java.util.List)"> |
| <h3>listOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></span> <span class="element-name">listOf</span><wbr><span class="parameters">(<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><<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>> ruleSets)</span></div> |
| <div class="block">Creates a list of programs based on a list of rule sets.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ofRules(org.apache.calcite.plan.RelOptRule...)"> |
| <h3>ofRules</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">ofRules</span><wbr><span class="parameters">(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>... rules)</span></div> |
| <div class="block">Creates a program from a list of rules.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ofRules(java.lang.Iterable)"> |
| <h3>ofRules</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">ofRules</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules)</span></div> |
| <div class="block">Creates a program from a list of rules.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sequence(org.apache.calcite.tools.Program...)"> |
| <h3>sequence</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">sequence</span><wbr><span class="parameters">(<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>... programs)</span></div> |
| <div class="block">Creates a program that executes a sequence of programs.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hep(java.lang.Iterable,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>hep</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">hep</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules, |
| boolean noDag, |
| <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| <div class="block">Creates a program that executes a list of rules in a HEP planner.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="of(org.apache.calcite.plan.hep.HepProgram,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a> hepProgram, |
| boolean noDag, |
| <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| <div class="block">Creates a program that executes a <a href="../plan/hep/HepProgram.html" title="class in org.apache.calcite.plan.hep"><code>HepProgram</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="heuristicJoinOrder(java.lang.Iterable,boolean,int)"> |
| <h3>heuristicJoinOrder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">heuristicJoinOrder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules, |
| boolean bushy, |
| int minJoinCount)</span></div> |
| <div class="block">Creates a program that invokes heuristic join-order optimization |
| (via <a href="../rel/rules/JoinToMultiJoinRule.html" title="class in org.apache.calcite.rel.rules"><code>JoinToMultiJoinRule</code></a>, |
| <a href="../rel/rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules"><code>MultiJoin</code></a> and |
| <a href="../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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calc(org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>calc</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">calc</span><wbr><span class="parameters">(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="subquery(org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>subquery</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</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">subquery</span><wbr><span class="parameters">(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="subQuery(org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>subQuery</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">subQuery</span><wbr><span class="parameters">(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProgram()"> |
| <h3>getProgram</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</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">getProgram</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="standard()"> |
| <h3>standard</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">standard</span>()</div> |
| <div class="block">Returns the standard program used by Prepare.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="standard(org.apache.calcite.rel.metadata.RelMetadataProvider)"> |
| <h3>standard</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="element-name">standard</span><wbr><span class="parameters">(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| <div class="block">Returns the standard program with user metadata provider.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
