| <!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>SqlToRelConverter.Config (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="SqlToRelConverter.Config (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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/sql2rel/SqlToRelConverter.Blackboard.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.ConfigBuilder.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql2rel/SqlToRelConverter.Config.html" target="_top">Frames</a></li> |
| <li><a href="SqlToRelConverter.Config.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.sql2rel</div> |
| <h2 title="Interface SqlToRelConverter.Config" class="title">Interface SqlToRelConverter.Config</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">SqlToRelConverter.Config</span></pre> |
| <div class="block">Interface to define the configuration for a SqlToRelConverter. |
| Provides methods to set each configuration option.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.ConfigBuilder.html" title="class in org.apache.calcite.sql2rel"><code>SqlToRelConverter.ConfigBuilder</code></a>, |
| <a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.html#configBuilder--"><code>SqlToRelConverter.configBuilder()</code></a></dd> |
| </dl> |
| </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"> </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/sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#DEFAULT">DEFAULT</a></span></code> |
| <div class="block">Default configuration.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/apache/calcite/rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#getHintStrategyTable--">getHintStrategyTable</a></span>()</code> |
| <div class="block">Returns the hint strategies used to decide how the hints are propagated to |
| the relational expressions.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#getInSubQueryThreshold--">getInSubQueryThreshold</a></span>()</code> |
| <div class="block">Returns the <code>inSubQueryThreshold</code> option, |
| default <a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.html#DEFAULT_IN_SUB_QUERY_THRESHOLD"><code>SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function">UnaryOperator</a><<a href="../../../../org/apache/calcite/tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#getRelBuilderConfigTransform--">getRelBuilderConfigTransform</a></span>()</code> |
| <div class="block">Returns a function that takes a <code>RelBuilder.Config</code> and returns |
| another.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#getRelBuilderFactory--">getRelBuilderFactory</a></span>()</code> |
| <div class="block">Returns the factory to create <a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a>, never null.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#isCreateValuesRel--">isCreateValuesRel</a></span>()</code> |
| <div class="block">Returns the <code>createValuesRel</code> option.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#isDecorrelationEnabled--">isDecorrelationEnabled</a></span>()</code> |
| <div class="block">Returns the <code>decorrelationEnabled</code> option.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#isExpand--">isExpand</a></span>()</code> |
| <div class="block">Returns the <code>expand</code> option.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#isExplain--">isExplain</a></span>()</code> |
| <div class="block">Returns the <code>explain</code> option.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html#isTrimUnusedFields--">isTrimUnusedFields</a></span>()</code> |
| <div class="block">Returns the <code>trimUnusedFields</code> option.</div> |
| </td> |
| </tr> |
| </table> |
| </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="DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT</h4> |
| <pre>static final <a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a> DEFAULT</pre> |
| <div class="block">Default configuration.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isDecorrelationEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDecorrelationEnabled</h4> |
| <pre>boolean isDecorrelationEnabled()</pre> |
| <div class="block">Returns the <code>decorrelationEnabled</code> option. Controls whether to |
| disable sub-query decorrelation when needed. e.g. if outer joins are not |
| supported.</div> |
| </li> |
| </ul> |
| <a name="isTrimUnusedFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTrimUnusedFields</h4> |
| <pre>boolean isTrimUnusedFields()</pre> |
| <div class="block">Returns the <code>trimUnusedFields</code> option. Controls whether to trim |
| unused fields as part of the conversion process.</div> |
| </li> |
| </ul> |
| <a name="isCreateValuesRel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCreateValuesRel</h4> |
| <pre>boolean isCreateValuesRel()</pre> |
| <div class="block">Returns the <code>createValuesRel</code> option. Controls whether instances |
| of <a href="../../../../org/apache/calcite/rel/logical/LogicalValues.html" title="class in org.apache.calcite.rel.logical"><code>LogicalValues</code></a> are generated. |
| These may not be supported by all physical implementations.</div> |
| </li> |
| </ul> |
| <a name="isExplain--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExplain</h4> |
| <pre>boolean isExplain()</pre> |
| <div class="block">Returns the <code>explain</code> option. Describes whether the current |
| statement is part of an EXPLAIN PLAN statement.</div> |
| </li> |
| </ul> |
| <a name="isExpand--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExpand</h4> |
| <pre>boolean isExpand()</pre> |
| <div class="block">Returns the <code>expand</code> option. Controls whether to expand |
| sub-queries. If false, each sub-query becomes a |
| <a href="../../../../org/apache/calcite/rex/RexSubQuery.html" title="class in org.apache.calcite.rex"><code>RexSubQuery</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getInSubQueryThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInSubQueryThreshold</h4> |
| <pre>int getInSubQueryThreshold()</pre> |
| <div class="block">Returns the <code>inSubQueryThreshold</code> option, |
| default <a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.html#DEFAULT_IN_SUB_QUERY_THRESHOLD"><code>SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD</code></a>. Controls the list size |
| threshold under which <a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.html#convertInToOr-org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard-java.util.List-org.apache.calcite.sql.SqlNodeList-org.apache.calcite.sql.fun.SqlInOperator-"><code>SqlToRelConverter.convertInToOr(org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard, java.util.List<org.apache.calcite.rex.RexNode>, org.apache.calcite.sql.SqlNodeList, org.apache.calcite.sql.fun.SqlInOperator)</code></a> is used. Lists of this size |
| or greater will instead be converted to use a join against an inline |
| table (<a href="../../../../org/apache/calcite/rel/logical/LogicalValues.html" title="class in org.apache.calcite.rel.logical"><code>LogicalValues</code></a>) rather than |
| a predicate. A threshold of 0 forces usage of an inline table in all |
| cases; a threshold of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a> forces usage of OR in all |
| cases.</div> |
| </li> |
| </ul> |
| <a name="getRelBuilderFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelBuilderFactory</h4> |
| <pre><a href="../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a> getRelBuilderFactory()</pre> |
| <div class="block">Returns the factory to create <a href="../../../../org/apache/calcite/tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a>, never null. Default is |
| <a href="../../../../org/apache/calcite/rel/core/RelFactories.html#LOGICAL_BUILDER"><code>RelFactories.LOGICAL_BUILDER</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getRelBuilderConfigTransform--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelBuilderConfigTransform</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function">UnaryOperator</a><<a href="../../../../org/apache/calcite/tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>> getRelBuilderConfigTransform()</pre> |
| <div class="block">Returns a function that takes a <code>RelBuilder.Config</code> and returns |
| another. Default is the identity function.</div> |
| </li> |
| </ul> |
| <a name="getHintStrategyTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHintStrategyTable</h4> |
| <pre><a href="../../../../org/apache/calcite/rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> getHintStrategyTable()</pre> |
| <div class="block">Returns the hint strategies used to decide how the hints are propagated to |
| the relational expressions. Default is |
| <a href="../../../../org/apache/calcite/rel/hint/HintStrategyTable.html#EMPTY"><code>HintStrategyTable.EMPTY</code></a>.</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/sql2rel/SqlToRelConverter.Blackboard.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql2rel/SqlToRelConverter.ConfigBuilder.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql2rel/SqlToRelConverter.Config.html" target="_top">Frames</a></li> |
| <li><a href="SqlToRelConverter.Config.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
