blob: 3ec747cadb9e73678919bd0c0d0b4255d3c32704 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelBuilder.OverCall (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: 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.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":6,"i9":18,"i10":18,"i11":18,"i12":6,"i13":18,"i14":18,"i15":18,"i16":6};
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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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="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>&nbsp;<a href="package-summary.html">org.apache.calcite.tools</a></div>
<h1 title="Interface RelBuilder.OverCall" class="title">Interface RelBuilder.OverCall</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.OverCall</span></pre>
<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="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.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="#allowPartial(boolean)">allowPartial</a></span>&#8203;(boolean&nbsp;allowPartial)</code></th>
<td class="colLast">
<div class="block">Sets whether to allow partial width windows; default true.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#as(java.lang.String)">as</a></span>&#8203;(<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>&nbsp;alias)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>default &lt;R&gt;&nbsp;R</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#let(java.util.function.Function)">let</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a>,&#8203;R&gt;&nbsp;consumer)</code></th>
<td class="colLast">
<div class="block">Performs an action on this OverCall.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<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="#nullWhenCountZero(boolean)">nullWhenCountZero</a></span>&#8203;(boolean&nbsp;nullWhenCountZero)</code></th>
<td class="colLast">
<div class="block">Sets whether the aggregate function should evaluate to null if no rows
are in the window; default false.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<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="#orderBy(java.lang.Iterable)">orderBy</a></span>&#8203;(<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>&lt;? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;expressions)</code></th>
<td class="colLast">
<div class="block">Sets the ORDER BY BY clause to a list of expressions.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<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="#orderBy(org.apache.calcite.rex.RexNode...)">orderBy</a></span>&#8203;(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>...&nbsp;expressions)</code></th>
<td class="colLast">
<div class="block">Sets the ORDER BY BY clause to an array of expressions.</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="#partitionBy(java.lang.Iterable)">partitionBy</a></span>&#8203;(<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>&lt;? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;expressions)</code></th>
<td class="colLast">
<div class="block">Sets the PARTITION BY clause to a list of expressions.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<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="#partitionBy(org.apache.calcite.rex.RexNode...)">partitionBy</a></span>&#8203;(<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>...&nbsp;expressions)</code></th>
<td class="colLast">
<div class="block">Sets the PARTITION BY clause to an array of expressions.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<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="#rangeBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)">rangeBetween</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower,
<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Sets a RANGE window with lower and upper bounds,
equivalent to SQL <code>RANGE BETWEEN lower ROW AND upper</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>default <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="#rangeFrom(org.apache.calcite.rex.RexWindowBound)">rangeFrom</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower)</code></th>
<td class="colLast">
<div class="block">Sets a RANGE window with a lower bound,
equivalent to SQL <code>RANGE BETWEEN lower AND CURRENT ROW</code>.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>default <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="#rangeTo(org.apache.calcite.rex.RexWindowBound)">rangeTo</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Sets a RANGE window with an upper bound,
equivalent to SQL <code>RANGE BETWEEN CURRENT ROW AND upper</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>default <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="#rangeUnbounded()">rangeUnbounded</a></span>()</code></th>
<td class="colLast">
<div class="block">Sets an unbounded RANGE window,
equivalent to SQL <code>RANGE BETWEEN UNBOUNDED PRECEDING AND
UNBOUNDED FOLLOWING</code>.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<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="#rowsBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)">rowsBetween</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower,
<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Sets a RANGE window with lower and upper bounds,
equivalent to SQL <code>ROWS BETWEEN lower ROW AND upper</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>default <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="#rowsFrom(org.apache.calcite.rex.RexWindowBound)">rowsFrom</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower)</code></th>
<td class="colLast">
<div class="block">Sets a ROWS window with a lower bound,
equivalent to SQL <code>ROWS BETWEEN lower AND CURRENT ROW</code>.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>default <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="#rowsTo(org.apache.calcite.rex.RexWindowBound)">rowsTo</a></span>&#8203;(<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;upper)</code></th>
<td class="colLast">
<div class="block">Sets a ROWS window with an upper bound,
equivalent to SQL <code>ROWS BETWEEN CURRENT ROW AND upper</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code>default <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="#rowsUnbounded()">rowsUnbounded</a></span>()</code></th>
<td class="colLast">
<div class="block">Sets an unbounded ROWS window,
equivalent to SQL <code>ROWS BETWEEN UNBOUNDED PRECEDING AND
UNBOUNDED FOLLOWING</code>.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toRex()">toRex</a></span>()</code></th>
<td class="colLast">
<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>
</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="let(java.util.function.Function)">let</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="typeParameters">&lt;R&gt;</span>&nbsp;<span class="returnType">R</span>&nbsp;<span class="memberName">let</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a>,&#8203;R&gt;&nbsp;consumer)</span></div>
<div class="block">Performs an action on this OverCall.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="partitionBy(org.apache.calcite.rex.RexNode...)">partitionBy</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">partitionBy</span>&#8203;(<span class="arguments"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>...&nbsp;expressions)</span></div>
<div class="block">Sets the PARTITION BY clause to an array of expressions.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="partitionBy(java.lang.Iterable)">partitionBy</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">partitionBy</span>&#8203;(<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>&lt;? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;expressions)</span></div>
<div class="block">Sets the PARTITION BY clause to a list of expressions.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="orderBy(org.apache.calcite.rex.RexNode...)">orderBy</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">orderBy</span>&#8203;(<span class="arguments"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>...&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="orderBy(java.lang.Iterable)">orderBy</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">orderBy</span>&#8203;(<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>&lt;? extends <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rowsUnbounded()">rowsUnbounded</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">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 class="blockList">
<section class="detail">
<h3><a id="rowsFrom(org.apache.calcite.rex.RexWindowBound)">rowsFrom</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rowsFrom</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rowsTo(org.apache.calcite.rex.RexWindowBound)">rowsTo</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rowsTo</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rowsBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)">rowsBetween</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rowsBetween</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower,
<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rangeUnbounded()">rangeUnbounded</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">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 class="blockList">
<section class="detail">
<h3><a id="rangeFrom(org.apache.calcite.rex.RexWindowBound)">rangeFrom</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rangeFrom</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rangeTo(org.apache.calcite.rex.RexWindowBound)">rangeTo</a></h3>
<div class="memberSignature"><span class="modifiers">default</span>&nbsp;<span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rangeTo</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="rangeBetween(org.apache.calcite.rex.RexWindowBound,org.apache.calcite.rex.RexWindowBound)">rangeBetween</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">rangeBetween</span>&#8203;(<span class="arguments"><a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;lower,
<a href="../rex/RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="allowPartial(boolean)">allowPartial</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">allowPartial</span>&#8203;(<span class="arguments">boolean&nbsp;allowPartial)</span></div>
<div class="block">Sets whether to allow partial width windows; default true.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="nullWhenCountZero(boolean)">nullWhenCountZero</a></h3>
<div class="memberSignature"><span class="returnType"><a href="RelBuilder.OverCall.html" title="interface in org.apache.calcite.tools">RelBuilder.OverCall</a></span>&nbsp;<span class="memberName">nullWhenCountZero</span>&#8203;(<span class="arguments">boolean&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="as(java.lang.String)">as</a></h3>
<div class="memberSignature"><span class="returnType"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span>&nbsp;<span class="memberName">as</span>&#8203;(<span class="arguments"><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>&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="toRex()">toRex</a></h3>
<div class="memberSignature"><span class="returnType"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span>&nbsp;<span class="memberName">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>
</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>