blob: d8df0b1d712ccba18a2b426788216a83f2dcbca5 [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.calcite.jdbc (Apache Calcite calcite 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.calcite.jdbc (Apache Calcite calcite 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-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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/interpreter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/linq4j/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/jdbc/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.calcite.jdbc</h1>
<div class="docSummary">
<div class="block">JDBC driver for Calcite.</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/calcite/jdbc/CalciteConnection.html" title="interface in org.apache.calcite.jdbc">CalciteConnection</a></td>
<td class="colLast">
<div class="block">Extension to Calcite's implementation of
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql"><code>JDBC connection</code></a> allows schemas to be defined
dynamically.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></td>
<td class="colLast">
<div class="block">API for a service that prepares statements for execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a></td>
<td class="colLast">
<div class="block">Context for preparing a statement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.SparkHandler.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.SparkHandler</a></td>
<td class="colLast">
<div class="block">Callback to register Spark as the main engine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.SparkHandler.RuleSetBuilder.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.SparkHandler.RuleSetBuilder</a></td>
<td class="colLast">
<div class="block">Allows Spark to declare the rules it needs.</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/calcite/jdbc/CalciteFactory.html" title="class in org.apache.calcite.jdbc">CalciteFactory</a></td>
<td class="colLast">
<div class="block">Extension of <code>AvaticaFactory</code>
for Calcite.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteJdbc41Factory.html" title="class in org.apache.calcite.jdbc">CalciteJdbc41Factory</a></td>
<td class="colLast">
<div class="block">Implementation of <code>AvaticaFactory</code>
for Calcite and JDBC 4.1 (corresponds to JDK 1.7).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteMetaImpl.html" title="class in org.apache.calcite.jdbc">CalciteMetaImpl</a></td>
<td class="colLast">
<div class="block">Helper for implementing the <code>getXxx</code> methods such as
<code>AvaticaDatabaseMetaData.getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.AnalyzeViewResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.AnalyzeViewResult</a></td>
<td class="colLast">
<div class="block">The result of analyzing a view.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The result of preparing a query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.ConvertResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ConvertResult</a></td>
<td class="colLast">
<div class="block">The result of parsing and validating a SQL query and converting it to
relational algebra.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Dummy.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Dummy</a></td>
<td class="colLast">
<div class="block">Namespace that allows us to define non-abstract methods inside an
interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.ParseResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ParseResult</a></td>
<td class="colLast">
<div class="block">The result of parsing and validating a SQL query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Query</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A union type of the three possible ways of expressing a query: as a SQL
string, a <a href="../../../../org/apache/calcite/linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> or a <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteResultSet.html" title="class in org.apache.calcite.jdbc">CalciteResultSet</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a>
for the Calcite engine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteRootSchema.html" title="class in org.apache.calcite.jdbc">CalciteRootSchema</a></td>
<td class="colLast">Deprecated</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a></td>
<td class="colLast">
<div class="block">Schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.Entry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.Entry</a></td>
<td class="colLast">
<div class="block">Entry in a schema, such as a table or sub-schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.FunctionEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.FunctionEntry</a></td>
<td class="colLast">
<div class="block">Membership of a function in a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.FunctionEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.FunctionEntryImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/jdbc/CalciteSchema.FunctionEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.FunctionEntry</code></a>
where all properties are held in fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.LatticeEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.LatticeEntry</a></td>
<td class="colLast">
<div class="block">Membership of a lattice in a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.LatticeEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.LatticeEntryImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/jdbc/CalciteSchema.LatticeEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.LatticeEntry</code></a>
where all properties are held in fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a></td>
<td class="colLast">
<div class="block">Membership of a table in a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TableEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntryImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.TableEntry</code></a>
where all properties are held in fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TypeEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TypeEntry</a></td>
<td class="colLast">
<div class="block">Membership of a type in a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TypeEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TypeEntryImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/jdbc/CalciteSchema.TypeEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.TypeEntry</code></a>
where all properties are held in fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/CalciteStatement.html" title="class in org.apache.calcite.jdbc">CalciteStatement</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true" title="class or interface in java.sql"><code>Statement</code></a>
for the Calcite engine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/ContextSqlValidator.html" title="class in org.apache.calcite.jdbc">ContextSqlValidator</a></td>
<td class="colLast">
<div class="block">A SqlValidator with schema and type factory of the given
<a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc"><code>CalcitePrepare.Context</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/Driver.html" title="class in org.apache.calcite.jdbc">Driver</a></td>
<td class="colLast">
<div class="block">Calcite JDBC driver.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/JavaCollation.html" title="class in org.apache.calcite.jdbc">JavaCollation</a></td>
<td class="colLast">
<div class="block">Collation that uses a specific <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text"><code>Collator</code></a> for comparison.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/JavaRecordType.html" title="class in org.apache.calcite.jdbc">JavaRecordType</a></td>
<td class="colLast">
<div class="block">Record type based on a Java class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/JavaTypeFactoryImpl.html" title="class in org.apache.calcite.jdbc">JavaTypeFactoryImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java"><code>JavaTypeFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/JavaTypeFactoryImpl.SyntheticRecordType.html" title="class in org.apache.calcite.jdbc">JavaTypeFactoryImpl.SyntheticRecordType</a></td>
<td class="colLast">
<div class="block">Synthetic record type.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/jdbc/SqlTimeoutException.html" title="class in org.apache.calcite.jdbc">SqlTimeoutException</a></td>
<td class="colLast">
<div class="block">Indicates that an operation timed out.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.jdbc Description">Package org.apache.calcite.jdbc Description</h2>
<div class="block">JDBC driver for Calcite.</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-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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/interpreter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/linq4j/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/jdbc/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 &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>