| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlToRelConverter.Config (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.sql2rel, class: SqlToRelConverter, interface: Config"> |
| <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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </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.sql2rel</a></div> |
| <h1 title="Interface SqlToRelConverter.Config" class="title">Interface SqlToRelConverter.Config</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Immutable(singleton=false) |
| </span><span class="modifiers">public static interface </span><span class="element-name type-name-label">SqlToRelConverter.Config</span></div> |
| <div class="block">Interface to define the configuration for a SqlToRelConverter. |
| Provides methods to set each configuration option.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="SqlToRelConverter.html#CONFIG"><code>SqlToRelConverter.CONFIG</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#addRelBuilderConfigTransform(java.util.function.UnaryOperator)" class="member-name-link">addRelBuilderConfigTransform</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>> transform)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Adds a transform to <a href="#getRelBuilderConfigTransform()"><code>getRelBuilderConfigTransform()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHintStrategyTable()" class="member-name-link">getHintStrategyTable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the hint strategies used to decide how the hints are propagated to |
| the relational expressions.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getInSubQueryThreshold()" class="member-name-link">getInSubQueryThreshold</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>inSubQueryThreshold</code> option, |
| default <a href="SqlToRelConverter.html#DEFAULT_IN_SUB_QUERY_THRESHOLD"><code>SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRelBuilderConfigTransform()" class="member-name-link">getRelBuilderConfigTransform</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a function that takes a <a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.Config</code></a> and returns |
| another.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRelBuilderFactory()" class="member-name-link">getRelBuilderFactory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the factory to create <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a>, never null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isAddJsonTypeOperatorEnabled()" class="member-name-link">isAddJsonTypeOperatorEnabled</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Whether add <a href="../sql/fun/SqlStdOperatorTable.html#JSON_TYPE_OPERATOR"><code>SqlStdOperatorTable.JSON_TYPE_OPERATOR</code></a> for between json functions.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isCreateValuesRel()" class="member-name-link">isCreateValuesRel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>createValuesRel</code> option.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isDecorrelationEnabled()" class="member-name-link">isDecorrelationEnabled</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>decorrelationEnabled</code> option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isExpand()" class="member-name-link">isExpand</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>expand</code> option.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isExplain()" class="member-name-link">isExplain</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>explain</code> option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isRemoveSortInSubQuery()" class="member-name-link">isRemoveSortInSubQuery</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns whether to remove Sort operator for a sub-query |
| if the Sort has no offset and fetch limit attributes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isTrimUnusedFields()" class="member-name-link">isTrimUnusedFields</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the <code>trimUnusedFields</code> option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withAddJsonTypeOperatorEnabled(boolean)" class="member-name-link">withAddJsonTypeOperatorEnabled</a><wbr>(boolean addJsonTypeOperatorEnabled)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isAddJsonTypeOperatorEnabled()"><code>isAddJsonTypeOperatorEnabled()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withCreateValuesRel(boolean)" class="member-name-link">withCreateValuesRel</a><wbr>(boolean createValuesRel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isCreateValuesRel()"><code>isCreateValuesRel()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withDecorrelationEnabled(boolean)" class="member-name-link">withDecorrelationEnabled</a><wbr>(boolean decorrelationEnabled)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isDecorrelationEnabled()"><code>isDecorrelationEnabled()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withExpand(boolean)" class="member-name-link">withExpand</a><wbr>(boolean expand)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isExpand()"><code>isExpand()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withExplain(boolean)" class="member-name-link">withExplain</a><wbr>(boolean explain)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isExplain()"><code>isExplain()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withHintStrategyTable(org.apache.calcite.rel.hint.HintStrategyTable)" class="member-name-link">withHintStrategyTable</a><wbr>(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategyTable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#getHintStrategyTable()"><code>getHintStrategyTable()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withInSubQueryThreshold(int)" class="member-name-link">withInSubQueryThreshold</a><wbr>(int threshold)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#getInSubQueryThreshold()"><code>getInSubQueryThreshold()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withRelBuilderConfigTransform(java.util.function.UnaryOperator)" class="member-name-link">withRelBuilderConfigTransform</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>> transform)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#getRelBuilderConfigTransform()"><code>getRelBuilderConfigTransform()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory)" class="member-name-link">withRelBuilderFactory</a><wbr>(<a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a> factory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#getRelBuilderFactory()"><code>getRelBuilderFactory()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withRemoveSortInSubQuery(boolean)" class="member-name-link">withRemoveSortInSubQuery</a><wbr>(boolean removeSortInSubQuery)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isRemoveSortInSubQuery()"><code>isRemoveSortInSubQuery()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withTrimUnusedFields(boolean)" class="member-name-link">withTrimUnusedFields</a><wbr>(boolean trimUnusedFields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets <a href="#isTrimUnusedFields()"><code>isTrimUnusedFields()</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isDecorrelationEnabled()"> |
| <h3>isDecorrelationEnabled</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isDecorrelationEnabled</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withDecorrelationEnabled(boolean)"> |
| <h3>withDecorrelationEnabled</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withDecorrelationEnabled</span><wbr><span class="parameters">(boolean decorrelationEnabled)</span></div> |
| <div class="block">Sets <a href="#isDecorrelationEnabled()"><code>isDecorrelationEnabled()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTrimUnusedFields()"> |
| <h3>isTrimUnusedFields</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isTrimUnusedFields</span>()</div> |
| <div class="block">Returns the <code>trimUnusedFields</code> option. Controls whether to trim |
| unused fields as part of the conversion process.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTrimUnusedFields(boolean)"> |
| <h3>withTrimUnusedFields</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withTrimUnusedFields</span><wbr><span class="parameters">(boolean trimUnusedFields)</span></div> |
| <div class="block">Sets <a href="#isTrimUnusedFields()"><code>isTrimUnusedFields()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCreateValuesRel()"> |
| <h3>isCreateValuesRel</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isCreateValuesRel</span>()</div> |
| <div class="block">Returns the <code>createValuesRel</code> option. Controls whether instances |
| of <a href="../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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withCreateValuesRel(boolean)"> |
| <h3>withCreateValuesRel</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withCreateValuesRel</span><wbr><span class="parameters">(boolean createValuesRel)</span></div> |
| <div class="block">Sets <a href="#isCreateValuesRel()"><code>isCreateValuesRel()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isExplain()"> |
| <h3>isExplain</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isExplain</span>()</div> |
| <div class="block">Returns the <code>explain</code> option. Describes whether the current |
| statement is part of an EXPLAIN PLAN statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withExplain(boolean)"> |
| <h3>withExplain</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withExplain</span><wbr><span class="parameters">(boolean explain)</span></div> |
| <div class="block">Sets <a href="#isExplain()"><code>isExplain()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isExpand()"> |
| <h3>isExpand</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isExpand</span>()</div> |
| <div class="block">Returns the <code>expand</code> option. Controls whether to expand |
| sub-queries. If false (the default), each sub-query becomes a |
| <a href="../rex/RexSubQuery.html" title="class in org.apache.calcite.rex"><code>RexSubQuery</code></a>. |
| |
| <p>Setting <code>expand</code> to true is deprecated. Expansion still works, |
| but there will be less development effort in that area.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withExpand(boolean)"> |
| <h3>withExpand</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withExpand</span><wbr><span class="parameters">(boolean expand)</span></div> |
| <div class="block">Sets <a href="#isExpand()"><code>isExpand()</code></a>. |
| |
| <p>Expansion is deprecated. We recommend that you do not call this |
| method, and use the default value of <a href="#isExpand()"><code>isExpand()</code></a>, false.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInSubQueryThreshold()"> |
| <h3>getInSubQueryThreshold</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getInSubQueryThreshold</span>()</div> |
| <div class="block">Returns the <code>inSubQueryThreshold</code> option, |
| default <a href="SqlToRelConverter.html#DEFAULT_IN_SUB_QUERY_THRESHOLD"><code>SqlToRelConverter.DEFAULT_IN_SUB_QUERY_THRESHOLD</code></a>. Controls the list size |
| threshold under which <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> is used. Lists of this size |
| or greater will instead be converted to use a join against an inline |
| table (<a href="../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/en/java/javase/17/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> forces usage of OR in all |
| cases.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withInSubQueryThreshold(int)"> |
| <h3>withInSubQueryThreshold</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withInSubQueryThreshold</span><wbr><span class="parameters">(int threshold)</span></div> |
| <div class="block">Sets <a href="#getInSubQueryThreshold()"><code>getInSubQueryThreshold()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRemoveSortInSubQuery()"> |
| <h3>isRemoveSortInSubQuery</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isRemoveSortInSubQuery</span>()</div> |
| <div class="block">Returns whether to remove Sort operator for a sub-query |
| if the Sort has no offset and fetch limit attributes. |
| Because the remove does not change the semantics, |
| in many cases this is a promotion. |
| Default is true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withRemoveSortInSubQuery(boolean)"> |
| <h3>withRemoveSortInSubQuery</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withRemoveSortInSubQuery</span><wbr><span class="parameters">(boolean removeSortInSubQuery)</span></div> |
| <div class="block">Sets <a href="#isRemoveSortInSubQuery()"><code>isRemoveSortInSubQuery()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelBuilderFactory()"> |
| <h3>getRelBuilderFactory</h3> |
| <div class="member-signature"><span class="return-type"><a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></span> <span class="element-name">getRelBuilderFactory</span>()</div> |
| <div class="block">Returns the factory to create <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a>, never null. Default is |
| <a href="../rel/core/RelFactories.html#LOGICAL_BUILDER"><code>RelFactories.LOGICAL_BUILDER</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory)"> |
| <h3>withRelBuilderFactory</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withRelBuilderFactory</span><wbr><span class="parameters">(<a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a> factory)</span></div> |
| <div class="block">Sets <a href="#getRelBuilderFactory()"><code>getRelBuilderFactory()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelBuilderConfigTransform()"> |
| <h3>getRelBuilderConfigTransform</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>></span> <span class="element-name">getRelBuilderConfigTransform</span>()</div> |
| <div class="block">Returns a function that takes a <a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.Config</code></a> and returns |
| another. Default is the identity function.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withRelBuilderConfigTransform(java.util.function.UnaryOperator)"> |
| <h3>withRelBuilderConfigTransform</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withRelBuilderConfigTransform</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>> transform)</span></div> |
| <div class="block">Sets <a href="#getRelBuilderConfigTransform()"><code>getRelBuilderConfigTransform()</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#addRelBuilderConfigTransform(java.util.function.UnaryOperator)"><code>addRelBuilderConfigTransform(java.util.function.UnaryOperator<org.apache.calcite.tools.RelBuilder.Config>)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRelBuilderConfigTransform(java.util.function.UnaryOperator)"> |
| <h3>addRelBuilderConfigTransform</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">addRelBuilderConfigTransform</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="../tools/RelBuilder.Config.html" title="interface in org.apache.calcite.tools">RelBuilder.Config</a>> transform)</span></div> |
| <div class="block">Adds a transform to <a href="#getRelBuilderConfigTransform()"><code>getRelBuilderConfigTransform()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHintStrategyTable()"> |
| <h3>getHintStrategyTable</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a></span> <span class="element-name">getHintStrategyTable</span>()</div> |
| <div class="block">Returns the hint strategies used to decide how the hints are propagated to |
| the relational expressions. Default is |
| <a href="../rel/hint/HintStrategyTable.html#EMPTY"><code>HintStrategyTable.EMPTY</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withHintStrategyTable(org.apache.calcite.rel.hint.HintStrategyTable)"> |
| <h3>withHintStrategyTable</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withHintStrategyTable</span><wbr><span class="parameters">(<a href="../rel/hint/HintStrategyTable.html" title="class in org.apache.calcite.rel.hint">HintStrategyTable</a> hintStrategyTable)</span></div> |
| <div class="block">Sets <a href="#getHintStrategyTable()"><code>getHintStrategyTable()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAddJsonTypeOperatorEnabled()"> |
| <h3>isAddJsonTypeOperatorEnabled</h3> |
| <div class="member-signature"><span class="annotations">@Default |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isAddJsonTypeOperatorEnabled</span>()</div> |
| <div class="block">Whether add <a href="../sql/fun/SqlStdOperatorTable.html#JSON_TYPE_OPERATOR"><code>SqlStdOperatorTable.JSON_TYPE_OPERATOR</code></a> for between json functions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withAddJsonTypeOperatorEnabled(boolean)"> |
| <h3>withAddJsonTypeOperatorEnabled</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></span> <span class="element-name">withAddJsonTypeOperatorEnabled</span><wbr><span class="parameters">(boolean addJsonTypeOperatorEnabled)</span></div> |
| <div class="block">Sets <a href="#isAddJsonTypeOperatorEnabled()"><code>isAddJsonTypeOperatorEnabled()</code></a>.</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> |