blob: 349a3212cf037597956ea37da8c194bf5346e97e [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>ArrowFlightSqlClientHandler (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="ArrowFlightSqlClientHandler (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ArrowFlightSqlClientHandler.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;Class</li>
<li><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.Builder.html" title="class in org.apache.arrow.driver.jdbc.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" target="_top">Frames</a></li>
<li><a href="ArrowFlightSqlClientHandler.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.arrow.driver.jdbc.client</div>
<h2 title="Class ArrowFlightSqlClientHandler" class="title">Class ArrowFlightSqlClientHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.driver.jdbc.client.ArrowFlightSqlClientHandler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ArrowFlightSqlClientHandler</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block">A <a href="../../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html" title="class in org.apache.arrow.flight.sql"><code>FlightSqlClient</code></a> handler.</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">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.Builder.html" title="class in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.Builder</a></span></code>
<div class="block">Builder for <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.PreparedStatement.html" title="interface in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.PreparedStatement</a></span></code>
<div class="block">A prepared statement handler.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#createNewHandler-org.apache.arrow.flight.FlightClient-org.apache.arrow.driver.jdbc.client.ArrowFlightSqlClientHandler.Builder-java.util.Collection-">createNewHandler</a></span>(<a href="../../../../../../org/apache/arrow/flight/FlightClient.html" title="class in org.apache.arrow.flight">FlightClient</a>&nbsp;client,
<a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.Builder.html" title="class in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.Builder</a>&nbsp;builder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>&gt;&nbsp;options)</code>
<div class="block">Creates a new <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler</code></a> from the provided <code>client</code> and <code>options</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getCatalogs--">getCatalogs</a></span>()</code>
<div class="block">Makes an RPC "getCatalogs" request.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getCrossReference-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">getCrossReference</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkCatalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkTable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkCatalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkTable)</code>
<div class="block">Makes an RPC "getCrossReference" request based on the provided info.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getExportedKeys-java.lang.String-java.lang.String-java.lang.String-">getExportedKeys</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</code>
<div class="block">Makes an RPC "getExportedKeys" request based on the provided info.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getImportedKeys-java.lang.String-java.lang.String-java.lang.String-">getImportedKeys</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</code>
<div class="block">Makes an RPC "getImportedKeys" request based on the provided info.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getInfo-java.lang.String-">getInfo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</code>
<div class="block">Makes an RPC "getInfo" request based on the provided <code>query</code>
object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getPrimaryKeys-java.lang.String-java.lang.String-java.lang.String-">getPrimaryKeys</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</code>
<div class="block">Makes an RPC "getPrimaryKeys" request based on the provided info.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getSchemas-java.lang.String-java.lang.String-">getSchemas</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaPattern)</code>
<div class="block">Makes an RPC "getSchemas" request based on the provided info.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.SqlInfo...-">getSqlInfo</a></span>(<a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.SqlInfo.html" title="enum in org.apache.arrow.flight.sql.impl">FlightSql.SqlInfo</a>...&nbsp;info)</code>
<div class="block">Gets SQL info.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/arrow/driver/jdbc/client/CloseableEndpointStreamPair.html" title="class in org.apache.arrow.driver.jdbc.client">CloseableEndpointStreamPair</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getStreams-org.apache.arrow.flight.FlightInfo-">getStreams</a></span>(<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;flightInfo)</code>
<div class="block">Makes an RPC "getStream" request based on the provided <a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight"><code>FlightInfo</code></a>
object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-">getTables</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaPattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableNamePattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;types,
boolean&nbsp;includeSchema)</code>
<div class="block">Makes an RPC "getTables" request based on the provided info.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#getTableTypes--">getTableTypes</a></span>()</code>
<div class="block">Makes an RPC "getTableTypes" request.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.PreparedStatement.html" title="interface in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.PreparedStatement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html#prepare-java.lang.String-">prepare</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</code>
<div class="block">Creates a new <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.PreparedStatement.html" title="interface in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler.PreparedStatement</code></a> for the given <code>query</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="createNewHandler-org.apache.arrow.flight.FlightClient-org.apache.arrow.driver.jdbc.client.ArrowFlightSqlClientHandler.Builder-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNewHandler</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler</a>&nbsp;createNewHandler(<a href="../../../../../../org/apache/arrow/flight/FlightClient.html" title="class in org.apache.arrow.flight">FlightClient</a>&nbsp;client,
<a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.Builder.html" title="class in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.Builder</a>&nbsp;builder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>&gt;&nbsp;options)</pre>
<div class="block">Creates a new <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler</code></a> from the provided <code>client</code> and <code>options</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - the <a href="../../../../../../org/apache/arrow/flight/FlightClient.html" title="class in org.apache.arrow.flight"><code>FlightClient</code></a> to manage under a <a href="../../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html" title="class in org.apache.arrow.flight.sql"><code>FlightSqlClient</code></a> wrapper.</dd>
<dd><code>options</code> - the <a href="../../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight"><code>CallOption</code></a>s to persist in between subsequent client calls.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" title="class in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getStreams-org.apache.arrow.flight.FlightInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStreams</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/arrow/driver/jdbc/client/CloseableEndpointStreamPair.html" title="class in org.apache.arrow.driver.jdbc.client">CloseableEndpointStreamPair</a>&gt;&nbsp;getStreams(<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;flightInfo)
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">Makes an RPC "getStream" request based on the provided <a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight"><code>FlightInfo</code></a>
object. Retrieves the result of the query previously prepared with "getInfo."</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flightInfo</code> - The <a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight"><code>FlightInfo</code></a> instance from which to fetch results.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</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></dd>
</dl>
</li>
</ul>
<a name="getInfo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfo</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getInfo(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Makes an RPC "getInfo" request based on the provided <code>query</code>
object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - The query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></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></dd>
</dl>
</li>
</ul>
<a name="prepare-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.PreparedStatement.html" title="interface in org.apache.arrow.driver.jdbc.client">ArrowFlightSqlClientHandler.PreparedStatement</a>&nbsp;prepare(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Creates a new <a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.PreparedStatement.html" title="interface in org.apache.arrow.driver.jdbc.client"><code>ArrowFlightSqlClientHandler.PreparedStatement</code></a> for the given <code>query</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - the SQL query.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new prepared statement.</dd>
</dl>
</li>
</ul>
<a name="getCatalogs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalogs</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getCatalogs()</pre>
<div class="block">Makes an RPC "getCatalogs" request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getImportedKeys-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImportedKeys</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getImportedKeys(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</pre>
<div class="block">Makes an RPC "getImportedKeys" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>schema</code> - The schema name. Must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to narrow
the search.</dd>
<dd><code>table</code> - The table name. Must match the table name as it is stored in the database.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getExportedKeys-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExportedKeys</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getExportedKeys(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</pre>
<div class="block">Makes an RPC "getExportedKeys" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>schema</code> - The schema name. Must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to narrow
the search.</dd>
<dd><code>table</code> - The table name. Must match the table name as it is stored in the database.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getSchemas-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemas</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getSchemas(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaPattern)</pre>
<div class="block">Makes an RPC "getSchemas" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>schemaPattern</code> - The schema name pattern. Must match the schema name as it is stored in the database.
Null means that schema name should not be used to narrow down the search.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getTableTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableTypes</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getTableTypes()</pre>
<div class="block">Makes an RPC "getTableTypes" request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getTables(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaPattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableNamePattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;types,
boolean&nbsp;includeSchema)</pre>
<div class="block">Makes an RPC "getTables" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>schemaPattern</code> - The schema name pattern. Must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to
narrow the search.</dd>
<dd><code>tableNamePattern</code> - The table name pattern. Must match the table name as it is stored in the database.</dd>
<dd><code>types</code> - The list of table types, which must be from the list of table types to include.
Null returns all types.</dd>
<dd><code>includeSchema</code> - Whether to include schema.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.SqlInfo...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSqlInfo</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getSqlInfo(<a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.SqlInfo.html" title="enum in org.apache.arrow.flight.sql.impl">FlightSql.SqlInfo</a>...&nbsp;info)</pre>
<div class="block">Gets SQL info.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SQL info.</dd>
</dl>
</li>
</ul>
<a name="getPrimaryKeys-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrimaryKeys</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getPrimaryKeys(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;catalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table)</pre>
<div class="block">Makes an RPC "getPrimaryKeys" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalog</code> - The catalog name; must match the catalog name as it is stored in the database.
"" retrieves those without a catalog.
Null means that the catalog name should not be used to narrow the search.</dd>
<dd><code>schema</code> - The schema name; must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to narrow
the search.</dd>
<dd><code>table</code> - The table name. Must match the table name as it is stored in the database.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</dd>
</dl>
</li>
</ul>
<a name="getCrossReference-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCrossReference</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>&nbsp;getCrossReference(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkCatalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pkTable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkCatalog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fkTable)</pre>
<div class="block">Makes an RPC "getCrossReference" request based on the provided info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pkCatalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>pkSchema</code> - The schema name. Must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to narrow
the search.</dd>
<dd><code>pkTable</code> - The table name. Must match the table name as it is stored in the database.</dd>
<dd><code>fkCatalog</code> - The catalog name. Must match the catalog name as it is stored in the database.
Retrieves those without a catalog. Null means that the catalog name should not be used to
narrow the search.</dd>
<dd><code>fkSchema</code> - The schema name. Must match the schema name as it is stored in the database.
"" retrieves those without a schema. Null means that the schema name should not be used to narrow
the search.</dd>
<dd><code>fkTable</code> - The table name. Must match the table name as it is stored in the database.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>FlightStream</code> of results.</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/ArrowFlightSqlClientHandler.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;Class</li>
<li><a href="../../../../../../org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.Builder.html" title="class in org.apache.arrow.driver.jdbc.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/driver/jdbc/client/ArrowFlightSqlClientHandler.html" target="_top">Frames</a></li>
<li><a href="ArrowFlightSqlClientHandler.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; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>