| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelDistribution (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.rel, interface: RelDistribution"> |
| <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><a href="#nested-class-summary">Nested</a> | </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.rel</a></div> |
| <h1 title="Interface RelDistribution" class="title">Interface RelDistribution</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a>></code>, <code><a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></code>, <code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RelDistribution</span><span class="extends-implements"> |
| extends <a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></span></div> |
| <div class="block">Description of the physical distribution of a relational expression. |
| |
| <p>TBD:</p> |
| <ul> |
| <li>Can we shorten <a href="RelDistribution.Type.html#HASH_DISTRIBUTED"><code>RelDistribution.Type.HASH_DISTRIBUTED</code></a> to HASH, etc.</li> |
| <li>Do we need <a href="RelDistributions.html" title="class in org.apache.calcite.rel"><code>RelDistributions</code></a>.DEFAULT?</li> |
| <li><a href="RelDistributionTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelDistribution,boolean)"><code>RelDistributionTraitDef.convert(org.apache.calcite.plan.RelOptPlanner, org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelDistribution, boolean)</code></a> |
| does not create specific physical operators as it does in Drill. Drill |
| will need to create rules; or we could allow "converters" to be |
| registered with the planner that are not trait-defs. |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="RelDistribution.Type.html" class="type-name-link" title="enum in org.apache.calcite.rel">RelDistribution.Type</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Type of distribution.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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></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-tab3"><code><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#apply(org.apache.calcite.util.mapping.Mappings.TargetMapping)" class="member-name-link">apply</a><wbr>(<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a> mapping)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Applies mapping to this distribution trait.</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getKeys()" class="member-name-link">getKeys</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 ordinals of the key columns.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelDistribution.Type.html" title="enum in org.apache.calcite.rel">RelDistribution.Type</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getType()" class="member-name-link">getType</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 type of distribution.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Comparable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelMultipleTrait">Methods inherited from interface org.apache.calcite.plan.<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></h3> |
| <code><a href="../plan/RelMultipleTrait.html#isTop()">isTop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelTrait">Methods inherited from interface org.apache.calcite.plan.<a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></h3> |
| <code><a href="../plan/RelTrait.html#equals(java.lang.Object)">equals</a>, <a href="../plan/RelTrait.html#getTraitDef()">getTraitDef</a>, <a href="../plan/RelTrait.html#hashCode()">hashCode</a>, <a href="../plan/RelTrait.html#isDefault()">isDefault</a>, <a href="../plan/RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../plan/RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a>, <a href="../plan/RelTrait.html#toString()">toString</a></code></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="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelDistribution.Type.html" title="enum in org.apache.calcite.rel">RelDistribution.Type</a></span> <span class="element-name">getType</span>()</div> |
| <div class="block">Returns the type of distribution.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKeys()"> |
| <h3>getKeys</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getKeys</span>()</div> |
| <div class="block">Returns the ordinals of the key columns. |
| |
| <p>Order is important for some types (RANGE); other types (HASH) consider |
| it unimportant but impose an arbitrary order; other types (BROADCAST, |
| SINGLETON) never have keys.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="apply(org.apache.calcite.util.mapping.Mappings.TargetMapping)"> |
| <h3>apply</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></span> <span class="element-name">apply</span><wbr><span class="parameters">(<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a> mapping)</span></div> |
| <div class="block">Applies mapping to this distribution trait. |
| |
| <p>Mapping can change the distribution trait only if it depends on distribution keys. |
| |
| <p>For example if relation is HASH distributed by keys [0, 1], after applying |
| a mapping (3, 2, 1, 0), the relation will have a distribution HASH(2,3) because |
| distribution keys changed their ordinals. |
| |
| <p>If mapping eliminates one of the distribution keys, the <a href="RelDistribution.Type.html#ANY"><code>RelDistribution.Type.ANY</code></a> |
| distribution will be returned. |
| |
| <p>If distribution doesn't have keys (BROADCAST or SINGLETON), method will return |
| the same distribution.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelTrait.html#apply(org.apache.calcite.util.mapping.Mappings.TargetMapping)">apply</a></code> in interface <code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>mapping</code> - Mapping</dd> |
| <dt>Returns:</dt> |
| <dd>distribution with mapping applied</dd> |
| </dl> |
| </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> |
