blob: a15bb61a53af7a03e19da3a8a7c655a630fc2f5d [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.store.mock (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.store.mock (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/store/mapr/streams/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/store/mongo/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/mock/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.store.mock</h1>
<div class="docSummary">
<div class="block">Defines a mock data source which generates dummy test data for use
in testing.</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/store/mock/FieldGen.html" title="interface in org.apache.drill.exec.store.mock">FieldGen</a></td>
<td class="colLast">
<div class="block">Interface which all mock column data generators must
implement.</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/store/mock/AbstractFieldGen.html" title="class in org.apache.drill.exec.store.mock">AbstractFieldGen</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/BooleanGen.html" title="class in org.apache.drill.exec.store.mock">BooleanGen</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/ColumnDef.html" title="class in org.apache.drill.exec.store.mock">ColumnDef</a></td>
<td class="colLast">
<div class="block">Defines a column for the "enhanced" version of the mock data
source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/DateGen.html" title="class in org.apache.drill.exec.store.mock">DateGen</a></td>
<td class="colLast">
<div class="block">Very simple date value generator that produces ISO dates
uniformly distributed over the last year.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/DoubleGen.html" title="class in org.apache.drill.exec.store.mock">DoubleGen</a></td>
<td class="colLast">
<div class="block">Generates random field values uniformly distributed over
the range +-1 million, with any number of digits past
the decimal point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/ExtendedMockBatchReader.html" title="class in org.apache.drill.exec.store.mock">ExtendedMockBatchReader</a></td>
<td class="colLast">
<div class="block">Extended form of the mock record reader that uses generator class
instances to create the mock values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/IntGen.html" title="class in org.apache.drill.exec.store.mock">IntGen</a></td>
<td class="colLast">
<div class="block">Generates integer values uniformly randomly distributed over
the entire 32-bit integer range from
<code>Integer.MIN_VALUE</code> to <code>Integer.MAX_VALUE</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockBreakageStorage.html" title="class in org.apache.drill.exec.store.mock">MockBreakageStorage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockBreakageStorage.MockBreakageStorageEngineConfig.html" title="class in org.apache.drill.exec.store.mock">MockBreakageStorage.MockBreakageStorageEngineConfig</a></td>
<td class="colLast">
<div class="block">Each storage plugin requires a unique config class to allow
config --> impl lookups to be unique.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockGroupScanPOP.html" title="class in org.apache.drill.exec.store.mock">MockGroupScanPOP</a></td>
<td class="colLast">
<div class="block">Describes a "group" scan of a (logical) mock table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockRecordReader.html" title="class in org.apache.drill.exec.store.mock">MockRecordReader</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockScanBatchCreator.html" title="class in org.apache.drill.exec.store.mock">MockScanBatchCreator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockStorageEngine.html" title="class in org.apache.drill.exec.store.mock">MockStorageEngine</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockStorageEngineConfig.html" title="class in org.apache.drill.exec.store.mock">MockStorageEngineConfig</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockStorePOP.html" title="class in org.apache.drill.exec.store.mock">MockStorePOP</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockSubScanPOP.html" title="class in org.apache.drill.exec.store.mock">MockSubScanPOP</a></td>
<td class="colLast">
<div class="block">Describes a physical scan operation for the mock data source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockTableDef.html" title="class in org.apache.drill.exec.store.mock">MockTableDef</a></td>
<td class="colLast">
<div class="block">Structure of a mock table definition file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockTableDef.MockColumn.html" title="class in org.apache.drill.exec.store.mock">MockTableDef.MockColumn</a></td>
<td class="colLast">
<div class="block">Meta-data description of the columns we wish to create during a simulated
scan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockTableDef.MockScanEntry.html" title="class in org.apache.drill.exec.store.mock">MockTableDef.MockScanEntry</a></td>
<td class="colLast">
<div class="block">Describes one simulated file (or block) within the logical file scan
described by this group scan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MockTableDef.MockTableSelection.html" title="class in org.apache.drill.exec.store.mock">MockTableDef.MockTableSelection</a></td>
<td class="colLast">
<div class="block">A tiny wrapper class to add required DrillTableSelection behaviour to
the entries list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/MoneyGen.html" title="class in org.apache.drill.exec.store.mock">MoneyGen</a></td>
<td class="colLast">
<div class="block">Generates a mock money field as a double over the range 0
to 1 million.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/StringGen.html" title="class in org.apache.drill.exec.store.mock">StringGen</a></td>
<td class="colLast">
<div class="block">Generates a mock string field of the given length.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/mock/VaryingStringGen.html" title="class in org.apache.drill.exec.store.mock">VaryingStringGen</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.drill.exec.store.mock Description">Package org.apache.drill.exec.store.mock Description</h2>
<div class="block">Defines a mock data source which generates dummy test data for use
in testing. The data source operates in two modes:
<ul>
<li><b>Classic:</b> used in physical plans in many unit tests.
The plan specifies a set of columns; data is generated by the
vectors themselves based on two alternating values.</li>
<li><b>Enhanced:</b> available for use in newer unit tests.
Enhances the physical plan description to allow specifying a data
generator class (for various types, data formats, etc.) Also
provides a data storage engine framework to allow using mock
tables in SQL queries.</li>
</ul>
<h3>Classic Mode</h3>
Create a scan operator that looks like the following (from
<tt>/src/test/resources/functions/cast/two_way_implicit_cast.json</tt>,
used in <code>TestReverseImplicitCast</code>):
<pre><code>
graph:[
{</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/store/mapr/streams/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/store/mongo/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/mock/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>