blob: b828d8cf2796d60f4cbe1afb8e13c040119c7c34 [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.avatica (Apache Calcite Avatica 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.avatica (Apache Calcite Avatica 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>Prev&nbsp;Package</li>
<li><a href="../../../../org/apache/calcite/avatica/jdbc/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/avatica/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.avatica</h1>
<div class="docSummary">
<div class="block">Avatica JDBC framework.</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/avatica/AvaticaConnection.CallableWithoutException.html" title="interface in org.apache.calcite.avatica">AvaticaConnection.CallableWithoutException</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A Callable-like interface but without a "throws Exception".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaFactory.html" title="interface in org.apache.calcite.avatica">AvaticaFactory</a></td>
<td class="colLast">
<div class="block">Factory for JDBC objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaSpecificDatabaseMetaData.html" title="interface in org.apache.calcite.avatica">AvaticaSpecificDatabaseMetaData</a></td>
<td class="colLast">
<div class="block">Avatica additions to the JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql"><code>DatabaseMetaData</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionConfig.html" title="interface in org.apache.calcite.avatica">ConnectionConfig</a></td>
<td class="colLast">
<div class="block">Connection configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionConfigImpl.Converter.html" title="interface in org.apache.calcite.avatica">ConnectionConfigImpl.Converter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Callback to parse a property from string to its native type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></td>
<td class="colLast">
<div class="block">Definition of a property that may be specified on the JDBC connect string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Handler.html" title="interface in org.apache.calcite.avatica">Handler</a></td>
<td class="colLast">
<div class="block">Called at various points in the JDBC lifecycle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica">Handler.ResultSink</a></td>
<td class="colLast">
<div class="block">Handler for temporary tables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></td>
<td class="colLast">
<div class="block">Command handler for getting various metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></td>
<td class="colLast">
<div class="block">A pojo containing various client-settable <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>Connection</code></a> properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.Factory.html" title="interface in org.apache.calcite.avatica">Meta.Factory</a></td>
<td class="colLast">
<div class="block">Factory to create instances of <a href="../../../../org/apache/calcite/avatica/Meta.html" title="interface in org.apache.calcite.avatica"><code>Meta</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.PrepareCallback.html" title="interface in org.apache.calcite.avatica">Meta.PrepareCallback</a></td>
<td class="colLast">
<div class="block">API to put a result set into a statement, being careful to enforce
thread-safety and not to overwrite existing open result sets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.Named.html" title="interface in org.apache.calcite.avatica">MetaImpl.Named</a></td>
<td class="colLast">
<div class="block">An object that has a name.</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/avatica/AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a></td>
<td class="colLast">
<div class="block">Implementation of JDBC connection
for the Avatica framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaConnection.Trojan.html" title="class in org.apache.calcite.avatica">AvaticaConnection.Trojan</a></td>
<td class="colLast">
<div class="block">A way to call package-protected methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaDatabaseMetaData.html" title="class in org.apache.calcite.avatica">AvaticaDatabaseMetaData</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql"><code>DatabaseMetaData</code></a>
for the Avatica engine.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaParameter.html" title="class in org.apache.calcite.avatica">AvaticaParameter</a></td>
<td class="colLast">
<div class="block">Metadata for a parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaPreparedStatement.html" title="class in org.apache.calcite.avatica">AvaticaPreparedStatement</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql"><code>PreparedStatement</code></a>
for the Avatica engine.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaResultSet.html" title="class in org.apache.calcite.avatica">AvaticaResultSet</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 Avatica engine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaResultSetMetaData.html" title="class in org.apache.calcite.avatica">AvaticaResultSetMetaData</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>
for the Avatica framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaSite.html" title="class in org.apache.calcite.avatica">AvaticaSite</a></td>
<td class="colLast">
<div class="block">A location that a value can be written to or read from.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</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 Avatica engine.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaUtils.html" title="class in org.apache.calcite.avatica">AvaticaUtils</a></td>
<td class="colLast">
<div class="block">Avatica utilities.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></td>
<td class="colLast">
<div class="block">Metadata for a column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.ArrayType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ArrayType</a></td>
<td class="colLast">
<div class="block">Array type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a></td>
<td class="colLast">
<div class="block">Base class for a column type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.ScalarType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ScalarType</a></td>
<td class="colLast">
<div class="block">Scalar type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.StructType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.StructType</a></td>
<td class="colLast">
<div class="block">Record type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionConfigImpl.html" title="class in org.apache.calcite.avatica">ConnectionConfigImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/avatica/ConnectionConfig.html" title="interface in org.apache.calcite.avatica"><code>ConnectionConfig</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionConfigImpl.PropEnv.html" title="class in org.apache.calcite.avatica">ConnectionConfigImpl.PropEnv</a></td>
<td class="colLast">
<div class="block">The combination of a property definition and a map of property values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionPropertiesImpl.html" title="class in org.apache.calcite.avatica">ConnectionPropertiesImpl</a></td>
<td class="colLast">
<div class="block">Concrete implementation of <a href="../../../../org/apache/calcite/avatica/Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica"><code>Meta.ConnectionProperties</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectStringParser.html" title="class in org.apache.calcite.avatica">ConnectStringParser</a></td>
<td class="colLast">
<div class="block">ConnectStringParser is a utility class that parses or creates a JDBC connect
string according to the
<a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms722656(v=vs.85).aspx">
OLE DB Connection String Syntax</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/DriverVersion.html" title="class in org.apache.calcite.avatica">DriverVersion</a></td>
<td class="colLast">
<div class="block">Driver version information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/HandlerImpl.html" title="class in org.apache.calcite.avatica">HandlerImpl</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/avatica/Handler.html" title="interface in org.apache.calcite.avatica"><code>Handler</code></a> that does nothing for each callback.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Helper.html" title="class in org.apache.calcite.avatica">Helper</a></td>
<td class="colLast">
<div class="block">Utility methods, mainly concerning error-handling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.ConnectionHandle.html" title="class in org.apache.calcite.avatica">Meta.ConnectionHandle</a></td>
<td class="colLast">
<div class="block">Connection handle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.CursorFactory.html" title="class in org.apache.calcite.avatica">Meta.CursorFactory</a></td>
<td class="colLast">
<div class="block">Information necessary to convert an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> into a
<a href="../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.ExecuteBatchResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteBatchResult</a></td>
<td class="colLast">
<div class="block">Response from a collection of SQL commands or parameter values in a single batch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.ExecuteResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteResult</a></td>
<td class="colLast">
<div class="block">Response from execute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.Frame.html" title="class in org.apache.calcite.avatica">Meta.Frame</a></td>
<td class="colLast">
<div class="block">A collection of rows.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.MetaResultSet.html" title="class in org.apache.calcite.avatica">Meta.MetaResultSet</a></td>
<td class="colLast">
<div class="block">Meta data from which a result set can be constructed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.Pat.html" title="class in org.apache.calcite.avatica">Meta.Pat</a></td>
<td class="colLast">
<div class="block">Wrapper to remind API calls that a parameter is a pattern (allows '%' and
'_' wildcards, per the JDBC spec) rather than a string to be matched
exactly.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a></td>
<td class="colLast">
<div class="block">Result of preparing a statement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a></td>
<td class="colLast">
<div class="block">Statement handle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.html" title="class in org.apache.calcite.avatica">MetaImpl</a></td>
<td class="colLast">
<div class="block">Basic implementation of <a href="../../../../org/apache/calcite/avatica/Meta.html" title="interface in org.apache.calcite.avatica"><code>Meta</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaAttribute.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaAttribute</a></td>
<td class="colLast">
<div class="block">Metadata describing an attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaBestRowIdentifier.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaBestRowIdentifier</a></td>
<td class="colLast">
<div class="block">Metadata describing the best identifier for a row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaCatalog.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaCatalog</a></td>
<td class="colLast">
<div class="block">Metadata describing a catalog.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaClientInfoProperty.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaClientInfoProperty</a></td>
<td class="colLast">
<div class="block">Metadata describing a client info property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaColumn.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaColumn</a></td>
<td class="colLast">
<div class="block">Metadata describing a column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaColumnPrivilege.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaColumnPrivilege</a></td>
<td class="colLast">
<div class="block">Metadata describing a column privilege.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaCrossReference.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaCrossReference</a></td>
<td class="colLast">
<div class="block">Metadata describing a cross reference.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaExportedKey.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaExportedKey</a></td>
<td class="colLast">
<div class="block">Metadata describing an exported key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaFunction.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaFunction</a></td>
<td class="colLast">
<div class="block">Metadata describing a function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaFunctionColumn.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaFunctionColumn</a></td>
<td class="colLast">
<div class="block">Metadata describing a function column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaImportedKey.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaImportedKey</a></td>
<td class="colLast">
<div class="block">Metadata describing an imported key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaIndexInfo.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaIndexInfo</a></td>
<td class="colLast">
<div class="block">Metadata describing index info.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaPrimaryKey.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaPrimaryKey</a></td>
<td class="colLast">
<div class="block">Metadata describing a primary key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaProcedure.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaProcedure</a></td>
<td class="colLast">
<div class="block">Metadata describing a procedure.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaProcedureColumn.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaProcedureColumn</a></td>
<td class="colLast">
<div class="block">Metadata describing a procedure column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaPseudoColumn.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaPseudoColumn</a></td>
<td class="colLast">
<div class="block">Metadata describing a pseudo column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaSchema.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaSchema</a></td>
<td class="colLast">
<div class="block">Metadata describing a schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaSuperTable.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaSuperTable</a></td>
<td class="colLast">
<div class="block">Metadata describing a super-table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaSuperType.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaSuperType</a></td>
<td class="colLast">
<div class="block">Metadata describing a super-type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaTable.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaTable</a></td>
<td class="colLast">
<div class="block">Metadata describing a table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaTablePrivilege.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaTablePrivilege</a></td>
<td class="colLast">
<div class="block">Metadata describing a table privilege.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaTableType.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaTableType</a></td>
<td class="colLast">
<div class="block">Metadata describing a table type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaTypeInfo.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaTypeInfo</a></td>
<td class="colLast">
<div class="block">Metadata describing type info.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaUdt.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaUdt</a></td>
<td class="colLast">
<div class="block">Metadata describing a user-defined type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.MetaVersionColumn.html" title="class in org.apache.calcite.avatica">MetaImpl.MetaVersionColumn</a></td>
<td class="colLast">
<div class="block">Metadata describing a version column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/QueryState.html" title="class in org.apache.calcite.avatica">QueryState</a></td>
<td class="colLast">
<div class="block">A struct used to encapsulate the necessary information to reconstitute a ResultSet in the
Avatica server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/UnregisteredDriver.html" title="class in org.apache.calcite.avatica">UnregisteredDriver</a></td>
<td class="colLast">
<div class="block">Implementation of JDBC driver that does not register itself.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaSeverity.html" title="enum in org.apache.calcite.avatica">AvaticaSeverity</a></td>
<td class="colLast">
<div class="block">An enumeration that denotes the severity of a given unexpected state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a></td>
<td class="colLast">
<div class="block">Enumeration of Avatica's built-in connection properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a></td>
<td class="colLast">
<div class="block">Description of the type used to internally represent a value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/ConnectionProperty.Type.html" title="enum in org.apache.calcite.avatica">ConnectionProperty.Type</a></td>
<td class="colLast">
<div class="block">Data type of property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/InternalProperty.html" title="enum in org.apache.calcite.avatica">InternalProperty</a></td>
<td class="colLast">
<div class="block">Definitions of properties that drive the behavior of
<a href="../../../../org/apache/calcite/avatica/AvaticaDatabaseMetaData.html" title="class in org.apache.calcite.avatica"><code>AvaticaDatabaseMetaData</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.DatabaseProperty.html" title="enum in org.apache.calcite.avatica">Meta.DatabaseProperty</a></td>
<td class="colLast">
<div class="block">Database property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.StatementType.html" title="enum in org.apache.calcite.avatica">Meta.StatementType</a></td>
<td class="colLast">
<div class="block">Type of statement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/Meta.Style.html" title="enum in org.apache.calcite.avatica">Meta.Style</a></td>
<td class="colLast">
<div class="block">How logical fields are represented in the objects returned by the
iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/QueryState.StateType.html" title="enum in org.apache.calcite.avatica">QueryState.StateType</a></td>
<td class="colLast">
<div class="block">An enumeration that represents how a ResultSet was created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/SqlState.html" title="enum in org.apache.calcite.avatica">SqlState</a></td>
<td class="colLast">
<div class="block">SQL error codes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/SqlType.html" title="enum in org.apache.calcite.avatica">SqlType</a></td>
<td class="colLast">
<div class="block">Extends the information in <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true" title="class or interface in java.sql"><code>Types</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/SqlType.Method.html" title="enum in org.apache.calcite.avatica">SqlType.Method</a></td>
<td class="colLast">
<div class="block">Getter methods in <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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/UnregisteredDriver.JdbcVersion.html" title="enum in org.apache.calcite.avatica">UnregisteredDriver.JdbcVersion</a></td>
<td class="colLast">
<div class="block">JDBC version.</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/avatica/AvaticaClientRuntimeException.html" title="class in org.apache.calcite.avatica">AvaticaClientRuntimeException</a></td>
<td class="colLast">
<div class="block">The client-side representation of <a href="../../../../org/apache/calcite/avatica/remote/AvaticaRuntimeException.html" title="class in org.apache.calcite.avatica.remote"><code>AvaticaRuntimeException</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/AvaticaSqlException.html" title="class in org.apache.calcite.avatica">AvaticaSqlException</a></td>
<td class="colLast">
<div class="block">A client-facing <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql"><code>SQLException</code></a> which encapsulates errors from the remote Avatica server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MissingResultsException.html" title="class in org.apache.calcite.avatica">MissingResultsException</a></td>
<td class="colLast">
<div class="block">An Exception which denotes that a cached Statement is present but has no <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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/NoSuchConnectionException.html" title="class in org.apache.calcite.avatica">NoSuchConnectionException</a></td>
<td class="colLast">
<div class="block">An Exception that denotes that the given Connection is not cached.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/NoSuchStatementException.html" title="class in org.apache.calcite.avatica">NoSuchStatementException</a></td>
<td class="colLast">
<div class="block">An Exception that denotes that the given Statement is not cached.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.ColumnNoNulls.html" title="annotation in org.apache.calcite.avatica">MetaImpl.ColumnNoNulls</a></td>
<td class="colLast">
<div class="block">Annotation that indicates that a meta field may not contain null
values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.ColumnNullable.html" title="annotation in org.apache.calcite.avatica">MetaImpl.ColumnNullable</a></td>
<td class="colLast">
<div class="block">Annotation that indicates that a meta field may contain null values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/avatica/MetaImpl.ColumnNullableUnknown.html" title="annotation in org.apache.calcite.avatica">MetaImpl.ColumnNullableUnknown</a></td>
<td class="colLast">
<div class="block">Annotation that indicates that it is unknown whether a meta field may contain
null values.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.avatica Description">Package org.apache.calcite.avatica Description</h2>
<div class="block">Avatica JDBC framework.</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>Prev&nbsp;Package</li>
<li><a href="../../../../org/apache/calcite/avatica/jdbc/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/avatica/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; 2012&#x2013;2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>