| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Programs (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":9,"i1":41,"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"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">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="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.tools.Programs</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">Programs</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <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="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CALC_PROGRAM">CALC_PROGRAM</a></span></code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static com.google.common.collect.ImmutableList<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CALC_RULES">CALC_RULES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static com.google.common.collect.ImmutableSet<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RULE_SET">RULE_SET</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SUB_QUERY_PROGRAM">SUB_QUERY_PROGRAM</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Program that expands sub-queries.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#calc(org.apache.calcite.rel.metadata.RelMetadataProvider)">calc</a></span>​(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProgram()">getProgram</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hep(java.lang.Iterable,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)">hep</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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></th> |
| <td class="colLast"> |
| <div class="block">Creates a program that executes a list of rules in a HEP planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heuristicJoinOrder(java.lang.Iterable,boolean,int)">heuristicJoinOrder</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules, |
| boolean bushy, |
| int minJoinCount)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listOf(java.util.List)">listOf</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>> ruleSets)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list of programs based on a list of rule sets.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listOf(org.apache.calcite.tools.RuleSet...)">listOf</a></span>​(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a>... ruleSets)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list of programs based on an array of rule sets.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(org.apache.calcite.plan.hep.HepProgram,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)">of</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(org.apache.calcite.tools.RuleSet)">of</a></span>​(<a href="RuleSet.html" title="interface in org.apache.calcite.tools">RuleSet</a> ruleSet)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a program that executes a rule set.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofRules(java.lang.Iterable)">ofRules</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><? extends <a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>> rules)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a program from a list of rules.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofRules(org.apache.calcite.plan.RelOptRule...)">ofRules</a></span>​(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>... rules)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a program from a list of rules.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sequence(org.apache.calcite.tools.Program...)">sequence</a></span>​(<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>... programs)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a program that executes a sequence of programs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#standard()">standard</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the standard program used by Prepare.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#standard(org.apache.calcite.rel.metadata.RelMetadataProvider)">standard</a></span>​(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the standard program with user metadata provider.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subquery(org.apache.calcite.rel.metadata.RelMetadataProvider)">subquery</a></span>​(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>static <a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subQuery(org.apache.calcite.rel.metadata.RelMetadataProvider)">subQuery</a></span>​(<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CALC_RULES">CALC_RULES</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="returnType">com.google.common.collect.ImmutableList<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="memberName">CALC_RULES</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CALC_PROGRAM">CALC_PROGRAM</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="SUB_QUERY_PROGRAM">SUB_QUERY_PROGRAM</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">SUB_QUERY_PROGRAM</span></div> |
| <div class="block">Program that expands sub-queries.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="RULE_SET">RULE_SET</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType">com.google.common.collect.ImmutableSet<<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="memberName">RULE_SET</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(org.apache.calcite.tools.RuleSet)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">of</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="listOf(org.apache.calcite.tools.RuleSet...)">listOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></span> <span class="memberName">listOf</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="listOf(java.util.List)">listOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Program.html" title="interface in org.apache.calcite.tools">Program</a>></span> <span class="memberName">listOf</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="ofRules(org.apache.calcite.plan.RelOptRule...)">ofRules</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">ofRules</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="ofRules(java.lang.Iterable)">ofRules</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">ofRules</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="sequence(org.apache.calcite.tools.Program...)">sequence</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">sequence</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="hep(java.lang.Iterable,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)">hep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">hep</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(org.apache.calcite.plan.hep.HepProgram,boolean,org.apache.calcite.rel.metadata.RelMetadataProvider)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">of</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="heuristicJoinOrder(java.lang.Iterable,boolean,int)">heuristicJoinOrder</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">heuristicJoinOrder</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="calc(org.apache.calcite.rel.metadata.RelMetadataProvider)">calc</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">calc</span>​(<span class="arguments"><a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="subquery(org.apache.calcite.rel.metadata.RelMetadataProvider)">subquery</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">subquery</span>​(<span class="arguments"><a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="subQuery(org.apache.calcite.rel.metadata.RelMetadataProvider)">subQuery</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">subQuery</span>​(<span class="arguments"><a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a> metadataProvider)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getProgram()">getProgram</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">getProgram</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="standard()">standard</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">standard</span>()</div> |
| <div class="block">Returns the standard program used by Prepare.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="standard(org.apache.calcite.rel.metadata.RelMetadataProvider)">standard</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Program.html" title="interface in org.apache.calcite.tools">Program</a></span> <span class="memberName">standard</span>​(<span class="arguments"><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> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |