blob: 5ec6e7e3b5f5381af17e52e5e2ea1958e824ff2d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.beam.sdk.extensions.sql.impl.rule (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.beam.sdk.extensions.sql.impl.rule (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/schema/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/rule/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p>@DefaultAnnotation(value=<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/NonNull.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">org.checkerframework.checker.nullness.qual.NonNull.class</a>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.extensions.sql.impl.rule</h1>
<div class="docSummary">
<div class="block"><code>RelOptRule</code> to generate
<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamRelNode</code></a>.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.JoinChecker.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rule">JoinRelOptRuleCall.JoinChecker</a></td>
<td class="colLast">
<div class="block">This is a function gets the output relation and checks if it is a legal relational node.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamAggregateProjectMergeRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamAggregateProjectMergeRule</a></td>
<td class="colLast">
<div class="block">This rule is essentially a wrapper around Calcite's <code>AggregateProjectMergeRule</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamAggregationRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamAggregationRule</a></td>
<td class="colLast">
<div class="block">Rule to detect the window/trigger settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamBasicAggregationRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamBasicAggregationRule</a></td>
<td class="colLast">
<div class="block">Aggregation rule that doesn't include projection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamCalcMergeRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamCalcMergeRule</a></td>
<td class="colLast">
<div class="block">Planner rule to merge a <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamCalcRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamCalcRel</code></a> with a <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamCalcRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamCalcRel</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamCalcRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamCalcRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>Calc</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamCalcRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamCalcRel</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamCalcSplittingRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamCalcSplittingRule</a></td>
<td class="colLast">
<div class="block">A <code>RelOptRule</code> that converts a <code>LogicalCalc</code> into a chain of <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/AbstractBeamCalcRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>AbstractBeamCalcRel</code></a> nodes via <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/CalcRelSplitter.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>CalcRelSplitter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamCoGBKJoinRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamCoGBKJoinRule</a></td>
<td class="colLast">
<div class="block">Rule to convert <code>LogicalJoin</code> node to <code>BeamCoGBKJoinRel</code> node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamEnumerableConverterRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamEnumerableConverterRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to Convert <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamRelNode</code></a> to <code>EnumerableConvention</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamIntersectRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamIntersectRule</a></td>
<td class="colLast">
<div class="block"><code>ConverterRule</code> to replace <code>Intersect</code> with <code>BeamIntersectRel</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamIOPushDownRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamIOPushDownRule</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamIOSinkRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamIOSinkRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>TableModify</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamIOSinkRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamIOSinkRel</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamJoinAssociateRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamJoinAssociateRule</a></td>
<td class="colLast">
<div class="block">This is very similar to <code>JoinAssociateRule</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamJoinPushThroughJoinRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamJoinPushThroughJoinRule</a></td>
<td class="colLast">
<div class="block">This is exactly similar to <code>JoinPushThroughJoinRule</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamMatchRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamMatchRule</a></td>
<td class="colLast">
<div class="block"><code>ConverterRule</code> to replace <code>Match</code> with <code>BeamMatchRel</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamMinusRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamMinusRule</a></td>
<td class="colLast">
<div class="block"><code>ConverterRule</code> to replace <code>Minus</code> with <code>BeamMinusRel</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamSideInputJoinRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamSideInputJoinRule</a></td>
<td class="colLast">
<div class="block">Rule to convert <code>LogicalJoin</code> node to <code>BeamSideInputJoinRel</code> node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamSideInputLookupJoinRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamSideInputLookupJoinRule</a></td>
<td class="colLast">
<div class="block">Rule to convert <code>LogicalJoin</code> node to <code>BeamSideInputLookupJoinRel</code> node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamSortRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamSortRule</a></td>
<td class="colLast">
<div class="block"><code>ConverterRule</code> to replace <code>Sort</code> with <code>BeamSortRel</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamTableFunctionScanRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamTableFunctionScanRule</a></td>
<td class="colLast">
<div class="block">This is the conveter rule that converts a Calcite <code>TableFunctionScan</code> to Beam <code>TableFunctionScanRel</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUncollectRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamUncollectRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>Uncollect</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUncollectRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule"><code>BeamUncollectRule</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUnionRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamUnionRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>Union</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUnionRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule"><code>BeamUnionRule</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUnnestRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamUnnestRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>Correlate</code> <code>Uncollect</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamUnnestRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule"><code>BeamUnnestRule</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamValuesRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamValuesRule</a></td>
<td class="colLast">
<div class="block"><code>ConverterRule</code> to replace <code>Values</code> with <code>BeamValuesRel</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamWindowRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">BeamWindowRule</a></td>
<td class="colLast">
<div class="block">A <code>ConverterRule</code> to replace <code>Window</code> with <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamWindowRel.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamWindowRel</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">JoinRelOptRuleCall</a></td>
<td class="colLast">
<div class="block">This is a class to catch the built join and check if it is a legal join before passing it to the
actual RelOptRuleCall.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/LogicalCalcMergeRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule">LogicalCalcMergeRule</a></td>
<td class="colLast">
<div class="block">Planner rule to merge a <code>LogicalCalc</code> with a <code>LogicalCalc</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.extensions.sql.impl.rule Description">Package org.apache.beam.sdk.extensions.sql.impl.rule Description</h2>
<div class="block"><code>RelOptRule</code> to generate
<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/BeamRelNode.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rel"><code>BeamRelNode</code></a>.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rel/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/schema/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/rule/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>