blob: 3c838b63fef42c49834940a1ffef7a5913253d04 [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>LogFormatPlugin (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="LogFormatPlugin (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/LogFormatPlugin.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/store/log/LogFormatField.html" title="class in org.apache.drill.exec.store.log"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/log/LogFormatPlugin.html" target="_top">Frames</a></li>
<li><a href="LogFormatPlugin.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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.store.log</div>
<h2 title="Class LogFormatPlugin" class="title">Class LogFormatPlugin</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/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/log/LogFormatConfig.html" title="class in org.apache.drill.exec.store.log">LogFormatConfig</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.store.log.LogFormatPlugin</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/store/dfs/FormatPlugin.html" title="interface in org.apache.drill.exec.store.dfs">FormatPlugin</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">LogFormatPlugin</span>
extends <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/log/LogFormatConfig.html" title="class in org.apache.drill.exec.store.log">LogFormatConfig</a>&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.drill.exec.store.dfs.easy.<a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.EasyFormatConfig.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin.EasyFormatConfig</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.EasyFormatConfigBuilder.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin.EasyFormatConfigBuilder</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/store/log/LogFormatPlugin.html#MAX_ERRORS_PROP">MAX_ERRORS_PROP</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/store/log/LogFormatPlugin.html#OPERATOR_TYPE">OPERATOR_TYPE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/store/log/LogFormatPlugin.html#PLUGIN_NAME">PLUGIN_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/store/log/LogFormatPlugin.html#PROP_PREFIX">PROP_PREFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/store/log/LogFormatPlugin.html#REGEX_PROP">REGEX_PROP</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.drill.exec.store.dfs.easy.<a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#formatConfig">formatConfig</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/store/log/LogFormatPlugin.html#LogFormatPlugin-java.lang.String-org.apache.drill.exec.server.DrillbitContext-org.apache.hadoop.conf.Configuration-org.apache.drill.common.logical.StoragePluginConfig-org.apache.drill.exec.store.log.LogFormatConfig-">LogFormatPlugin</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,
<a href="../../../../../../org/apache/drill/exec/server/DrillbitContext.html" title="class in org.apache.drill.exec.server">DrillbitContext</a>&nbsp;context,
org.apache.hadoop.conf.Configuration&nbsp;fsConf,
<a href="../../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>&nbsp;storageConfig,
<a href="../../../../../../org/apache/drill/exec/store/log/LogFormatConfig.html" title="class in org.apache.drill.exec.store.log">LogFormatConfig</a>&nbsp;formatConfig)</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 <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/log/LogFormatPlugin.html#frameworkBuilder-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.store.dfs.easy.EasySubScan-">frameworkBuilder</a></span>(<a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a>&nbsp;options,
<a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasySubScan.html" title="class in org.apache.drill.exec.store.dfs.easy">EasySubScan</a>&nbsp;scan)</code>
<div class="block">Build a file scan framework for this plugin.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/log/LogFormatPlugin.html#maxErrors-org.apache.drill.exec.record.metadata.TupleMetadata-">maxErrors</a></span>(<a href="../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a>&nbsp;providedSchema)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.store.dfs.easy.<a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#easyConfig--">easyConfig</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getConfig--">getConfig</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getFsConf--">getFsConf</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getGroupScan-java.lang.String-org.apache.drill.exec.store.dfs.FileSelection-java.util.List-">getGroupScan</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getGroupScan-java.lang.String-org.apache.drill.exec.store.dfs.FileSelection-java.util.List-org.apache.drill.exec.metastore.MetadataProviderManager-">getGroupScan</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getMatcher--">getMatcher</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getName--">getName</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getOptimizerRules--">getOptimizerRules</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getReaderBatch-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.store.dfs.easy.EasySubScan-">getReaderBatch</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getReaderOperatorType--">getReaderOperatorType</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getRecordReader-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.store.dfs.DrillFileSystem-org.apache.drill.exec.store.dfs.easy.FileWork-java.util.List-java.lang.String-">getRecordReader</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getRecordWriter-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.store.dfs.easy.EasyWriter-">getRecordWriter</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getScanStats-org.apache.drill.exec.planner.physical.PlannerSettings-org.apache.drill.exec.store.dfs.easy.EasyGroupScan-">getScanStats</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getStatisticsRecordWriter-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.store.dfs.easy.EasyWriter-">getStatisticsRecordWriter</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getStorageConfig--">getStorageConfig</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getWriter-org.apache.drill.exec.physical.base.PhysicalOperator-java.lang.String-java.util.List-">getWriter</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getWriterBatch-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.record.RecordBatch-org.apache.drill.exec.store.dfs.easy.EasyWriter-">getWriterBatch</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#getWriterOperatorType--">getWriterOperatorType</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#initScanBuilder-org.apache.drill.exec.physical.impl.scan.file.FileScanFramework.FileScanBuilder-org.apache.drill.exec.store.dfs.easy.EasySubScan-">initScanBuilder</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#isBlockSplittable--">isBlockSplittable</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#isCompressible--">isCompressible</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#isStatisticsRecordWriter-org.apache.drill.exec.ops.FragmentContext-org.apache.drill.exec.store.dfs.easy.EasyWriter-">isStatisticsRecordWriter</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#newBatchReader-org.apache.drill.exec.store.dfs.easy.EasySubScan-org.apache.drill.exec.server.options.OptionManager-">newBatchReader</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#readStatistics-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">readStatistics</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsAutoPartitioning--">supportsAutoPartitioning</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsFileImplicitColumns--">supportsFileImplicitColumns</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsLimitPushdown--">supportsLimitPushdown</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsPushDown--">supportsPushDown</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsRead--">supportsRead</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsStatistics--">supportsStatistics</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#supportsWrite--">supportsWrite</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#useEnhancedScan--">useEnhancedScan</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#writeStatistics-org.apache.drill.exec.planner.common.DrillStatsTable.TableStatistics-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">writeStatistics</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.org.apache.drill.exec.store.dfs.FormatPlugin">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.store.dfs.<a href="../../../../../../org/apache/drill/exec/store/dfs/FormatPlugin.html" title="interface in org.apache.drill.exec.store.dfs">FormatPlugin</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/dfs/FormatPlugin.html#getGroupScan-java.lang.String-org.apache.drill.exec.store.dfs.FileSelection-java.util.List-org.apache.drill.exec.server.options.OptionManager-">getGroupScan</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/FormatPlugin.html#getGroupScan-java.lang.String-org.apache.drill.exec.store.dfs.FileSelection-java.util.List-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.metastore.MetadataProviderManager-">getGroupScan</a>, <a href="../../../../../../org/apache/drill/exec/store/dfs/FormatPlugin.html#getOptimizerRules-org.apache.drill.exec.planner.PlannerPhase-">getOptimizerRules</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PLUGIN_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PLUGIN_NAME</h4>
<pre>public static final&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> PLUGIN_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.drill.exec.store.log.LogFormatPlugin.PLUGIN_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROP_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROP_PREFIX</h4>
<pre>public static final&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> PROP_PREFIX</pre>
</li>
</ul>
<a name="REGEX_PROP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REGEX_PROP</h4>
<pre>public static final&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> REGEX_PROP</pre>
</li>
</ul>
<a name="MAX_ERRORS_PROP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_ERRORS_PROP</h4>
<pre>public static final&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> MAX_ERRORS_PROP</pre>
</li>
</ul>
<a name="OPERATOR_TYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OPERATOR_TYPE</h4>
<pre>public static final&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> OPERATOR_TYPE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.drill.exec.store.log.LogFormatPlugin.OPERATOR_TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LogFormatPlugin-java.lang.String-org.apache.drill.exec.server.DrillbitContext-org.apache.hadoop.conf.Configuration-org.apache.drill.common.logical.StoragePluginConfig-org.apache.drill.exec.store.log.LogFormatConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LogFormatPlugin</h4>
<pre>public&nbsp;LogFormatPlugin(<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,
<a href="../../../../../../org/apache/drill/exec/server/DrillbitContext.html" title="class in org.apache.drill.exec.server">DrillbitContext</a>&nbsp;context,
org.apache.hadoop.conf.Configuration&nbsp;fsConf,
<a href="../../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>&nbsp;storageConfig,
<a href="../../../../../../org/apache/drill/exec/store/log/LogFormatConfig.html" title="class in org.apache.drill.exec.store.log">LogFormatConfig</a>&nbsp;formatConfig)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="frameworkBuilder-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.store.dfs.easy.EasySubScan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>frameworkBuilder</h4>
<pre>protected&nbsp;<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>&nbsp;frameworkBuilder(<a href="../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a>&nbsp;options,
<a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasySubScan.html" title="class in org.apache.drill.exec.store.dfs.easy">EasySubScan</a>&nbsp;scan)
throws <a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></pre>
<div class="block">Build a file scan framework for this plugin.
<p>
This plugin was created before the concept of "provided schema" was
available. This plugin does, however, support a provided schema and
table properties. The code here handles the various cases.
<p>
For the regex and max errors:
<ul>
<li>Use the table property, if a schema is provided and the table
property is set.</li>
<li>Else, use the format config property.</li>
</ul>
<p>
For columns:
<ul>
<li>If no schema is provided (or the schema contains only table
properties with no columns), use the column names and types from
the plugin config.</li>
<li>If a schema is provided, and the plugin defines columns, use
the column types from the provided schema. Columns are matched by
name. Provided schema type override any types specified in the
plugin.</li>
<li>If a schema is provided, and the plugin config defines no
columns, use the column names and types from the provided schema.
The columns are assumed to appear in the same order as regex
fields.</li>
<li>If the regex has more groups than either schema has columns,
fill the extras with field_n of type VARCHAR.</li>
</ul>
<p>
Typical use cases:
<ul>
<li>Minimum config: only a regex in either plugin config or table
properties.</li>
<li>Plugin config defines regex, field names and types. (The
typical approach in Drill 1.16 and before.</li>
<li>Plugin config defines the regex and field names. The provided
schema defines types. (Separates physical and logical table
definitions.</li>
<li>Provided schema defines the regex and columns. May simplify
configuration as all table information is in one place. Allows
different regex patterns for different tables of the same file
suffix.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html#frameworkBuilder-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.store.dfs.easy.EasySubScan-">frameworkBuilder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasyFormatPlugin.html" title="class in org.apache.drill.exec.store.dfs.easy">EasyFormatPlugin</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/log/LogFormatConfig.html" title="class in org.apache.drill.exec.store.log">LogFormatConfig</a>&gt;</code></dd>
<dd><code>scan</code> - the physical operation definition for the scan operation. Contains
one or more files to read. (The Easy format plugin works only for files.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the scan framework which orchestrates the scan operation across
potentially many files</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></code> - for all setup failures</dd>
</dl>
</li>
</ul>
<a name="maxErrors-org.apache.drill.exec.record.metadata.TupleMetadata-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maxErrors</h4>
<pre>public&nbsp;int&nbsp;maxErrors(<a href="../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a>&nbsp;providedSchema)</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/LogFormatPlugin.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/store/log/LogFormatField.html" title="class in org.apache.drill.exec.store.log"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/log/LogFormatPlugin.html" target="_top">Frames</a></li>
<li><a href="LogFormatPlugin.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.drill.exec.store.dfs.easy.EasyFormatPlugin">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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>