blob: d9fac09dda74d2543a5dece43b04f82b4e4c3b66 [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.arrow.flight.sql (Apache Arrow Java Root POM 17.0.0-SNAPSHOT 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.arrow.flight.sql (Apache Arrow Java Root POM 17.0.0-SNAPSHOT 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><a href="../../../../../org/apache/arrow/flight/integration/tests/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/flight/sql/example/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/sql/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.arrow.flight.sql</h1>
</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/arrow/flight/sql/FlightSqlProducer.html" title="interface in org.apache.arrow.flight.sql">FlightSqlProducer</a></td>
<td class="colLast">
<div class="block">API to Implement an Arrow Flight SQL producer.</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/arrow/flight/sql/BasicFlightSqlProducer.html" title="class in org.apache.arrow.flight.sql">BasicFlightSqlProducer</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html" title="interface in org.apache.arrow.flight.sql"><code>FlightSqlProducer</code></a> that implements getting FlightInfo for each metadata request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/CloseSessionResultListener.html" title="class in org.apache.arrow.flight.sql">CloseSessionResultListener</a></td>
<td class="colLast">
<div class="block">Typed StreamListener for closeSession.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightEndpointListener.html" title="class in org.apache.arrow.flight.sql">FlightEndpointListener</a></td>
<td class="colLast">
<div class="block">Typed StreamListener for renewFlightEndpoint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient</a></td>
<td class="colLast">
<div class="block">Flight client with Flight SQL semantics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></td>
<td class="colLast">
<div class="block">Helper class to encapsulate Flight SQL prepared statement logic.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a></td>
<td class="colLast">
<div class="block">A handle for an active savepoint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a></td>
<td class="colLast">
<div class="block">A wrapper around a Substrait plan and a Substrait version.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a></td>
<td class="colLast">
<div class="block">A handle for an active transaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlColumnMetadata.html" title="class in org.apache.arrow.flight.sql">FlightSqlColumnMetadata</a></td>
<td class="colLast">
<div class="block">Metadata for a column in a Flight SQL query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlColumnMetadata.Builder.html" title="class in org.apache.arrow.flight.sql">FlightSqlColumnMetadata.Builder</a></td>
<td class="colLast">
<div class="block">Builder of FlightSqlColumnMetadata, used on FlightSqlProducer implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html" title="class in org.apache.arrow.flight.sql">FlightSqlProducer.Schemas</a></td>
<td class="colLast">
<div class="block">Default schema templates for the <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html" title="interface in org.apache.arrow.flight.sql"><code>FlightSqlProducer</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlUtils.html" title="class in org.apache.arrow.flight.sql">FlightSqlUtils</a></td>
<td class="colLast">
<div class="block">Utilities to work with Flight SQL semantics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/GetSessionOptionsResultListener.html" title="class in org.apache.arrow.flight.sql">GetSessionOptionsResultListener</a></td>
<td class="colLast">
<div class="block">Typed StreamListener for getSessionOptions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/NoOpFlightSqlProducer.html" title="class in org.apache.arrow.flight.sql">NoOpFlightSqlProducer</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html" title="interface in org.apache.arrow.flight.sql"><code>FlightSqlProducer</code></a> that throws on all FlightSql-specific operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/SetSessionOptionsResultListener.html" title="class in org.apache.arrow.flight.sql">SetSessionOptionsResultListener</a></td>
<td class="colLast">
<div class="block">Typed StreamListener for setSessionOptions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/flight/sql/SqlInfoBuilder.html" title="class in org.apache.arrow.flight.sql">SqlInfoBuilder</a></td>
<td class="colLast">
<div class="block">Auxiliary class meant to facilitate the implementation of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"><code>FlightSqlProducer.getStreamSqlInfo(org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo, org.apache.arrow.flight.FlightProducer.CallContext, org.apache.arrow.flight.FlightProducer.ServerStreamListener)</code></a>.</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/arrow/flight/sql/CancelResult.html" title="enum in org.apache.arrow.flight.sql">CancelResult</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Prefer <a href="../../../../../org/apache/arrow/flight/CancelStatus.html" title="enum in org.apache.arrow.flight"><code>CancelStatus</code></a>.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</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><a href="../../../../../org/apache/arrow/flight/integration/tests/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/flight/sql/example/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/sql/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; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>