Google Git
Sign in
apache / calcite-site / 77e17bff6417d5bb4e3575811347366ded5fbdc5 / . / .svn / pristine / 95 / 9560529df04a2f94926a0b4ad72c650323c0bab1.svn-base
blob: 7cb8707a8e767fa8e108d173f4173a82e52fe9ef [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>Handler (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="Handler (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Handler.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/calcite/avatica/DriverVersion.html" title="class in org.apache.calcite.avatica"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/avatica/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.avatica</div>
<h2 title="Interface Handler" class="title">Interface Handler</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/calcite/avatica/HandlerImpl.html" title="class in org.apache.calcite.avatica">HandlerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Handler</span></pre>
<div class="block">Called at various points in the JDBC lifecycle.
<p>Most drivers will use <a href="../../../../org/apache/calcite/avatica/HandlerImpl.html" title="class in org.apache.calcite.avatica"><code>HandlerImpl</code></a>, which provides no-op
implementations of all methods. You only need to override methods if you
need to achieve special effects.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica">Handler.ResultSink</a></span></code>
<div class="block">Handler for temporary tables.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/avatica/Handler.html#onConnectionClose-org.apache.calcite.avatica.AvaticaConnection-">onConnectionClose</a></span>(<a href="../../../../org/apache/calcite/avatica/AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a>&nbsp;connection)</code>
<div class="block">Called by container when a connection is being closed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/avatica/Handler.html#onConnectionInit-org.apache.calcite.avatica.AvaticaConnection-">onConnectionInit</a></span>(<a href="../../../../org/apache/calcite/avatica/AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a>&nbsp;connection)</code>
<div class="block">Called by container when a connection is being created.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/avatica/Handler.html#onStatementClose-org.apache.calcite.avatica.AvaticaStatement-">onStatementClose</a></span>(<a href="../../../../org/apache/calcite/avatica/AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a>&nbsp;statement)</code>
<div class="block">Called by container when a statement is being closed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/avatica/Handler.html#onStatementExecute-org.apache.calcite.avatica.AvaticaStatement-org.apache.calcite.avatica.Handler.ResultSink-">onStatementExecute</a></span>(<a href="../../../../org/apache/calcite/avatica/AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a>&nbsp;statement,
<a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica">Handler.ResultSink</a>&nbsp;resultSink)</code>
<div class="block">Called by container when a statement is being executed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onConnectionInit-org.apache.calcite.avatica.AvaticaConnection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnectionInit</h4>
<pre>void&nbsp;onConnectionInit(<a href="../../../../org/apache/calcite/avatica/AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a>&nbsp;connection)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Called by container when a connection is being created.
<p>If the implementation of this method throws, the connection
will not be created.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Connection</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="onConnectionClose-org.apache.calcite.avatica.AvaticaConnection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnectionClose</h4>
<pre>void&nbsp;onConnectionClose(<a href="../../../../org/apache/calcite/avatica/AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a>&nbsp;connection)</pre>
<div class="block">Called by container when a connection is being closed.
<p>If the implementation of this method throws, the call to
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true#close--" title="class or interface in java.sql"><code>Connection.close()</code></a> that triggered this method will throw an
exception, but the connection will still be marked closed.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Connection</dd>
</dl>
</li>
</ul>
<a name="onStatementExecute-org.apache.calcite.avatica.AvaticaStatement-org.apache.calcite.avatica.Handler.ResultSink-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onStatementExecute</h4>
<pre>void&nbsp;onStatementExecute(<a href="../../../../org/apache/calcite/avatica/AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a>&nbsp;statement,
<a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica">Handler.ResultSink</a>&nbsp;resultSink)</pre>
<div class="block">Called by container when a statement is being executed.
<p>If the session would like the statement results stored in a temporary
table, <code>resultSink</code> is not null.
The provider must call its <a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html#toBeCompleted--"><code>Handler.ResultSink.toBeCompleted()</code></a>
method at some point during execution (not necessarily before the call to
this method returns).</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statement</code> - Statement</dd>
<dd><code>resultSink</code> - Place to put result of query. Null if container does not
want results stored to a temporary table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="onStatementClose-org.apache.calcite.avatica.AvaticaStatement-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onStatementClose</h4>
<pre>void&nbsp;onStatementClose(<a href="../../../../org/apache/calcite/avatica/AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a>&nbsp;statement)</pre>
<div class="block">Called by container when a statement is being closed.
<p>This method is called after marking the statement closed, and after
closing any open <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> objects.</p>
<p>If the implementation of this method throws, the call to
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true#close--" title="class or interface in java.sql"><code>Statement.close()</code></a> that triggered this method will throw an
exception, but the statement will still be marked closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statement</code> - Statement</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - on error</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Handler.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/calcite/avatica/DriverVersion.html" title="class in org.apache.calcite.avatica"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/avatica/Handler.ResultSink.html" title="interface in org.apache.calcite.avatica"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/avatica/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>