blob: 96d4cf9277c9cf76f7f86386666eb70a76dcd8ff [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>FileSystemPartitionDescriptor (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="FileSystemPartitionDescriptor (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"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};
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/FileSystemPartitionDescriptor.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/DrillRelBuilder.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/planner/ParquetPartitionDescriptor.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html" target="_top">Frames</a></li>
<li><a href="FileSystemPartitionDescriptor.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><a href="#fields.inherited.from.class.org.apache.drill.exec.planner.AbstractPartitionDescriptor">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>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</div>
<h2 title="Class FileSystemPartitionDescriptor" class="title">Class FileSystemPartitionDescriptor</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><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">org.apache.drill.exec.planner.AbstractPartitionDescriptor</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.planner.FileSystemPartitionDescriptor</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&gt;, <a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner">PartitionDescriptor</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FileSystemPartitionDescriptor</span>
extends <a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></pre>
<div class="block">Partition descriptor for file system based tables.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.planner.AbstractPartitionDescriptor">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.drill.exec.planner.<a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></h3>
<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#locationSuperList">locationSuperList</a>, <a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#sublistsCreated">sublistsCreated</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.planner.PartitionDescriptor">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.drill.exec.planner.<a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner">PartitionDescriptor</a></h3>
<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#PARTITION_BATCH_SIZE">PARTITION_BATCH_SIZE</a></code></li>
</ul>
</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/FileSystemPartitionDescriptor.html#FileSystemPartitionDescriptor-org.apache.drill.exec.planner.physical.PlannerSettings-org.apache.calcite.rel.core.TableScan-">FileSystemPartitionDescriptor</a></span>(<a href="../../../../../org/apache/drill/exec/planner/physical/PlannerSettings.html" title="class in org.apache.drill.exec.planner.physical">PlannerSettings</a>&nbsp;settings,
org.apache.calcite.rel.core.TableScan&nbsp;scanRel)</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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#createPartitionSublists--">createPartitionSublists</a></span>()</code>
<div class="block">Create sublists of the partition locations, each sublist of size
at most <a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#PARTITION_BATCH_SIZE"><code>PartitionDescriptor.PARTITION_BATCH_SIZE</code></a></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.rel.core.TableScan</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#createTableScan-java.util.List-boolean-">createTableScan</a></span>(<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;newPartitionLocation,
boolean&nbsp;wasAllPartitionsPruned)</code>
<div class="block">Create a new TableScan rel node, given the lists of new partitions or new files to SCAN.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.calcite.rel.core.TableScan</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#createTableScan-java.util.List-org.apache.hadoop.fs.Path-boolean-org.apache.drill.exec.store.dfs.MetadataContext-">createTableScan</a></span>(<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;newPartitionLocation,
org.apache.hadoop.fs.Path&nbsp;cacheFileRoot,
boolean&nbsp;wasAllPartitionsPruned,
<a href="../../../../../org/apache/drill/exec/store/dfs/MetadataContext.html" title="class in org.apache.drill.exec.store.dfs">MetadataContext</a>&nbsp;metaContext)</code>
<div class="block">Create a new TableScan rel node, given the lists of new partitions or new files to scan and a path
to a metadata cache file</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getBaseTableLocation--">getBaseTableLocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected org.apache.commons.lang3.tuple.Pair&lt;<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>&lt;org.apache.hadoop.fs.Path&gt;,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getFileLocationsAndStatus--">getFileLocationsAndStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getIdIfValid-java.lang.String-">getIdIfValid</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Check to see if the name is a partition name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getMaxHierarchyLevel--">getMaxHierarchyLevel</a></span>()</code>
<div class="block">Maximum level of partition nesting/ hierarchy supported</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getName-int-">getName</a></span>(int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getPartitionHierarchyIndex-java.lang.String-">getPartitionHierarchyIndex</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionName)</code>
<div class="block">Get the hierarchy index of the given partition
For eg: if we have the partition laid out as follows
1997/q1/jan
then getPartitionHierarchyIndex("jan") => 2</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/planner/logical/DrillTable.html" title="class in org.apache.drill.exec.planner.logical">DrillTable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getTable--">getTable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/common/types/TypeProtos.MajorType.html" title="class in org.apache.drill.common.types">TypeProtos.MajorType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#getVectorType-org.apache.drill.common.expression.SchemaPath-org.apache.drill.exec.planner.physical.PlannerSettings-">getVectorType</a></span>(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>&nbsp;column,
<a href="../../../../../org/apache/drill/exec/planner/physical/PlannerSettings.html" title="class in org.apache.drill.exec.planner.physical">PlannerSettings</a>&nbsp;plannerSettings)</code>
<div class="block">Method returns the Major type associated with the given column</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#isPartitionName-java.lang.String-">isPartitionName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Given a column name return boolean to indicate if its a partition column or not</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#populatePartitionVectors-org.apache.drill.exec.vector.ValueVector:A-java.util.List-java.util.BitSet-java.util.Map-">populatePartitionVectors</a></span>(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>[]&nbsp;vectors,
<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;partitions,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a>&nbsp;partitionColumnBitSet,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;fieldNameMap)</code>
<div class="block">Creates an in memory representation of all the partitions.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html#supportsMetadataCachePruning--">supportsMetadataCachePruning</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.AbstractPartitionDescriptor">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.planner.<a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></h3>
<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#iterator--">iterator</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</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="FileSystemPartitionDescriptor-org.apache.drill.exec.planner.physical.PlannerSettings-org.apache.calcite.rel.core.TableScan-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FileSystemPartitionDescriptor</h4>
<pre>public&nbsp;FileSystemPartitionDescriptor(<a href="../../../../../org/apache/drill/exec/planner/physical/PlannerSettings.html" title="class in org.apache.drill.exec.planner.physical">PlannerSettings</a>&nbsp;settings,
org.apache.calcite.rel.core.TableScan&nbsp;scanRel)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPartitionHierarchyIndex-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionHierarchyIndex</h4>
<pre>public&nbsp;int&nbsp;getPartitionHierarchyIndex(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#getPartitionHierarchyIndex-java.lang.String-">PartitionDescriptor</a></code></span></div>
<div class="block">Get the hierarchy index of the given partition
For eg: if we have the partition laid out as follows
1997/q1/jan
then getPartitionHierarchyIndex("jan") => 2</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>partitionName</code> - Partition name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index of specified partition name in the hierarchy</dd>
</dl>
</li>
</ul>
<a name="isPartitionName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartitionName</h4>
<pre>public&nbsp;boolean&nbsp;isPartitionName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#isPartitionName-java.lang.String-">PartitionDescriptor</a></code></span></div>
<div class="block">Given a column name return boolean to indicate if its a partition column or not</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - of Partition</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if this is the partition name and vise versa.</dd>
</dl>
</li>
</ul>
<a name="getIdIfValid-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdIfValid</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getIdIfValid(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#getIdIfValid-java.lang.String-">PartitionDescriptor</a></code></span></div>
<div class="block">Check to see if the name is a partition name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The field name you want to compare to partition names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Return index if valid, otherwise return null;</dd>
</dl>
</li>
</ul>
<a name="getMaxHierarchyLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxHierarchyLevel</h4>
<pre>public&nbsp;int&nbsp;getMaxHierarchyLevel()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#getMaxHierarchyLevel--">PartitionDescriptor</a></code></span></div>
<div class="block">Maximum level of partition nesting/ hierarchy supported</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum supported level number of partition hierarchy</dd>
</dl>
</li>
</ul>
<a name="getTable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/planner/logical/DrillTable.html" title="class in org.apache.drill.exec.planner.logical">DrillTable</a>&nbsp;getTable()</pre>
</li>
</ul>
<a name="populatePartitionVectors-org.apache.drill.exec.vector.ValueVector:A-java.util.List-java.util.BitSet-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populatePartitionVectors</h4>
<pre>public&nbsp;void&nbsp;populatePartitionVectors(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>[]&nbsp;vectors,
<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;partitions,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a>&nbsp;partitionColumnBitSet,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;fieldNameMap)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#populatePartitionVectors-org.apache.drill.exec.vector.ValueVector:A-java.util.List-java.util.BitSet-java.util.Map-">PartitionDescriptor</a></code></span></div>
<div class="block">Creates an in memory representation of all the partitions. For each level of partitioning we
will create a value vector which this method will populate for all the partitions with the values of the
partitioning key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vectors</code> - - Array of vectors in the container that need to be populated</dd>
<dd><code>partitions</code> - - List of all the partitions that exist in the table</dd>
<dd><code>partitionColumnBitSet</code> - - Partition columns selected in the query</dd>
<dd><code>fieldNameMap</code> - - Maps field ordinal to the field name</dd>
</dl>
</li>
</ul>
<a name="getVectorType-org.apache.drill.common.expression.SchemaPath-org.apache.drill.exec.planner.physical.PlannerSettings-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVectorType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/common/types/TypeProtos.MajorType.html" title="class in org.apache.drill.common.types">TypeProtos.MajorType</a>&nbsp;getVectorType(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>&nbsp;column,
<a href="../../../../../org/apache/drill/exec/planner/physical/PlannerSettings.html" title="class in org.apache.drill.exec.planner.physical">PlannerSettings</a>&nbsp;plannerSettings)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#getVectorType-org.apache.drill.common.expression.SchemaPath-org.apache.drill.exec.planner.physical.PlannerSettings-">PartitionDescriptor</a></code></span></div>
<div class="block">Method returns the Major type associated with the given column</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - - column whose type should be determined</dd>
</dl>
</li>
</ul>
<a name="getName-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName(int&nbsp;index)</pre>
</li>
</ul>
<a name="getBaseTableLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseTableLocation</h4>
<pre>public&nbsp;org.apache.hadoop.fs.Path&nbsp;getBaseTableLocation()</pre>
</li>
</ul>
<a name="createPartitionSublists--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPartitionSublists</h4>
<pre>protected&nbsp;void&nbsp;createPartitionSublists()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#createPartitionSublists--">AbstractPartitionDescriptor</a></code></span></div>
<div class="block">Create sublists of the partition locations, each sublist of size
at most <a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#PARTITION_BATCH_SIZE"><code>PartitionDescriptor.PARTITION_BATCH_SIZE</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#createPartitionSublists--">createPartitionSublists</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></code></dd>
</dl>
</li>
</ul>
<a name="getFileLocationsAndStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileLocationsAndStatus</h4>
<pre>protected&nbsp;org.apache.commons.lang3.tuple.Pair&lt;<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>&lt;org.apache.hadoop.fs.Path&gt;,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;getFileLocationsAndStatus()</pre>
</li>
</ul>
<a name="createTableScan-java.util.List-org.apache.hadoop.fs.Path-boolean-org.apache.drill.exec.store.dfs.MetadataContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTableScan</h4>
<pre>public&nbsp;org.apache.calcite.rel.core.TableScan&nbsp;createTableScan(<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;newPartitionLocation,
org.apache.hadoop.fs.Path&nbsp;cacheFileRoot,
boolean&nbsp;wasAllPartitionsPruned,
<a href="../../../../../org/apache/drill/exec/store/dfs/MetadataContext.html" title="class in org.apache.drill.exec.store.dfs">MetadataContext</a>&nbsp;metaContext)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#createTableScan-java.util.List-org.apache.hadoop.fs.Path-boolean-org.apache.drill.exec.store.dfs.MetadataContext-">PartitionDescriptor</a></code></span></div>
<div class="block">Create a new TableScan rel node, given the lists of new partitions or new files to scan and a path
to a metadata cache file</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#createTableScan-java.util.List-org.apache.hadoop.fs.Path-boolean-org.apache.drill.exec.store.dfs.MetadataContext-">createTableScan</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner">PartitionDescriptor</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#createTableScan-java.util.List-org.apache.hadoop.fs.Path-boolean-org.apache.drill.exec.store.dfs.MetadataContext-">createTableScan</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="createTableScan-java.util.List-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTableScan</h4>
<pre>public&nbsp;org.apache.calcite.rel.core.TableScan&nbsp;createTableScan(<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/PartitionLocation.html" title="interface in org.apache.drill.exec.planner">PartitionLocation</a>&gt;&nbsp;newPartitionLocation,
boolean&nbsp;wasAllPartitionsPruned)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#createTableScan-java.util.List-boolean-">PartitionDescriptor</a></code></span></div>
<div class="block">Create a new TableScan rel node, given the lists of new partitions or new files to SCAN.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="supportsMetadataCachePruning--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>supportsMetadataCachePruning</h4>
<pre>public&nbsp;boolean&nbsp;supportsMetadataCachePruning()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html#supportsMetadataCachePruning--">supportsMetadataCachePruning</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/PartitionDescriptor.html" title="interface in org.apache.drill.exec.planner">PartitionDescriptor</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html#supportsMetadataCachePruning--">supportsMetadataCachePruning</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/drill/exec/planner/AbstractPartitionDescriptor.html" title="class in org.apache.drill.exec.planner">AbstractPartitionDescriptor</a></code></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/FileSystemPartitionDescriptor.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/DrillRelBuilder.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/planner/ParquetPartitionDescriptor.html" title="class in org.apache.drill.exec.planner"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/planner/FileSystemPartitionDescriptor.html" target="_top">Frames</a></li>
<li><a href="FileSystemPartitionDescriptor.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><a href="#fields.inherited.from.class.org.apache.drill.exec.planner.AbstractPartitionDescriptor">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>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>