blob: ddcf8939ccec6b7cfc343a9e8e1e8d526812a702 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IndexSelector (Drill : 1.20.3 API)</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="IndexSelector (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexSelector.html">Use</a></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/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.DrillIndexProperties.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/IndexSelector.html" target="_top">Frames</a></li>
<li><a href="IndexSelector.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.planner.index</div>
<h2 title="Class IndexSelector" class="title">Class IndexSelector</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.planner.index.IndexSelector</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">IndexSelector</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.DrillIndexProperties.html" title="class in org.apache.drill.exec.planner.index">IndexSelector.DrillIndexProperties</a></span></code>
<div class="block">IndexProperties encapsulates the various metrics of a single index that are related to
the current query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.IndexComparator.html" title="class in org.apache.drill.exec.planner.index">IndexSelector.IndexComparator</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#IndexSelector-org.apache.drill.exec.planner.index.IndexCallContext-">IndexSelector</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a>&nbsp;indexContext)</code>
<div class="block">This constructor is to build selector for no index condition case (no filter)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#IndexSelector-org.apache.calcite.rex.RexNode-org.apache.calcite.rex.RexNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.IndexCollection-org.apache.calcite.rex.RexBuilder-double-">IndexSelector</a></span>(org.apache.calcite.rex.RexNode&nbsp;indexCondition,
org.apache.calcite.rex.RexNode&nbsp;otherRemainderCondition,
<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a>&nbsp;indexContext,
<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCollection.html" title="interface in org.apache.drill.exec.planner.index">IndexCollection</a>&nbsp;collection,
org.apache.calcite.rex.RexBuilder&nbsp;rexBuilder,
double&nbsp;totalRows)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#addIndex-org.apache.drill.exec.planner.index.IndexDescriptor-boolean-int-">addIndex</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a>&nbsp;indexDesc,
boolean&nbsp;isCovering,
int&nbsp;numProjectedFields)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#analyzePrefixMatches-org.apache.drill.exec.planner.index.IndexProperties-">analyzePrefixMatches</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;indexProps)</code>
<div class="block">This method analyzes an index's columns and starting from the first column, checks
which part of the filter condition matches that column.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#getBestIndexNoFilter--">getBestIndexNoFilter</a></span>()</code>
<div class="block">we assume all the indexes added in indexPropList are all applicable (and covering).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.html#getCandidateIndexes-org.apache.drill.exec.planner.index.IndexConditionInfo.Builder-java.util.List-java.util.List-java.util.List-">getCandidateIndexes</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexConditionInfo.Builder.html" title="class in org.apache.drill.exec.planner.index">IndexConditionInfo.Builder</a>&nbsp;infoBuilder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;coveringIndexes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;nonCoveringIndexes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;intersectIndexes)</code>
<div class="block">Run the index selection algorithm and return the top N indexes</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IndexSelector-org.apache.calcite.rex.RexNode-org.apache.calcite.rex.RexNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.IndexCollection-org.apache.calcite.rex.RexBuilder-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IndexSelector</h4>
<pre>public&nbsp;IndexSelector(org.apache.calcite.rex.RexNode&nbsp;indexCondition,
org.apache.calcite.rex.RexNode&nbsp;otherRemainderCondition,
<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a>&nbsp;indexContext,
<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCollection.html" title="interface in org.apache.drill.exec.planner.index">IndexCollection</a>&nbsp;collection,
org.apache.calcite.rex.RexBuilder&nbsp;rexBuilder,
double&nbsp;totalRows)</pre>
</li>
</ul>
<a name="IndexSelector-org.apache.drill.exec.planner.index.IndexCallContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IndexSelector</h4>
<pre>public&nbsp;IndexSelector(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a>&nbsp;indexContext)</pre>
<div class="block">This constructor is to build selector for no index condition case (no filter)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexContext</code> - </dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addIndex-org.apache.drill.exec.planner.index.IndexDescriptor-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addIndex</h4>
<pre>public&nbsp;void&nbsp;addIndex(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a>&nbsp;indexDesc,
boolean&nbsp;isCovering,
int&nbsp;numProjectedFields)</pre>
</li>
</ul>
<a name="analyzePrefixMatches-org.apache.drill.exec.planner.index.IndexProperties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>analyzePrefixMatches</h4>
<pre>public&nbsp;void&nbsp;analyzePrefixMatches(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;indexProps)</pre>
<div class="block">This method analyzes an index's columns and starting from the first column, checks
which part of the filter condition matches that column. This process continues with
subsequent columns. The goal is to identify the portion of the filter condition that
match the prefix columns. If there are additional conditions that don't match prefix
columns, that condition is set as a remainder condition.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexProps</code> - </dd>
</dl>
</li>
</ul>
<a name="getCandidateIndexes-org.apache.drill.exec.planner.index.IndexConditionInfo.Builder-java.util.List-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCandidateIndexes</h4>
<pre>public&nbsp;void&nbsp;getCandidateIndexes(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexConditionInfo.Builder.html" title="class in org.apache.drill.exec.planner.index">IndexConditionInfo.Builder</a>&nbsp;infoBuilder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;coveringIndexes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;nonCoveringIndexes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexGroup.html" title="class in org.apache.drill.exec.planner.index">IndexGroup</a>&gt;&nbsp;intersectIndexes)</pre>
<div class="block">Run the index selection algorithm and return the top N indexes</div>
</li>
</ul>
<a name="getBestIndexNoFilter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBestIndexNoFilter</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;getBestIndexNoFilter()</pre>
<div class="block">we assume all the indexes added in indexPropList are all applicable (and covering).
For now this function is used and tested only in IndexScanWithSortOnlyPrule</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexSelector.html">Use</a></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/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/index/IndexSelector.DrillIndexProperties.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/IndexSelector.html" target="_top">Frames</a></li>
<li><a href="IndexSelector.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>