Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / sql / SqlSplittableAggFunction.html
blob: e2299085e9f5a19be44a43a98d44c3339ec258a1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SqlSplittableAggFunction (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.sql, interface: SqlSplittableAggFunction">
<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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.sql</a></div>
<h1 title="Interface SqlSplittableAggFunction" class="title">Interface SqlSplittableAggFunction</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="SqlSplittableAggFunction.AbstractSumSplitter.html" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.AbstractSumSplitter</a></code>, <code><a href="SqlSplittableAggFunction.CountSplitter.html" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.CountSplitter</a></code>, <code><a href="SqlSplittableAggFunction.SelfSplitter.html" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.SelfSplitter</a></code>, <code><a href="SqlSplittableAggFunction.Sum0Splitter.html" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.Sum0Splitter</a></code>, <code><a href="SqlSplittableAggFunction.SumSplitter.html" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.SumSplitter</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlSplittableAggFunction</span></div>
<div class="block">Aggregate function that can be split into partial aggregates.
<p>For example, <code>COUNT(x)</code> can be split into <code>COUNT(x)</code> on
subsets followed by <code>SUM</code> to combine those counts.</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 class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="SqlSplittableAggFunction.AbstractSumSplitter.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.AbstractSumSplitter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Common splitting strategy for <code>SUM</code> and <code>SUM0</code> functions.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="SqlSplittableAggFunction.CountSplitter.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.CountSplitter</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Splitting strategy for <code>COUNT</code>.</div>
</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="SqlSplittableAggFunction.Registry.html" class="type-name-link" title="interface in org.apache.calcite.sql">SqlSplittableAggFunction.Registry</a>&lt;<a href="SqlSplittableAggFunction.Registry.html" title="type parameter in SqlSplittableAggFunction.Registry">E</a>&gt;</code></div>
<div class="col-last even-row-color">
<div class="block">Collection in which one can register an element.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="SqlSplittableAggFunction.SelfSplitter.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.SelfSplitter</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Aggregate function that splits into two applications of itself.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="SqlSplittableAggFunction.Sum0Splitter.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.Sum0Splitter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Splitting strategy for <code>SUM0</code> function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="SqlSplittableAggFunction.SumSplitter.html" class="type-name-link" title="class in org.apache.calcite.sql">SqlSplittableAggFunction.SumSplitter</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Splitting strategy for <code>SUM</code> function.</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>@Nullable <a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#merge(org.apache.calcite.rel.core.AggregateCall,org.apache.calcite.rel.core.AggregateCall)" class="member-name-link">merge</a><wbr>(<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;top,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;bottom)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Merge top and bottom aggregate calls into a single aggregate call,
if they are legit to merge.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#other(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rel.core.AggregateCall)" class="member-name-link">other</a><wbr>(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;e)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Called to generate an aggregate for the other side of the join
than the side aggregate call's arguments come from.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#singleton(org.apache.calcite.rex.RexBuilder,org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.core.AggregateCall)" class="member-name-link">singleton</a><wbr>(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder,
<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Generates an expression for the value of the aggregate function when
applied to a single row.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#split(org.apache.calcite.rel.core.AggregateCall,org.apache.calcite.util.mapping.Mappings.TargetMapping)" class="member-name-link">split</a><wbr>(<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall,
<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a>&nbsp;mapping)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#topSplit(org.apache.calcite.rex.RexBuilder,org.apache.calcite.sql.SqlSplittableAggFunction.Registry,int,org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.core.AggregateCall,int,int)" class="member-name-link">topSplit</a><wbr>(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder,
<a href="SqlSplittableAggFunction.Registry.html" title="interface in org.apache.calcite.sql">SqlSplittableAggFunction.Registry</a>&lt;<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;extra,
int&nbsp;offset,
<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall,
int&nbsp;leftSubTotal,
int&nbsp;rightSubTotal)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Generates an aggregate call to merge sub-totals.</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="split(org.apache.calcite.rel.core.AggregateCall,org.apache.calcite.util.mapping.Mappings.TargetMapping)">
<h3>split</h3>
<div class="member-signature"><span class="return-type"><a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></span>&nbsp;<span class="element-name">split</span><wbr><span class="parameters">(<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall,
<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a>&nbsp;mapping)</span></div>
</section>
</li>
<li>
<section class="detail" id="other(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rel.core.AggregateCall)">
<h3>other</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></span>&nbsp;<span class="element-name">other</span><wbr><span class="parameters">(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;e)</span></div>
<div class="block">Called to generate an aggregate for the other side of the join
than the side aggregate call's arguments come from. Returns null if
no aggregate is required.</div>
</section>
</li>
<li>
<section class="detail" id="topSplit(org.apache.calcite.rex.RexBuilder,org.apache.calcite.sql.SqlSplittableAggFunction.Registry,int,org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.core.AggregateCall,int,int)">
<h3>topSplit</h3>
<div class="member-signature"><span class="return-type"><a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></span>&nbsp;<span class="element-name">topSplit</span><wbr><span class="parameters">(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder,
<a href="SqlSplittableAggFunction.Registry.html" title="interface in org.apache.calcite.sql">SqlSplittableAggFunction.Registry</a>&lt;<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;extra,
int&nbsp;offset,
<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall,
int&nbsp;leftSubTotal,
int&nbsp;rightSubTotal)</span></div>
<div class="block">Generates an aggregate call to merge sub-totals.
<p>Most implementations will add a single aggregate call to
<code>aggCalls</code>, and return a <a href="../rex/RexInputRef.html" title="class in org.apache.calcite.rex"><code>RexInputRef</code></a> that points to it.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rexBuilder</code> - Rex builder</dd>
<dd><code>extra</code> - Place to define extra input expressions</dd>
<dd><code>offset</code> - Offset due to grouping columns (and indicator columns if
applicable)</dd>
<dd><code>inputRowType</code> - Input row type</dd>
<dd><code>aggregateCall</code> - Source aggregate call</dd>
<dd><code>leftSubTotal</code> - Ordinal of the sub-total coming from the left side of
the join, or -1 if there is no such sub-total</dd>
<dd><code>rightSubTotal</code> - Ordinal of the sub-total coming from the right side
of the join, or -1 if there is no such sub-total</dd>
<dt>Returns:</dt>
<dd>Aggregate call</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="singleton(org.apache.calcite.rex.RexBuilder,org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.core.AggregateCall)">
<h3>singleton</h3>
<div class="member-signature"><span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span>&nbsp;<span class="element-name">singleton</span><wbr><span class="parameters">(<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;rexBuilder,
<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;aggregateCall)</span></div>
<div class="block">Generates an expression for the value of the aggregate function when
applied to a single row.
<p>For example, if there is one row:
<ul>
<li><code>SUM(x)</code> is <code>x</code>
<li><code>MIN(x)</code> is <code>x</code>
<li><code>MAX(x)</code> is <code>x</code>
<li><code>COUNT(x)</code> is <code>CASE WHEN x IS NOT NULL THEN 1 ELSE 0 END 1</code>
which can be simplified to <code>1</code> if <code>x</code> is never null
<li><code>COUNT(*)</code> is 1
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rexBuilder</code> - Rex builder</dd>
<dd><code>inputRowType</code> - Input row type</dd>
<dd><code>aggregateCall</code> - Aggregate call</dd>
<dt>Returns:</dt>
<dd>Expression for single row</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="merge(org.apache.calcite.rel.core.AggregateCall,org.apache.calcite.rel.core.AggregateCall)">
<h3>merge</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></span>&nbsp;<span class="element-name">merge</span><wbr><span class="parameters">(<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;top,
<a href="../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;bottom)</span></div>
<div class="block">Merge top and bottom aggregate calls into a single aggregate call,
if they are legit to merge.
<p>SUM of SUM becomes SUM; SUM of COUNT becomes COUNT;
MAX of MAX becomes MAX; MIN of MIN becomes MIN.
AVG of AVG would not match, nor would COUNT of COUNT.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>top</code> - top aggregate call</dd>
<dd><code>bottom</code> - bottom aggregate call</dd>
<dt>Returns:</dt>
<dd>Merged aggregate call, null if fails to merge aggregate calls</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>