| <!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>FunctionalIndexHelper (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="FunctionalIndexHelper (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/FunctionalIndexHelper.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/FindFiltersForCollation.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/FunctionalIndexHelper.html" target="_top">Frames</a></li> |
| <li><a href="FunctionalIndexHelper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 FunctionalIndexHelper" class="title">Class FunctionalIndexHelper</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.FunctionalIndexHelper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">FunctionalIndexHelper</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"> |
| <!-- ======== 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"> </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/FunctionalIndexHelper.html#FunctionalIndexHelper--">FunctionalIndexHelper</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static org.apache.calcite.rex.RexNode</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexHelper.html#convertConditionForIndexScan-org.apache.calcite.rex.RexNode-org.apache.calcite.rel.RelNode-org.apache.calcite.rel.type.RelDataType-org.apache.calcite.rex.RexBuilder-org.apache.drill.exec.planner.index.FunctionalIndexInfo-">convertConditionForIndexScan</a></span>(org.apache.calcite.rex.RexNode idxCondition, |
| org.apache.calcite.rel.RelNode origScan, |
| org.apache.calcite.rel.type.RelDataType idxRowType, |
| org.apache.calcite.rex.RexBuilder builder, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.calcite.rel.type.RelDataType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexHelper.html#convertRowTypeForIndexScan-org.apache.drill.exec.planner.common.DrillScanRelBase-org.apache.drill.exec.planner.index.IndexableExprMarker-org.apache.drill.exec.physical.base.IndexGroupScan-org.apache.drill.exec.planner.index.FunctionalIndexInfo-">convertRowTypeForIndexScan</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/common/DrillScanRelBase.html" title="class in org.apache.drill.exec.planner.common">DrillScanRelBase</a> origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexableExprMarker.html" title="class in org.apache.drill.exec.planner.index">IndexableExprMarker</a> idxMarker, |
| <a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a> idxScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</code> |
| <div class="block">For IndexScan in non-covering case, rowType to return contains only row_key('_id') of primary table.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static org.apache.calcite.rel.type.RelDataType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexHelper.html#rewriteFunctionalRowType-org.apache.calcite.rel.RelNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.FunctionalIndexInfo-">rewriteFunctionalRowType</a></span>(org.apache.calcite.rel.RelNode origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a> indexContext, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.calcite.rel.type.RelDataType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexHelper.html#rewriteFunctionalRowType-org.apache.calcite.rel.RelNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.FunctionalIndexInfo-java.util.Collection-">rewriteFunctionalRowType</a></span>(org.apache.calcite.rel.RelNode origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a> indexContext, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>> addedPaths)</code> |
| <div class="block">if a field in rowType serves only the to-be-replaced column(s), we should replace it with new name "$1", |
| otherwise we should keep this dataTypeField and add a new one for "$1"</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 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="FunctionalIndexHelper--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FunctionalIndexHelper</h4> |
| <pre>public FunctionalIndexHelper()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="rewriteFunctionalRowType-org.apache.calcite.rel.RelNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.FunctionalIndexInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewriteFunctionalRowType</h4> |
| <pre>public static org.apache.calcite.rel.type.RelDataType rewriteFunctionalRowType(org.apache.calcite.rel.RelNode origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a> indexContext, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</pre> |
| </li> |
| </ul> |
| <a name="rewriteFunctionalRowType-org.apache.calcite.rel.RelNode-org.apache.drill.exec.planner.index.IndexCallContext-org.apache.drill.exec.planner.index.FunctionalIndexInfo-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewriteFunctionalRowType</h4> |
| <pre>public static org.apache.calcite.rel.type.RelDataType rewriteFunctionalRowType(org.apache.calcite.rel.RelNode origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexCallContext.html" title="interface in org.apache.drill.exec.planner.index">IndexCallContext</a> indexContext, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>> addedPaths)</pre> |
| <div class="block">if a field in rowType serves only the to-be-replaced column(s), we should replace it with new name "$1", |
| otherwise we should keep this dataTypeField and add a new one for "$1"</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>origScan</code> - the original scan whose rowtype is to be rewritten</dd> |
| <dd><code>indexContext</code> - the index plan context</dd> |
| <dd><code>functionInfo</code> - functional index information that may impact rewrite</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertRowTypeForIndexScan-org.apache.drill.exec.planner.common.DrillScanRelBase-org.apache.drill.exec.planner.index.IndexableExprMarker-org.apache.drill.exec.physical.base.IndexGroupScan-org.apache.drill.exec.planner.index.FunctionalIndexInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertRowTypeForIndexScan</h4> |
| <pre>public static org.apache.calcite.rel.type.RelDataType convertRowTypeForIndexScan(<a href="../../../../../../org/apache/drill/exec/planner/common/DrillScanRelBase.html" title="class in org.apache.drill.exec.planner.common">DrillScanRelBase</a> origScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/IndexableExprMarker.html" title="class in org.apache.drill.exec.planner.index">IndexableExprMarker</a> idxMarker, |
| <a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a> idxScan, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</pre> |
| <div class="block">For IndexScan in non-covering case, rowType to return contains only row_key('_id') of primary table. |
| so the rowType for IndexScan should be converted from [Primary_table.row_key, primary_table.indexed_col] |
| to [indexTable.row_key(primary_table.indexed_col), indexTable.<primary_key.row_key> (Primary_table.row_key)] |
| This will impact the columns of scan, the rowType of ScanRel</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>origScan</code> - </dd> |
| <dd><code>idxMarker</code> - the IndexableExprMarker that has analyzed original index condition on top of index scan</dd> |
| <dd><code>idxScan</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertConditionForIndexScan-org.apache.calcite.rex.RexNode-org.apache.calcite.rel.RelNode-org.apache.calcite.rel.type.RelDataType-org.apache.calcite.rex.RexBuilder-org.apache.drill.exec.planner.index.FunctionalIndexInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertConditionForIndexScan</h4> |
| <pre>public static org.apache.calcite.rex.RexNode convertConditionForIndexScan(org.apache.calcite.rex.RexNode idxCondition, |
| org.apache.calcite.rel.RelNode origScan, |
| org.apache.calcite.rel.type.RelDataType idxRowType, |
| org.apache.calcite.rex.RexBuilder builder, |
| <a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index">FunctionalIndexInfo</a> functionInfo)</pre> |
| </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/FunctionalIndexHelper.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/FindFiltersForCollation.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/planner/index/FunctionalIndexInfo.html" title="interface in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/FunctionalIndexHelper.html" target="_top">Frames</a></li> |
| <li><a href="FunctionalIndexHelper.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |