| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelBuilder.AggCall (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.tools, class: RelBuilder, interface: AggCall"> |
| <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.tools</a></div> |
| <h1 title="Interface RelBuilder.AggCall" class="title">Interface RelBuilder.AggCall</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">RelBuilder.AggCall</span></div> |
| <div class="block">Information necessary to create a call to an aggregate function.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="RelBuilder.html#aggregateCall(org.apache.calcite.sql.SqlAggFunction,boolean,org.apache.calcite.rex.RexNode,java.lang.String,org.apache.calcite.rex.RexNode...)"><code>RelBuilder.aggregateCall(org.apache.calcite.sql.SqlAggFunction, boolean, org.apache.calcite.rex.RexNode, java.lang.String, org.apache.calcite.rex.RexNode...)</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-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#approximate(boolean)" class="member-name-link">approximate</a><wbr>(boolean approximate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a copy of this AggCall that may return approximate results |
| if <code>approximate</code> is true.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#as(java.lang.String)" class="member-name-link">as</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alias)</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 copy of this AggCall with a given alias.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#distinct()" class="member-name-link">distinct</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 a copy of this AggCall that is distinct.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#distinct(boolean)" class="member-name-link">distinct</a><wbr>(boolean distinct)</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 copy of this AggCall that is optionally distinct.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#filter(org.apache.calcite.rex.RexNode)" class="member-name-link">filter</a><wbr>(@Nullable <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> condition)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a copy of this AggCall that applies a filter before aggregating |
| values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ignoreNulls(boolean)" class="member-name-link">ignoreNulls</a><wbr>(boolean ignoreNulls)</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 copy of this AggCall that ignores nulls.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#over()" class="member-name-link">over</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts this aggregate call to a windowed aggregate call.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sort(java.lang.Iterable)" class="member-name-link">sort</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> orderKeys)</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 copy of this AggCall that sorts its input values by |
| <code>orderKeys</code> before aggregating, as in SQL's <code>WITHIN GROUP</code> |
| clause.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#sort(org.apache.calcite.rex.RexNode...)" class="member-name-link">sort</a><wbr>(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... orderKeys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns a copy of this AggCall that sorts its input values by |
| <code>orderKeys</code> before aggregating, as in SQL's <code>WITHIN GROUP</code> |
| clause.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unique(java.lang.Iterable)" class="member-name-link">unique</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> distinctKeys)</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 copy of this AggCall that makes its input values unique by |
| <code>distinctKeys</code> before aggregating, as in SQL's |
| <code>WITHIN DISTINCT</code> clause.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#unique(org.apache.calcite.rex.RexNode...)" class="member-name-link">unique</a><wbr>(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... distinctKeys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns a copy of this AggCall that makes its input values unique by |
| <code>distinctKeys</code> before aggregating, as in SQL's |
| <code>WITHIN DISTINCT</code> clause.</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="filter(org.apache.calcite.rex.RexNode)"> |
| <h3>filter</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">filter</span><wbr><span class="parameters">(@Nullable <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> condition)</span></div> |
| <div class="block">Returns a copy of this AggCall that applies a filter before aggregating |
| values.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sort(java.lang.Iterable)"> |
| <h3>sort</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">sort</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> orderKeys)</span></div> |
| <div class="block">Returns a copy of this AggCall that sorts its input values by |
| <code>orderKeys</code> before aggregating, as in SQL's <code>WITHIN GROUP</code> |
| clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sort(org.apache.calcite.rex.RexNode...)"> |
| <h3>sort</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">sort</span><wbr><span class="parameters">(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... orderKeys)</span></div> |
| <div class="block">Returns a copy of this AggCall that sorts its input values by |
| <code>orderKeys</code> before aggregating, as in SQL's <code>WITHIN GROUP</code> |
| clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unique(java.lang.Iterable)"> |
| <h3>unique</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">unique</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> distinctKeys)</span></div> |
| <div class="block">Returns a copy of this AggCall that makes its input values unique by |
| <code>distinctKeys</code> before aggregating, as in SQL's |
| <code>WITHIN DISTINCT</code> clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unique(org.apache.calcite.rex.RexNode...)"> |
| <h3>unique</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">unique</span><wbr><span class="parameters">(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... distinctKeys)</span></div> |
| <div class="block">Returns a copy of this AggCall that makes its input values unique by |
| <code>distinctKeys</code> before aggregating, as in SQL's |
| <code>WITHIN DISTINCT</code> clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="approximate(boolean)"> |
| <h3>approximate</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">approximate</span><wbr><span class="parameters">(boolean approximate)</span></div> |
| <div class="block">Returns a copy of this AggCall that may return approximate results |
| if <code>approximate</code> is true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ignoreNulls(boolean)"> |
| <h3>ignoreNulls</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">ignoreNulls</span><wbr><span class="parameters">(boolean ignoreNulls)</span></div> |
| <div class="block">Returns a copy of this AggCall that ignores nulls.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="as(java.lang.String)"> |
| <h3>as</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">as</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alias)</span></div> |
| <div class="block">Returns a copy of this AggCall with a given alias.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="distinct(boolean)"> |
| <h3>distinct</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">distinct</span><wbr><span class="parameters">(boolean distinct)</span></div> |
| <div class="block">Returns a copy of this AggCall that is optionally distinct.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="distinct()"> |
| <h3>distinct</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="element-name">distinct</span>()</div> |
| <div class="block">Returns a copy of this AggCall that is distinct.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="over()"> |
| <h3>over</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">over</span>()</div> |
| <div class="block">Converts this aggregate call to a windowed aggregate call.</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> |
