| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelBuilder.OverCall (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: OverCall"> |
| <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.OverCall" class="title">Interface RelBuilder.OverCall</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.OverCall</span></div> |
| <div class="block">Call to a windowed aggregate function. |
| |
| <p>To create an <code>OverCall</code>, start with an <a href="RelBuilder.AggCall.html" title="interface in org.apache.calcite.tools"><code>RelBuilder.AggCall</code></a> (created |
| by a method such as <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>, <a href="RelBuilder.html#sum(org.apache.calcite.rex.RexNode)"><code>RelBuilder.sum(org.apache.calcite.rex.RexNode)</code></a> or <a href="RelBuilder.html#count(org.apache.calcite.rex.RexNode...)"><code>RelBuilder.count(org.apache.calcite.rex.RexNode...)</code></a>) |
| and call its <a href="RelBuilder.AggCall.html#over()"><code>RelBuilder.AggCall.over()</code></a> method. For example, |
| |
| <pre><code> |
| b.scan("EMP") |
| .project(b.field("DEPTNO"), |
| b.aggregateCall(SqlStdOperatorTable.ROW_NUMBER) |
| .over() |
| .partitionBy() |
| .orderBy(b.field("EMPNO")) |
| .rowsUnbounded() |
| .allowPartial(true) |
| .nullWhenCountZero(false) |
| .as("x")) |
| </code></pre> |
| |
| <p>Unlike an aggregate call, a windowed aggregate call is an expression |
| that you can use in a <a href="../rel/core/Project.html" title="class in org.apache.calcite.rel.core"><code>Project</code></a> or <a href="../rel/core/Filter.html" title="class in org.apache.calcite.rel.core"><code>Filter</code></a>. So, to finish, |
| call <a href="#toRex()"><code>toRex()</code></a> to convert the <code>OverCall</code> to a |
| <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a>; the <a href="#as(java.lang.String)"><code>as(java.lang.String)</code></a> method (used in the above example) |
| does the same but also assigns an column alias.</div> |
| </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.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="#allowPartial(boolean)" class="member-name-link">allowPartial</a><wbr>(boolean allowPartial)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets whether to allow partial width windows; default true.</div> |
| </div> |
| <div class="col-first odd-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 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>(<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">Sets the alias of this expression, and converts it to a <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a>; |
| default is the alias that was set via <a href="RelBuilder.AggCall.html#as(java.lang.String)"><code>RelBuilder.AggCall.as(String)</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <R> R</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#let(java.util.function.Function)" class="member-name-link">let</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a>,<wbr>R> consumer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Performs an action on this OverCall.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nullWhenCountZero(boolean)" class="member-name-link">nullWhenCountZero</a><wbr>(boolean nullWhenCountZero)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets whether the aggregate function should evaluate to null if no rows |
| are in the window; default false.</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="#orderBy(java.lang.Iterable)" class="member-name-link">orderBy</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><? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> expressions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the ORDER BY BY clause to a list of expressions.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#orderBy(org.apache.calcite.rex.RexNode...)" class="member-name-link">orderBy</a><wbr>(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... expressions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the ORDER BY BY clause to an array of expressions.</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="#partitionBy(java.lang.Iterable)" class="member-name-link">partitionBy</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><? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> expressions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the PARTITION BY clause to a list of expressions.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#partitionBy(org.apache.calcite.rex.RexNode...)" class="member-name-link">partitionBy</a><wbr>(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... expressions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the PARTITION BY clause to an array of expressions.</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="#rangeBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rangeBetween</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower, |
| <a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</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 RANGE window with lower and upper bounds, |
| equivalent to SQL <code>RANGE BETWEEN lower ROW AND upper</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#rangeFrom(org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rangeFrom</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets a RANGE window with a lower bound, |
| equivalent to SQL <code>RANGE BETWEEN lower AND CURRENT ROW</code>.</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.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-tab5"><code><a href="#rangeTo(org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rangeTo</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets a RANGE window with an upper bound, |
| equivalent to SQL <code>RANGE BETWEEN CURRENT ROW AND upper</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#rangeUnbounded()" class="member-name-link">rangeUnbounded</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets an unbounded RANGE window, |
| equivalent to SQL <code>RANGE BETWEEN UNBOUNDED PRECEDING AND |
| UNBOUNDED FOLLOWING</code>.</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="#rowsBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rowsBetween</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower, |
| <a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</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 RANGE window with lower and upper bounds, |
| equivalent to SQL <code>ROWS BETWEEN lower ROW AND upper</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#rowsFrom(org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rowsFrom</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets a ROWS window with a lower bound, |
| equivalent to SQL <code>ROWS BETWEEN lower AND CURRENT ROW</code>.</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.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-tab5"><code><a href="#rowsTo(org.apache.calcite.rex.RexWindowBound)" class="member-name-link">rowsTo</a><wbr>(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets a ROWS window with an upper bound, |
| equivalent to SQL <code>ROWS BETWEEN CURRENT ROW AND upper</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#rowsUnbounded()" class="member-name-link">rowsUnbounded</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets an unbounded ROWS window, |
| equivalent to SQL <code>ROWS BETWEEN UNBOUNDED PRECEDING AND |
| UNBOUNDED FOLLOWING</code>.</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="#toRex()" class="member-name-link">toRex</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 expression to a <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</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="let(java.util.function.Function)"> |
| <h3>let</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="type-parameters"><R></span> <span class="return-type">R</span> <span class="element-name">let</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a>,<wbr>R> consumer)</span></div> |
| <div class="block">Performs an action on this OverCall.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="partitionBy(org.apache.calcite.rex.RexNode...)"> |
| <h3>partitionBy</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">partitionBy</span><wbr><span class="parameters">(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... expressions)</span></div> |
| <div class="block">Sets the PARTITION BY clause to an array of expressions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="partitionBy(java.lang.Iterable)"> |
| <h3>partitionBy</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">partitionBy</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><? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> expressions)</span></div> |
| <div class="block">Sets the PARTITION BY clause to a list of expressions.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="orderBy(org.apache.calcite.rex.RexNode...)"> |
| <h3>orderBy</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">orderBy</span><wbr><span class="parameters">(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>... expressions)</span></div> |
| <div class="block">Sets the ORDER BY BY clause to an array of expressions. |
| |
| <p>Use <a href="RelBuilder.html#desc(org.apache.calcite.rex.RexNode)"><code>RelBuilder.desc(RexNode)</code></a>, <a href="RelBuilder.html#nullsFirst(org.apache.calcite.rex.RexNode)"><code>RelBuilder.nullsFirst(RexNode)</code></a>, |
| <a href="RelBuilder.html#nullsLast(org.apache.calcite.rex.RexNode)"><code>RelBuilder.nullsLast(RexNode)</code></a> to control the sort order.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="orderBy(java.lang.Iterable)"> |
| <h3>orderBy</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">orderBy</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><? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> expressions)</span></div> |
| <div class="block">Sets the ORDER BY BY clause to a list of expressions. |
| |
| <p>Use <a href="RelBuilder.html#desc(org.apache.calcite.rex.RexNode)"><code>RelBuilder.desc(RexNode)</code></a>, <a href="RelBuilder.html#nullsFirst(org.apache.calcite.rex.RexNode)"><code>RelBuilder.nullsFirst(RexNode)</code></a>, |
| <a href="RelBuilder.html#nullsLast(org.apache.calcite.rex.RexNode)"><code>RelBuilder.nullsLast(RexNode)</code></a> to control the sort order.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowsUnbounded()"> |
| <h3>rowsUnbounded</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rowsUnbounded</span>()</div> |
| <div class="block">Sets an unbounded ROWS window, |
| equivalent to SQL <code>ROWS BETWEEN UNBOUNDED PRECEDING AND |
| UNBOUNDED FOLLOWING</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowsFrom(org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rowsFrom</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rowsFrom</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower)</span></div> |
| <div class="block">Sets a ROWS window with a lower bound, |
| equivalent to SQL <code>ROWS BETWEEN lower AND CURRENT ROW</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowsTo(org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rowsTo</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rowsTo</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</span></div> |
| <div class="block">Sets a ROWS window with an upper bound, |
| equivalent to SQL <code>ROWS BETWEEN CURRENT ROW AND upper</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowsBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rowsBetween</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">rowsBetween</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower, |
| <a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</span></div> |
| <div class="block">Sets a RANGE window with lower and upper bounds, |
| equivalent to SQL <code>ROWS BETWEEN lower ROW AND upper</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rangeUnbounded()"> |
| <h3>rangeUnbounded</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rangeUnbounded</span>()</div> |
| <div class="block">Sets an unbounded RANGE window, |
| equivalent to SQL <code>RANGE BETWEEN UNBOUNDED PRECEDING AND |
| UNBOUNDED FOLLOWING</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rangeFrom(org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rangeFrom</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rangeFrom</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower)</span></div> |
| <div class="block">Sets a RANGE window with a lower bound, |
| equivalent to SQL <code>RANGE BETWEEN lower AND CURRENT ROW</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rangeTo(org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rangeTo</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span> <span class="element-name">rangeTo</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</span></div> |
| <div class="block">Sets a RANGE window with an upper bound, |
| equivalent to SQL <code>RANGE BETWEEN CURRENT ROW AND upper</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rangeBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)"> |
| <h3>rangeBetween</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">rangeBetween</span><wbr><span class="parameters">(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> lower, |
| <a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a> upper)</span></div> |
| <div class="block">Sets a RANGE window with lower and upper bounds, |
| equivalent to SQL <code>RANGE BETWEEN lower ROW AND upper</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allowPartial(boolean)"> |
| <h3>allowPartial</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">allowPartial</span><wbr><span class="parameters">(boolean allowPartial)</span></div> |
| <div class="block">Sets whether to allow partial width windows; default true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nullWhenCountZero(boolean)"> |
| <h3>nullWhenCountZero</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">nullWhenCountZero</span><wbr><span class="parameters">(boolean nullWhenCountZero)</span></div> |
| <div class="block">Sets whether the aggregate function should evaluate to null if no rows |
| are in the window; default false.</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="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">as</span><wbr><span class="parameters">(<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">Sets the alias of this expression, and converts it to a <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a>; |
| default is the alias that was set via <a href="RelBuilder.AggCall.html#as(java.lang.String)"><code>RelBuilder.AggCall.as(String)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toRex()"> |
| <h3>toRex</h3> |
| <div class="member-signature"><span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">toRex</span>()</div> |
| <div class="block">Converts this expression to a <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</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> |
