Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / planner / index / IndexDescriptor.html
blob: 0f163cc8486726c1c687d76b17777fac59bcdefe [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>IndexDescriptor (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="IndexDescriptor (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IndexDescriptor.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/IndexDefinition.IndexType.html" title="enum 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/IndexDiscover.html" title="interface 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/IndexDescriptor.html" target="_top">Frames</a></li>
<li><a href="IndexDescriptor.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>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>
<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="Interface IndexDescriptor" class="title">Interface IndexDescriptor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html" title="class in org.apache.drill.exec.planner.index">AbstractIndexDescriptor</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDescriptor.html" title="class in org.apache.drill.exec.planner.index">DrillIndexDescriptor</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/MapRDBIndexDescriptor.html" title="class in org.apache.drill.exec.planner.index">MapRDBIndexDescriptor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IndexDescriptor</span>
extends <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></pre>
<div class="block">IndexDefinition + functions to access materialized index(index table/scan, etc)</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.planner.index.IndexDefinition">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.IndexType.html" title="enum in org.apache.drill.exec.planner.index">IndexDefinition.IndexType</a></code></li>
</ul>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>org.apache.calcite.plan.RelOptCost</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">getCost</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,
org.apache.calcite.plan.RelOptPlanner&nbsp;planner,
int&nbsp;numProjectedFields,
<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a>&nbsp;primaryGroupScan)</code>
<div class="block">Get the total cost of index access (I/O, CPU) in the context of the current query</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getFunctionalInfo--">getFunctionalInfo</a></span>()</code>
<div class="block">Get the functional index information associated with this index (Functional indexes are
indexes involving expressions e.g CAST(a as INT).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getIndexGroupScan--">getIndexGroupScan</a></span>()</code>
<div class="block">Get an instance of the group scan associated with this index descriptor</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/planner/cost/PluginCost.html" title="interface in org.apache.drill.exec.planner.cost">PluginCost</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getPluginCostModel--">getPluginCostModel</a></span>()</code>
<div class="block">Get the costing factors associated with the storage/format plugin</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">getRows</a></span>(org.apache.calcite.rel.RelNode&nbsp;input,
org.apache.calcite.rex.RexNode&nbsp;indexCondition)</code>
<div class="block">Get the estimated row count for a single index condition</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#isAsyncIndex--">isAsyncIndex</a></span>()</code>
<div class="block">Whether this index is maintained synchronously (i.e primary table updates are propagated to the index
synchronously) or asynchronously with some delay.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsFullTextSearch--">supportsFullTextSearch</a></span>()</code>
<div class="block">Whether or not the index supports full-text search (to allow pushing down such filters)</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsRowCountStats--">supportsRowCountStats</a></span>()</code>
<div class="block">Whether or not the index supports getting row count statistics</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.index.IndexDefinition">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#allColumnsIndexed-java.util.Collection-">allColumnsIndexed</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getCollation--">getCollation</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getCollationMap--">getCollationMap</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexColumnOrdinal-org.apache.drill.common.expression.LogicalExpression-">getIndexColumnOrdinal</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexColumns--">getIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexName--">getIndexName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexType--">getIndexType</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getNonIndexColumns--">getNonIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getNullsOrderingDirection--">getNullsOrderingDirection</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getRowKeyColumns--">getRowKeyColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getTableName--">getTableName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#isCoveringIndex-java.util.List-">isCoveringIndex</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#someColumnsIndexed-java.util.Collection-">someColumnsIndexed</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRows</h4>
<pre>double&nbsp;getRows(org.apache.calcite.rel.RelNode&nbsp;input,
org.apache.calcite.rex.RexNode&nbsp;indexCondition)</pre>
<div class="block">Get the estimated row count for a single index condition</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - The rel node corresponding to the primary table</dd>
<dd><code>indexCondition</code> - The index condition (e.g index_col1 < 10 AND index_col2 = 'abc')</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The estimated row count</dd>
</dl>
</li>
</ul>
<a name="supportsRowCountStats--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsRowCountStats</h4>
<pre>boolean&nbsp;supportsRowCountStats()</pre>
<div class="block">Whether or not the index supports getting row count statistics</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if index supports getting row count, False otherwise</dd>
</dl>
</li>
</ul>
<a name="getIndexGroupScan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexGroupScan</h4>
<pre><a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a>&nbsp;getIndexGroupScan()</pre>
<div class="block">Get an instance of the group scan associated with this index descriptor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of group scan for this index</dd>
</dl>
</li>
</ul>
<a name="supportsFullTextSearch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsFullTextSearch</h4>
<pre>boolean&nbsp;supportsFullTextSearch()</pre>
<div class="block">Whether or not the index supports full-text search (to allow pushing down such filters)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if index supports full-text search, False otherwise</dd>
</dl>
</li>
</ul>
<a name="getFunctionalInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionalInfo</h4>
<pre><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a>&nbsp;getFunctionalInfo()</pre>
<div class="block">Get the functional index information associated with this index (Functional indexes are
indexes involving expressions e.g CAST(a as INT).</div>
</li>
</ul>
<a name="getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCost</h4>
<pre>org.apache.calcite.plan.RelOptCost&nbsp;getCost(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;indexProps,
org.apache.calcite.plan.RelOptPlanner&nbsp;planner,
int&nbsp;numProjectedFields,
<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a>&nbsp;primaryGroupScan)</pre>
<div class="block">Get the total cost of index access (I/O, CPU) in the context of the current query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexProps</code> - properties (metrics) of a single index in the context of current query</dd>
<dd><code>planner</code> - Planner instance</dd>
<dd><code>numProjectedFields</code> - Number of projected fields</dd>
<dd><code>primaryGroupScan</code> - Primary table's GroupScan instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a RelOptCost instance representing the total cost</dd>
</dl>
</li>
</ul>
<a name="getPluginCostModel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginCostModel</h4>
<pre><a href="../../../../../../org/apache/drill/exec/planner/cost/PluginCost.html" title="interface in org.apache.drill.exec.planner.cost">PluginCost</a>&nbsp;getPluginCostModel()</pre>
<div class="block">Get the costing factors associated with the storage/format plugin</div>
</li>
</ul>
<a name="isAsyncIndex--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAsyncIndex</h4>
<pre>boolean&nbsp;isAsyncIndex()</pre>
<div class="block">Whether this index is maintained synchronously (i.e primary table updates are propagated to the index
synchronously) or asynchronously with some delay. The latter is more common for distributed NoSQL databases.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the index is maintained asynchronously, False otherwise</dd>
</dl>
</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/IndexDescriptor.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/IndexDefinition.IndexType.html" title="enum 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/IndexDiscover.html" title="interface 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/IndexDescriptor.html" target="_top">Frames</a></li>
<li><a href="IndexDescriptor.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>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>
<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>