blob: 6a13d63db1a7cef7e8452060b5b2e7ddc4310ec8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.adapter.csv (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.adapter.csv (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.adapter.csv</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Calcite query provider that reads from CSV (comma-separated value) files.
<p>A Calcite schema maps onto a directory, and each CSV file in that
directory appears as a table. Full SQL operations are available on
those tables.</p></div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="CsvEnumerator.html" title="class in org.apache.calcite.adapter.csv">CsvEnumerator</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">Enumerator that reads from a CSV file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvEnumerator.ArrayRowConverter.html" title="class in org.apache.calcite.adapter.csv">CsvEnumerator.ArrayRowConverter</a></th>
<td class="colLast">
<div class="block">Array row converter.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvEnumerator.RowConverter.html" title="class in org.apache.calcite.adapter.csv">CsvEnumerator.RowConverter</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">Row converter.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvEnumerator.SingleColumnRowConverter.html" title="class in org.apache.calcite.adapter.csv">CsvEnumerator.SingleColumnRowConverter</a></th>
<td class="colLast">
<div class="block">Single column row converter.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvFilterableTable.html" title="class in org.apache.calcite.adapter.csv">CsvFilterableTable</a></th>
<td class="colLast">
<div class="block">Table based on a CSV file that can implement simple filtering.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvProjectTableScanRule.html" title="class in org.apache.calcite.adapter.csv">CsvProjectTableScanRule</a></th>
<td class="colLast">
<div class="block">Planner rule that projects from a <a href="CsvTableScan.html" title="class in org.apache.calcite.adapter.csv"><code>CsvTableScan</code></a> scan just the columns
needed to satisfy a projection.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvScannableTable</a></th>
<td class="colLast">
<div class="block">Table based on a CSV file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvSchema.html" title="class in org.apache.calcite.adapter.csv">CsvSchema</a></th>
<td class="colLast">
<div class="block">Schema mapped onto a directory of CSV files.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvSchemaFactory.html" title="class in org.apache.calcite.adapter.csv">CsvSchemaFactory</a></th>
<td class="colLast">
<div class="block">Factory that creates a <a href="CsvSchema.html" title="class in org.apache.calcite.adapter.csv"><code>CsvSchema</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvStreamReader.html" title="class in org.apache.calcite.adapter.csv">CsvStreamReader</a></th>
<td class="colLast">
<div class="block">Extension to <code>CSVReader</code> that can read newly appended file content.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvStreamReader.CsvContentListener.html" title="class in org.apache.calcite.adapter.csv">CsvStreamReader.CsvContentListener</a></th>
<td class="colLast">
<div class="block">Watches for content being appended to a CSV file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvStreamScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvStreamScannableTable</a></th>
<td class="colLast">
<div class="block">Table based on a CSV file.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvStreamTableFactory.html" title="class in org.apache.calcite.adapter.csv">CsvStreamTableFactory</a></th>
<td class="colLast">
<div class="block">Factory that creates a <a href="CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv"><code>CsvTranslatableTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvTable.html" title="class in org.apache.calcite.adapter.csv">CsvTable</a></th>
<td class="colLast">
<div class="block">Base class for table that reads CSV files.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvTableFactory.html" title="class in org.apache.calcite.adapter.csv">CsvTableFactory</a></th>
<td class="colLast">
<div class="block">Factory that creates a <a href="CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv"><code>CsvTranslatableTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvTableScan.html" title="class in org.apache.calcite.adapter.csv">CsvTableScan</a></th>
<td class="colLast">
<div class="block">Relational expression representing a scan of a CSV file.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv">CsvTranslatableTable</a></th>
<td class="colLast">
<div class="block">Table based on a CSV file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JsonEnumerator.html" title="class in org.apache.calcite.adapter.csv">JsonEnumerator</a></th>
<td class="colLast">
<div class="block">Enumerator that reads from a JSON file.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JsonTable.html" title="class in org.apache.calcite.adapter.csv">JsonTable</a></th>
<td class="colLast">
<div class="block">Table based on a JSON file.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CsvFieldType.html" title="enum in org.apache.calcite.adapter.csv">CsvFieldType</a></th>
<td class="colLast">
<div class="block">Type of a field in a CSV file.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CsvTable.Flavor.html" title="enum in org.apache.calcite.adapter.csv">CsvTable.Flavor</a></th>
<td class="colLast">
<div class="block">Various degrees of table "intelligence".</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>