blob: 2e9878ebfa772503c1ec19643f9426d0c6b5d2a5 [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>org.apache.drill.exec.physical.impl.scan.file (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="org.apache.drill.exec.physical.impl.scan.file (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/physical/impl/scan/convert/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/framework/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/physical/impl/scan/file/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.drill.exec.physical.impl.scan.file</h1>
<div class="docSummary">
<div class="block">Handles optional file metadata columns: implicit columns and
partition columns.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a></td>
<td class="colLast">
<div class="block">The file schema negotiator adds no behavior at present, but is
created as a placeholder anticipating the need for file-specific
behavior later.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileMetadata.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileMetadata</a></td>
<td class="colLast">
<div class="block">Specify the file name and optional selection root.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileMetadataColumn.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileMetadataColumn</a></td>
<td class="colLast">
<div class="block">Represents projection column which resolved to a file metadata
(AKA "implicit") column such as "filename", "fqn", etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileMetadataColumnDefn.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileMetadataColumnDefn</a></td>
<td class="colLast">
<div class="block">Definition of a file metadata (AKA "implicit") column for this query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileMetadataColumnsParser.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileMetadataColumnsParser</a></td>
<td class="colLast">
<div class="block">Parses the implicit file metadata columns out of a project list,
and marks them for special handling by the file metadata manager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework</a></td>
<td class="colLast">
<div class="block">The file scan framework adds into the scan framework support for implicit
reading from DFS splits (a file and a block).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileReaderFactory.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileReaderFactory</a></td>
<td class="colLast">
<div class="block">Iterates over the splits for the present scan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileRowSetContext.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileRowSetContext</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileScanBuilder.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileScanBuilder</a></td>
<td class="colLast">
<div class="block">Options for a file-based scan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiatorImpl.html" title="class in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiatorImpl</a></td>
<td class="colLast">
<div class="block">Implementation of the file-level schema negotiator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/ImplicitColumnManager.html" title="class in org.apache.drill.exec.physical.impl.scan.file">ImplicitColumnManager</a></td>
<td class="colLast">
<div class="block">Manages the insertion of file metadata (AKA "implicit" and partition) columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/ImplicitColumnManager.ImplicitColumnOptions.html" title="class in org.apache.drill.exec.physical.impl.scan.file">ImplicitColumnManager.ImplicitColumnOptions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/MetadataColumn.html" title="class in org.apache.drill.exec.physical.impl.scan.file">MetadataColumn</a></td>
<td class="colLast">
<div class="block">Resolved value for a metadata column (implicit file or partition column.) Resolution
here means identifying a value for the column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/file/PartitionColumn.html" title="class in org.apache.drill.exec.physical.impl.scan.file">PartitionColumn</a></td>
<td class="colLast">
<div class="block">Represents a partition column (usually dir0, dir1, ...).</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.drill.exec.physical.impl.scan.file Description">Package org.apache.drill.exec.physical.impl.scan.file Description</h2>
<div class="block">Handles optional file metadata columns: implicit columns and
partition columns. Not all data sources are files, and so not
all support these columns</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/physical/impl/scan/convert/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/physical/impl/scan/framework/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/physical/impl/scan/file/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>