| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelBuilder.AggCall (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":6,"i10":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">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> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></dd> |
| </dl> |
| <hr> |
| <pre>public static interface <span class="typeNameLabel">RelBuilder.AggCall</span></pre> |
| <div class="block">Information necessary to create a call to an aggregate function.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><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></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Default Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#approximate(boolean)">approximate</a></span>​(boolean approximate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall that may return approximate results |
| if <code>approximate</code> is true.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#as(java.lang.String)">as</a></span>​(@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall with a given alias.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distinct()">distinct</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall that is distinct.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distinct(boolean)">distinct</a></span>​(boolean distinct)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall that is optionally distinct.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filter(org.apache.calcite.rex.RexNode)">filter</a></span>​(@Nullable <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> condition)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall that applies a filter before aggregating |
| values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ignoreNulls(boolean)">ignoreNulls</a></span>​(boolean ignoreNulls)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this AggCall that ignores nulls.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#over()">over</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this aggregate call to a windowed aggregate call.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sort(java.lang.Iterable)">sort</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> orderKeys)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sort(org.apache.calcite.rex.RexNode...)">sort</a></span>​(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... orderKeys)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unique(java.lang.Iterable)">unique</a></span>​(@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> distinctKeys)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>default <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unique(org.apache.calcite.rex.RexNode...)">unique</a></span>​(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... distinctKeys)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="filter(org.apache.calcite.rex.RexNode)">filter</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">filter</span>​(<span class="arguments">@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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="sort(java.lang.Iterable)">sort</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">sort</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="sort(org.apache.calcite.rex.RexNode...)">sort</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">sort</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="unique(java.lang.Iterable)">unique</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">unique</span>​(<span class="arguments">@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="unique(org.apache.calcite.rex.RexNode...)">unique</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">unique</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="approximate(boolean)">approximate</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">approximate</span>​(<span class="arguments">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="ignoreNulls(boolean)">ignoreNulls</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">ignoreNulls</span>​(<span class="arguments">boolean ignoreNulls)</span></div> |
| <div class="block">Returns a copy of this AggCall that ignores nulls.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="as(java.lang.String)">as</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">as</span>​(<span class="arguments">@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</span></div> |
| <div class="block">Returns a copy of this AggCall with a given alias.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="distinct(boolean)">distinct</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">distinct</span>​(<span class="arguments">boolean distinct)</span></div> |
| <div class="block">Returns a copy of this AggCall that is optionally distinct.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="distinct()">distinct</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools">RelBuilder.AggCall</a></span> <span class="memberName">distinct</span>()</div> |
| <div class="block">Returns a copy of this AggCall that is distinct.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="over()">over</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="memberName">over</span>()</div> |
| <div class="block">Converts this aggregate call to a windowed aggregate call.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |