blob: 7606c4242451dc681c20e9b3681747a532f0dd69 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.adapter.jdbc (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.jdbc (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.jdbc</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Query provider based on a JDBC data source.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="JdbcRel.html" title="interface in org.apache.calcite.adapter.jdbc">JdbcRel</a></th>
<td class="colLast">
<div class="block">Relational expression that uses JDBC calling convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcSchema.Foo.html" title="interface in org.apache.calcite.adapter.jdbc">JdbcSchema.Foo</a></th>
<td class="colLast">
<div class="block">Do not use</div>
</td>
</tr>
</tbody>
</table>
</li>
<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="JdbcCatalogSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcCatalogSchema</a></th>
<td class="colLast">
<div class="block">Schema based upon a JDBC catalog (database).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcCatalogSchema.SubSchemaMap.html" title="class in org.apache.calcite.adapter.jdbc">JdbcCatalogSchema.SubSchemaMap</a></th>
<td class="colLast">
<div class="block">Contains sub-schemas by name, and the name of the default schema.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc">JdbcConvention</a></th>
<td class="colLast">
<div class="block">Calling convention for relational operations that occur in a JDBC
database.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcImplementor.html" title="class in org.apache.calcite.adapter.jdbc">JdbcImplementor</a></th>
<td class="colLast">
<div class="block">State for generating a SQL statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcQueryProvider.html" title="class in org.apache.calcite.adapter.jdbc">JdbcQueryProvider</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../linq4j/QueryProvider.html" title="interface in org.apache.calcite.linq4j"><code>QueryProvider</code></a> that talks to JDBC databases.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules</a></th>
<td class="colLast">
<div class="block">Rules and relational operators for
<a href="JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcConvention</code></a>
calling convention.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.CheckingUserDefinedFunctionVisitor.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.CheckingUserDefinedFunctionVisitor</a></th>
<td class="colLast">
<div class="block">Visitor for checking whether part of projection is a user defined function or not</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcAggregate.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcAggregate</a></th>
<td class="colLast">
<div class="block">Aggregate operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcAggregateRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcAggregateRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Aggregate.html" title="class in org.apache.calcite.rel.core"><code>Aggregate</code></a>
to a <a href="JdbcRules.JdbcAggregate.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcAggregate</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcCalc.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcCalc</a></th>
<td class="colLast">
<div class="block">Calc operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcCalcRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcCalcRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Calc.html" title="class in org.apache.calcite.rel.core"><code>Calc</code></a> to an
<a href="JdbcRules.JdbcCalc.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcCalc</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcConverterRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcConverterRule</a></th>
<td class="colLast">
<div class="block">Abstract base class for rule that converts to JDBC.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcFilter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcFilter</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../rel/core/Filter.html" title="class in org.apache.calcite.rel.core"><code>Filter</code></a> in
<a href="JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc"><code>jdbc calling convention</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcFilterRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcFilterRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Filter.html" title="class in org.apache.calcite.rel.core"><code>Filter</code></a> to
an <a href="JdbcRules.JdbcFilter.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcFilter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcIntersect.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcIntersect</a></th>
<td class="colLast">
<div class="block">Intersect operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcIntersectRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcIntersectRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Intersect.html" title="class in org.apache.calcite.rel.core"><code>Intersect</code></a>
to a <a href="JdbcRules.JdbcIntersect.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcIntersect</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcJoin.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcJoin</a></th>
<td class="colLast">
<div class="block">Join operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcJoinRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcJoinRule</a></th>
<td class="colLast">
<div class="block">Rule that converts a join to JDBC.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcMinus.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcMinus</a></th>
<td class="colLast">
<div class="block">Minus operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcMinusRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcMinusRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Minus.html" title="class in org.apache.calcite.rel.core"><code>Minus</code></a> to a
<a href="JdbcRules.JdbcMinus.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcMinus</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcProject.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcProject</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../rel/core/Project.html" title="class in org.apache.calcite.rel.core"><code>Project</code></a> in
<a href="JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc"><code>jdbc calling convention</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcProjectRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcProjectRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Project.html" title="class in org.apache.calcite.rel.core"><code>Project</code></a> to
an <a href="JdbcRules.JdbcProject.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcProject</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcSort.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcSort</a></th>
<td class="colLast">
<div class="block">Sort operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcSortRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcSortRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Sort.html" title="class in org.apache.calcite.rel.core"><code>Sort</code></a> to an
<a href="JdbcRules.JdbcSort.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcSort</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcTableModificationRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcTableModificationRule</a></th>
<td class="colLast">
<div class="block">Rule that converts a table-modification to JDBC.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcTableModify.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcTableModify</a></th>
<td class="colLast">
<div class="block">Table-modification operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcUnion.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcUnion</a></th>
<td class="colLast">
<div class="block">Union operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcUnionRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcUnionRule</a></th>
<td class="colLast">
<div class="block">Rule to convert an <a href="../../rel/core/Union.html" title="class in org.apache.calcite.rel.core"><code>Union</code></a> to a
<a href="JdbcRules.JdbcUnion.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcRules.JdbcUnion</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcValues.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcValues</a></th>
<td class="colLast">
<div class="block">Values operator implemented in JDBC convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcRules.JdbcValuesRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcValuesRule</a></th>
<td class="colLast">
<div class="block">Rule that converts a values operator to JDBC.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcSchema</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../schema/Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> that is backed by a JDBC data source.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcSchema.Factory.html" title="class in org.apache.calcite.adapter.jdbc">JdbcSchema.Factory</a></th>
<td class="colLast">
<div class="block">Schema factory that creates a
<a href="JdbcSchema.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcSchema</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></th>
<td class="colLast">
<div class="block">Queryable that gets its data from a table within a JDBC connection.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcTableScan.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTableScan</a></th>
<td class="colLast">
<div class="block">Relational expression representing a scan of a table in a JDBC data source.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcToEnumerableConverter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverter</a></th>
<td class="colLast">
<div class="block">Relational expression representing a scan of a table in a JDBC data source.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverterRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a relational expression from
<a href="JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc"><code>JdbcConvention</code></a> to
<a href="../enumerable/EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable"><code>EnumerableConvention</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcUtils.html" title="class in org.apache.calcite.adapter.jdbc">JdbcUtils</a></th>
<td class="colLast">
<div class="block">Utilities for the JDBC provider.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcUtils.DataSourcePool.html" title="class in org.apache.calcite.adapter.jdbc">JdbcUtils.DataSourcePool</a></th>
<td class="colLast">
<div class="block">Ensures that if two data sources have the same definition, they will use
the same object.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JdbcUtils.DialectPool.html" title="class in org.apache.calcite.adapter.jdbc">JdbcUtils.DialectPool</a></th>
<td class="colLast">
<div class="block">Pool of dialects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcUtils.ObjectArrayRowBuilder.html" title="class in org.apache.calcite.adapter.jdbc">JdbcUtils.ObjectArrayRowBuilder</a></th>
<td class="colLast">
<div class="block">Builder that calls <code>ResultSet.getObject(int)</code> for every column,
or <code>getXxx</code> if the result type is a primitive <code>xxx</code>,
and returns an array of objects for each row.</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>