blob: f84a7b661b46eb4fb339f15816ee116a313fe7bc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelMdPredicates (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.rel.metadata, class: RelMdPredicates">
<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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.rel.metadata</a></div>
<h1 title="Class RelMdPredicates" class="title">Class RelMdPredicates</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.rel.metadata.RelMdPredicates</div>
</div>
<section class="description">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a>&lt;<a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a>&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RelMdPredicates</span>
extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a>&lt;<a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a>&gt;</pre>
<div class="block">Utility to infer Predicates that are applicable above a RelNode.
<p>This is currently used by
<a href="../rules/JoinPushTransitivePredicatesRule.html" title="class in org.apache.calcite.rel.rules"><code>JoinPushTransitivePredicatesRule</code></a> to
infer <em>Predicates</em> that can be inferred from one side of a Join
to the other.
<p>The PullUp Strategy is sound but not complete. Here are some of the
limitations:
<ol>
<li> For Aggregations we only PullUp predicates that only contain
Grouping Keys. This can be extended to infer predicates on Aggregation
expressions from expressions on the aggregated columns. For e.g.
<pre>
select a, max(b) from R1 where b &gt; 7
&rarr; max(b) &gt; 7 or max(b) is null
</pre>
<li> For Projections we only look at columns that are projected without
any function applied. So:
<pre>
select a from R1 where a &gt; 7
&rarr; "a &gt; 7" is pulled up from the Projection.
select a + 1 from R1 where a + 1 &gt; 7
&rarr; "a + 1 gt; 7" is not pulled up
</pre>
<li> There are several restrictions on Joins:
<ul>
<li> We only pullUp inferred predicates for now. Pulling up existing
predicates causes an explosion of duplicates. The existing predicates
are pushed back down as new predicates. Once we have rules to eliminate
duplicate Filter conditions, we should pullUp all predicates.
<li> For Left Outer: we infer new predicates from the left and set them
as applicable on the Right side. No predicates are pulledUp.
<li> Right Outer Joins are handled in an analogous manner.
<li> For Full Outer Joins no predicates are pulledUp or inferred.
</ul>
</ol></div>
</section>
<section class="summary">
<ul class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SOURCE">SOURCE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RelMdPredicates</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== 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="t4" class="tableTab" onclick="show(8);">Concrete 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="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a>&lt;<a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDef()">getDef</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../../plan/hep/HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;rel,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.plan.volcano.RelSubset,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../../plan/volcano/RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&nbsp;r,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns the
<a href="BuiltInMetadata.Predicates.html#getPredicates()"><code>BuiltInMetadata.Predicates.getPredicates()</code></a>
statistic.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Aggregate,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>&nbsp;agg,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for an Aggregate.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Exchange,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Exchange.html" title="class in org.apache.calcite.rel.core">Exchange</a>&nbsp;exchange,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for an Exchange.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Filter,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Filter.html" title="class in org.apache.calcite.rel.core">Filter</a>&nbsp;filter,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Add the Filter condition to the pulledPredicates list from the input.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Intersect,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Intersect.html" title="class in org.apache.calcite.rel.core">Intersect</a>&nbsp;intersect,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a Intersect.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Join,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Join.html" title="class in org.apache.calcite.rel.core">Join</a>&nbsp;join,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a <a href="../core/Join.html" title="class in org.apache.calcite.rel.core"><code>Join</code></a> (including
<code>SemiJoin</code>).</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Minus,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Minus.html" title="class in org.apache.calcite.rel.core">Minus</a>&nbsp;minus,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a Minus.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Project,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Project.html" title="class in org.apache.calcite.rel.core">Project</a>&nbsp;project,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a project.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Sort,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Sort.html" title="class in org.apache.calcite.rel.core">Sort</a>&nbsp;sort,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a Sort.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.TableModify,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/TableModify.html" title="class in org.apache.calcite.rel.core">TableModify</a>&nbsp;tableModify,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a TableModify.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.TableScan,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a>&nbsp;table,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a table scan.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.core.Union,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../core/Union.html" title="class in org.apache.calcite.rel.core">Union</a>&nbsp;union,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Infers predicates for a Union.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPredicates(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></span>&#8203;(<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Catch-all implementation for
<a href="BuiltInMetadata.Predicates.html#getPredicates()"><code>BuiltInMetadata.Predicates.getPredicates()</code></a>,
invoked using reflection.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<li class="blockList">
<section class="fieldDetails"><a id="field.detail">
<!-- -->
</a>
<h2>Field Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="SOURCE">SOURCE</a></h3>
<div class="memberSignature"><span class="modifiers">public static final</span>&nbsp;<span class="returnType"><a href="RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a></span>&nbsp;<span class="memberName">SOURCE</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">RelMdPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">RelMdPredicates</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ 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="getDef()">getDef</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a>&lt;<a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a>&gt;</span>&nbsp;<span class="memberName">getDef</span>()</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MetadataHandler.html#getDef()">getDef</a></code>&nbsp;in interface&nbsp;<code><a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a>&lt;<a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a>&gt;</code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Catch-all implementation for
<a href="BuiltInMetadata.Predicates.html#getPredicates()"><code>BuiltInMetadata.Predicates.getPredicates()</code></a>,
invoked using reflection.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="RelMetadataQuery.html#getPulledUpPredicates(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getPulledUpPredicates(RelNode)</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../../plan/hep/HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;rel,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.TableScan,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a>&nbsp;table,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a table scan.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Project,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Project.html" title="class in org.apache.calcite.rel.core">Project</a>&nbsp;project,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a project.
<ol>
<li>create a mapping from input to projection. Map only positions that
directly reference an input column.
<li>Expressions that only contain above columns are retained in the
Project's pullExpressions list.
<li>For e.g. expression 'a + e = 9' below will not be pulled up because 'e'
is not in the projection list.
<blockquote><pre>
inputPullUpExprs: {a &gt; 7, b + c &lt; 10, a + e = 9}
projectionExprs: {a, b, c, e / 2}
projectionPullupExprs: {a &gt; 7, b + c &lt; 10}
</pre></blockquote>
</ol></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Filter,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Filter.html" title="class in org.apache.calcite.rel.core">Filter</a>&nbsp;filter,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Add the Filter condition to the pulledPredicates list from the input.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Join,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Join.html" title="class in org.apache.calcite.rel.core">Join</a>&nbsp;join,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a <a href="../core/Join.html" title="class in org.apache.calcite.rel.core"><code>Join</code></a> (including
<code>SemiJoin</code>).</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Aggregate,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>&nbsp;agg,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for an Aggregate.
<p>Pulls up predicates that only contains references to columns in the
GroupSet. For e.g.
<blockquote><pre>
inputPullUpExprs : { a &gt; 7, b + c &lt; 10, a + e = 9}
groupSet : { a, b}
pulledUpExprs : { a &gt; 7}
</pre></blockquote></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Union,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Union.html" title="class in org.apache.calcite.rel.core">Union</a>&nbsp;union,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a Union.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Intersect,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Intersect.html" title="class in org.apache.calcite.rel.core">Intersect</a>&nbsp;intersect,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a Intersect.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Minus,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Minus.html" title="class in org.apache.calcite.rel.core">Minus</a>&nbsp;minus,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a Minus.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Sort,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Sort.html" title="class in org.apache.calcite.rel.core">Sort</a>&nbsp;sort,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a Sort.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.TableModify,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/TableModify.html" title="class in org.apache.calcite.rel.core">TableModify</a>&nbsp;tableModify,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for a TableModify.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.rel.core.Exchange,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../core/Exchange.html" title="class in org.apache.calcite.rel.core">Exchange</a>&nbsp;exchange,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Infers predicates for an Exchange.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPredicates(org.apache.calcite.plan.volcano.RelSubset,org.apache.calcite.rel.metadata.RelMetadataQuery)">getPredicates</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="memberName">getPredicates</span>&#8203;(<span class="arguments"><a href="../../plan/volcano/RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&nbsp;r,
<a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</span></div>
<div class="block">Returns the
<a href="BuiltInMetadata.Predicates.html#getPredicates()"><code>BuiltInMetadata.Predicates.getPredicates()</code></a>
statistic.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="RelMetadataQuery.html#getPulledUpPredicates(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getPulledUpPredicates(RelNode)</code></a></dd>
</dl>
</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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>