| <!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>FlightSqlClient (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="FlightSqlClient (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/FlightSqlClient.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/sql/FlightEndpointListener.html" title="class in org.apache.arrow.flight.sql"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/sql/FlightSqlClient.html" target="_top">Frames</a></li> |
| <li><a href="FlightSqlClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.flight.sql</div> |
| <h2 title="Class FlightSqlClient" class="title">Class FlightSqlClient</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.flight.sql.FlightSqlClient</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 class <span class="typeNameLabel">FlightSqlClient</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">Flight client with Flight SQL semantics.</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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></span></code> |
| <div class="block">Helper class to encapsulate Flight SQL prepared statement logic.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a></span></code> |
| <div class="block">A handle for an active savepoint.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a></span></code> |
| <div class="block">A wrapper around a Substrait plan and a Substrait version.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a></span></code> |
| <div class="block">A handle for an active transaction.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#FlightSqlClient-org.apache.arrow.flight.FlightClient-">FlightSqlClient</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightClient.html" title="class in org.apache.arrow.flight">FlightClient</a> client)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#beginSavepoint-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-java.lang.String-org.apache.arrow.flight.CallOption...-">beginSavepoint</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <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> name, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create a savepoint within a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#beginTransaction-org.apache.arrow.flight.CallOption...-">beginTransaction</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Begin a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/CancelFlightInfoResult.html" title="class in org.apache.arrow.flight">CancelFlightInfoResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-">cancelFlightInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/CancelFlightInfoRequest.html" title="class in org.apache.arrow.flight">CancelFlightInfoRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Cancel execution of a distributed query.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/CancelResult.html" title="enum in org.apache.arrow.flight.sql">CancelResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#cancelQuery-org.apache.arrow.flight.FlightInfo-org.apache.arrow.flight.CallOption...-">cancelQuery</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Prefer <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-"><code>cancelFlightInfo(org.apache.arrow.flight.CancelFlightInfoRequest, org.apache.arrow.flight.CallOption...)</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.CallOption...-">closeSession</a></span>(<a href="../../../../../org/apache/arrow/flight/CloseSessionRequest.html" title="class in org.apache.arrow.flight">CloseSessionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#commit-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">commit</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Commit a transaction.</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/flight/sql/FlightSqlClient.html#execute-java.lang.String-org.apache.arrow.flight.CallOption...-">execute</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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute a query on the server.</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/flight/sql/FlightSqlClient.html#execute-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">execute</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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute a query on the server.</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/flight/sql/FlightSqlClient.html#executeSubstrait-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-">executeSubstrait</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute a Substrait plan on the server.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/flight/sql/FlightSqlClient.html#executeSubstrait-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">executeSubstrait</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute a Substrait plan on the server.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#executeSubstraitUpdate-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-">executeSubstraitUpdate</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute an update query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#executeSubstraitUpdate-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">executeSubstraitUpdate</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute an update query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#executeUpdate-java.lang.String-org.apache.arrow.flight.CallOption...-">executeUpdate</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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute an update query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#executeUpdate-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">executeUpdate</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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Execute an update query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i15" 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/flight/sql/FlightSqlClient.html#getCatalogs-org.apache.arrow.flight.CallOption...-">getCatalogs</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a list of catalogs.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCatalogsSchema-org.apache.arrow.flight.CallOption...-">getCatalogsSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCatalogs-org.apache.arrow.flight.CallOption...-"><code>getCatalogs(CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/flight/sql/FlightSqlClient.html#getCrossReference-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-">getCrossReference</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> pkTableRef, |
| <a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> fkTableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Retrieves a description of the foreign key columns that reference the given table's |
| primary key columns (the foreign keys exported by a table).</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCrossReferenceSchema-org.apache.arrow.flight.CallOption...-">getCrossReferenceSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCrossReference-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getCrossReference(TableRef, TableRef, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExecuteSchema-java.lang.String-org.apache.arrow.flight.CallOption...-">getExecuteSchema</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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of the result set of a query.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExecuteSchema-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">getExecuteSchema</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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of the result set of a query.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExecuteSubstraitSchema-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-">getExecuteSubstraitSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> substraitPlan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of the result set of a Substrait plan.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExecuteSubstraitSchema-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">getExecuteSubstraitSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of the result set of a Substrait plan.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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/flight/sql/FlightSqlClient.html#getExportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-">getExportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Retrieves a description about the foreign key columns that reference the primary key columns of the given table.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExportedKeysSchema-org.apache.arrow.flight.CallOption...-">getExportedKeysSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getExportedKeys(TableRef, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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/flight/sql/FlightSqlClient.html#getImportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-">getImportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Retrieves the foreign key columns for the given table.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getImportedKeysSchema-org.apache.arrow.flight.CallOption...-">getImportedKeysSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getImportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getImportedKeys(TableRef, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i27" 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/flight/sql/FlightSqlClient.html#getPrimaryKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-">getPrimaryKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request the primary keys for a table.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getPrimaryKeysSchema-org.apache.arrow.flight.CallOption...-">getPrimaryKeysSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getPrimaryKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getPrimaryKeys(TableRef, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSchema-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-">getSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get schema for a stream.</div> |
| </td> |
| </tr> |
| <tr id="i30" 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/flight/sql/FlightSqlClient.html#getSchemas-java.lang.String-java.lang.String-org.apache.arrow.flight.CallOption...-">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> 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> dbSchemaFilterPattern, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a list of schemas.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSchemasSchema-org.apache.arrow.flight.CallOption...-">getSchemasSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSchemas-java.lang.String-java.lang.String-org.apache.arrow.flight.CallOption...-"><code>getSchemas(String, String, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-">getSessionOptions</a></span>(<a href="../../../../../org/apache/arrow/flight/GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">GetSessionOptionsRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> </td> |
| </tr> |
| <tr id="i33" 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/flight/sql/FlightSqlClient.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>... info)</code> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| </td> |
| </tr> |
| <tr id="i34" 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/flight/sql/FlightSqlClient.html#getSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.SqlInfo:A-org.apache.arrow.flight.CallOption...-">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>[] info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| </td> |
| </tr> |
| <tr id="i35" 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/flight/sql/FlightSqlClient.html#getSqlInfo-int:A-org.apache.arrow.flight.CallOption...-">getSqlInfo</a></span>(int[] info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| </td> |
| </tr> |
| <tr id="i36" 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/flight/sql/FlightSqlClient.html#getSqlInfo-java.lang.Iterable-org.apache.arrow.flight.CallOption...-">getSqlInfo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSqlInfoSchema-org.apache.arrow.flight.CallOption...-">getSqlInfoSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <code>#getSqlInfo(SqlInfo...)</code> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getStream-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.CallOption...-">getStream</a></span>(<a href="../../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Retrieve a stream from the server.</div> |
| </td> |
| </tr> |
| <tr id="i39" 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/flight/sql/FlightSqlClient.html#getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-org.apache.arrow.flight.CallOption...-">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> 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> dbSchemaFilterPattern, |
| <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> tableFilterPattern, |
| <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><<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>> tableTypes, |
| boolean includeSchema, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a list of tables.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTablesSchema-boolean-org.apache.arrow.flight.CallOption...-">getTablesSchema</a></span>(boolean includeSchema, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-org.apache.arrow.flight.CallOption...-"><code>getTables(String, String, String, List, boolean, CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i41" 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/flight/sql/FlightSqlClient.html#getTableTypes-org.apache.arrow.flight.CallOption...-">getTableTypes</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request a list of table types.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTableTypesSchema-org.apache.arrow.flight.CallOption...-">getTableTypesSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTableTypes-org.apache.arrow.flight.CallOption...-"><code>getTableTypes(CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i43" 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/flight/sql/FlightSqlClient.html#getXdbcTypeInfo-org.apache.arrow.flight.CallOption...-">getXdbcTypeInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request the information about all the data types supported.</div> |
| </td> |
| </tr> |
| <tr id="i44" 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/flight/sql/FlightSqlClient.html#getXdbcTypeInfo-int-org.apache.arrow.flight.CallOption...-">getXdbcTypeInfo</a></span>(int dataType, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request the information about the data types supported related to |
| a filter data type.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getXdbcTypeInfoSchema-org.apache.arrow.flight.CallOption...-">getXdbcTypeInfoSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getXdbcTypeInfo-org.apache.arrow.flight.CallOption...-"><code>getXdbcTypeInfo(CallOption...)</code></a> from the server.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#prepare-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-">prepare</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create a prepared statement for a Substrait plan on the server.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#prepare-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">prepare</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create a prepared statement for a Substrait plan on the server.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#prepare-java.lang.String-org.apache.arrow.flight.CallOption...-">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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create a prepared statement for a SQL query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#prepare-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create a prepared statement for a SQL query on the server.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#release-org.apache.arrow.flight.sql.FlightSqlClient.Savepoint-org.apache.arrow.flight.CallOption...-">release</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a> savepoint, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Release a savepoint.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.CallOption...-">renewFlightEndpoint</a></span>(<a href="../../../../../org/apache/arrow/flight/RenewFlightEndpointRequest.html" title="class in org.apache.arrow.flight">RenewFlightEndpointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request the server to extend the lifetime of a query result set.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#rollback-org.apache.arrow.flight.sql.FlightSqlClient.Savepoint-org.apache.arrow.flight.CallOption...-">rollback</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a> savepoint, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Rollback to a savepoint.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#rollback-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-">rollback</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Rollback a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-">setSessionOptions</a></span>(<a href="../../../../../org/apache/arrow/flight/SetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">SetSessionOptionsRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FlightSqlClient-org.apache.arrow.flight.FlightClient-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FlightSqlClient</h4> |
| <pre>public FlightSqlClient(<a href="../../../../../org/apache/arrow/flight/FlightClient.html" title="class in org.apache.arrow.flight">FlightClient</a> client)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="execute-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> execute(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute a query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to execute.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> execute(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute a query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to execute.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeSubstrait-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeSubstrait</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> executeSubstrait(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute a Substrait plan on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The Substrait plan to execute.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeSubstrait-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeSubstrait</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> executeSubstrait(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute a Substrait plan on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The Substrait plan to execute.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExecuteSchema-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecuteSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getExecuteSchema(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of the result set of a query.</div> |
| </li> |
| </ul> |
| <a name="getExecuteSchema-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecuteSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getExecuteSchema(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of the result set of a query.</div> |
| </li> |
| </ul> |
| <a name="getExecuteSubstraitSchema-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecuteSubstraitSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getExecuteSubstraitSchema(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of the result set of a Substrait plan.</div> |
| </li> |
| </ul> |
| <a name="getExecuteSubstraitSchema-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecuteSubstraitSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getExecuteSubstraitSchema(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> substraitPlan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of the result set of a Substrait plan.</div> |
| </li> |
| </ul> |
| <a name="executeUpdate-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeUpdate</h4> |
| <pre>public long executeUpdate(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute an update query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to execute.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of rows affected.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeUpdate-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeUpdate</h4> |
| <pre>public long executeUpdate(<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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute an update query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to execute.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of rows affected.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeSubstraitUpdate-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeSubstraitUpdate</h4> |
| <pre>public long executeSubstraitUpdate(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute an update query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The Substrait plan to execute.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of rows affected.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeSubstraitUpdate-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeSubstraitUpdate</h4> |
| <pre>public long executeSubstraitUpdate(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Execute an update query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The Substrait plan to execute.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of rows affected.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCatalogs-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCatalogs</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getCatalogs(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a list of catalogs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCatalogsSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCatalogsSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getCatalogsSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCatalogs-org.apache.arrow.flight.CallOption...-"><code>getCatalogs(CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_CATALOGS_SCHEMA"><code>FlightSqlProducer.Schemas.GET_CATALOGS_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getSchemas-java.lang.String-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemas</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> 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> 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> dbSchemaFilterPattern, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a list of schemas.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>catalog</code> - The catalog.</dd> |
| <dd><code>dbSchemaFilterPattern</code> - The schema filter pattern.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemasSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemasSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchemasSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getSchemas-java.lang.String-java.lang.String-org.apache.arrow.flight.CallOption...-"><code>getSchemas(String, String, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_SCHEMAS_SCHEMA"><code>FlightSqlProducer.Schemas.GET_SCHEMAS_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchema(<a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get schema for a stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - The descriptor for the stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStream-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStream</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> getStream(<a href="../../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Retrieve a stream from the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ticket</code> - The ticket granting access to the data stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</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 <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getSqlInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.SqlInfo.html" title="enum in org.apache.arrow.flight.sql.impl">FlightSql.SqlInfo</a>... info)</pre> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - The set of metadata to retrieve. None to retrieve all metadata.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.SqlInfo:A-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getSqlInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.SqlInfo.html" title="enum in org.apache.arrow.flight.sql.impl">FlightSql.SqlInfo</a>[] info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a set of Flight SQL metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - The set of metadata to retrieve. None to retrieve all metadata.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlInfo-int:A-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getSqlInfo(int[] info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a set of Flight SQL metadata. |
| Use this method if you would like to retrieve custom metadata, where the custom metadata key values start |
| from 10_000.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - The set of metadata to retrieve. None to retrieve all metadata.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlInfo-java.lang.Iterable-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getSqlInfo(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a set of Flight SQL metadata. |
| Use this method if you would like to retrieve custom metadata, where the custom metadata key values start |
| from 10_000.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - The set of metadata to retrieve. None to retrieve all metadata.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlInfoSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlInfoSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSqlInfoSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <code>#getSqlInfo(SqlInfo...)</code> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_SQL_INFO_SCHEMA"><code>FlightSqlProducer.Schemas.GET_SQL_INFO_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getXdbcTypeInfo-int-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXdbcTypeInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getXdbcTypeInfo(int dataType, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request the information about the data types supported related to |
| a filter data type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataType</code> - the data type to be used as filter.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXdbcTypeInfo-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXdbcTypeInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getXdbcTypeInfo(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request the information about all the data types supported.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXdbcTypeInfoSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXdbcTypeInfoSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getXdbcTypeInfoSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getXdbcTypeInfo-org.apache.arrow.flight.CallOption...-"><code>getXdbcTypeInfo(CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_TYPE_INFO_SCHEMA"><code>FlightSqlProducer.Schemas.GET_TYPE_INFO_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTables</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> 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> 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> dbSchemaFilterPattern, |
| <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> tableFilterPattern, |
| <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><<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>> tableTypes, |
| boolean includeSchema, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a list of tables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>catalog</code> - The catalog.</dd> |
| <dd><code>dbSchemaFilterPattern</code> - The schema filter pattern.</dd> |
| <dd><code>tableFilterPattern</code> - The table filter pattern.</dd> |
| <dd><code>tableTypes</code> - The table types to include.</dd> |
| <dd><code>includeSchema</code> - True to include the schema upon return, false to not include the schema.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTablesSchema-boolean-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTablesSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getTablesSchema(boolean includeSchema, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTables-java.lang.String-java.lang.String-java.lang.String-java.util.List-boolean-org.apache.arrow.flight.CallOption...-"><code>getTables(String, String, String, List, boolean, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_TABLES_SCHEMA"><code>FlightSqlProducer.Schemas.GET_TABLES_SCHEMA</code></a> or |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_TABLES_SCHEMA_NO_SCHEMA"><code>FlightSqlProducer.Schemas.GET_TABLES_SCHEMA_NO_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeys</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getPrimaryKeys(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request the primary keys for a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableRef</code> - An object which hold info about catalog, dbSchema and table.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrimaryKeysSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeysSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getPrimaryKeysSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getPrimaryKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getPrimaryKeys(TableRef, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_PRIMARY_KEYS_SCHEMA"><code>FlightSqlProducer.Schemas.GET_PRIMARY_KEYS_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getExportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExportedKeys</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getExportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Retrieves a description about the foreign key columns that reference the primary key columns of the given table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableRef</code> - An object which hold info about catalog, dbSchema and table.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExportedKeysSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExportedKeysSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getExportedKeysSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getExportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getExportedKeys(TableRef, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_EXPORTED_KEYS_SCHEMA"><code>FlightSqlProducer.Schemas.GET_EXPORTED_KEYS_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getImportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImportedKeys</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getImportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> tableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Retrieves the foreign key columns for the given table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableRef</code> - An object which hold info about catalog, dbSchema and table.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getImportedKeysSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImportedKeysSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getImportedKeysSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getImportedKeys-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getImportedKeys(TableRef, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_IMPORTED_KEYS_SCHEMA"><code>FlightSqlProducer.Schemas.GET_IMPORTED_KEYS_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCrossReference-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCrossReference</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getCrossReference(<a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> pkTableRef, |
| <a href="../../../../../org/apache/arrow/flight/sql/util/TableRef.html" title="class in org.apache.arrow.flight.sql.util">TableRef</a> fkTableRef, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Retrieves a description of the foreign key columns that reference the given table's |
| primary key columns (the foreign keys exported by a table).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pkTableRef</code> - An object which hold info about catalog, dbSchema and table from a primary table.</dd> |
| <dd><code>fkTableRef</code> - An object which hold info about catalog, dbSchema and table from a foreign table.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCrossReferenceSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCrossReferenceSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getCrossReferenceSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getCrossReference-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.sql.util.TableRef-org.apache.arrow.flight.CallOption...-"><code>getCrossReference(TableRef, TableRef, CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_CROSS_REFERENCE_SCHEMA"><code>FlightSqlProducer.Schemas.GET_CROSS_REFERENCE_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getTableTypes-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableTypes</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getTableTypes(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request a list of table types.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FlightInfo object representing the stream(s) to fetch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTableTypesSchema-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableTypesSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getTableTypesSchema(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the schema of <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#getTableTypes-org.apache.arrow.flight.CallOption...-"><code>getTableTypes(CallOption...)</code></a> from the server. |
| |
| <p>Should be identical to <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.Schemas.html#GET_TABLE_TYPES_SCHEMA"><code>FlightSqlProducer.Schemas.GET_TABLE_TYPES_SCHEMA</code></a>.</div> |
| </li> |
| </ul> |
| <a name="prepare-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a> 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> query, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create a prepared statement for a SQL query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to prepare.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The representation of the prepared statement which exists on the server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepare-java.lang.String-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a> 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> query, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create a prepared statement for a SQL query on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - The query to prepare.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The representation of the prepared statement which exists on the server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepare-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a> prepare(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create a prepared statement for a Substrait plan on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The query to prepare.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The representation of the prepared statement which exists on the server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepare-org.apache.arrow.flight.sql.FlightSqlClient.SubstraitPlan-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.PreparedStatement</a> prepare(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.SubstraitPlan.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.SubstraitPlan</a> plan, |
| <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create a prepared statement for a Substrait plan on the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - The query to prepare.</dd> |
| <dd><code>transaction</code> - The transaction that this query is part of.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The representation of the prepared statement which exists on the server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beginTransaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginTransaction</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> beginTransaction(<a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Begin a transaction.</div> |
| </li> |
| </ul> |
| <a name="beginSavepoint-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-java.lang.String-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginSavepoint</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a> beginSavepoint(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <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> name, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create a savepoint within a transaction.</div> |
| </li> |
| </ul> |
| <a name="commit-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Commit a transaction.</div> |
| </li> |
| </ul> |
| <a name="release-org.apache.arrow.flight.sql.FlightSqlClient.Savepoint-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre>public void release(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a> savepoint, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Release a savepoint.</div> |
| </li> |
| </ul> |
| <a name="rollback-org.apache.arrow.flight.sql.FlightSqlClient.Transaction-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Transaction.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Transaction</a> transaction, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Rollback a transaction.</div> |
| </li> |
| </ul> |
| <a name="rollback-org.apache.arrow.flight.sql.FlightSqlClient.Savepoint-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback(<a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.Savepoint.html" title="class in org.apache.arrow.flight.sql">FlightSqlClient.Savepoint</a> savepoint, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Rollback to a savepoint.</div> |
| </li> |
| </ul> |
| <a name="cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelFlightInfo</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/CancelFlightInfoResult.html" title="class in org.apache.arrow.flight">CancelFlightInfoResult</a> cancelFlightInfo(<a href="../../../../../org/apache/arrow/flight/CancelFlightInfoRequest.html" title="class in org.apache.arrow.flight">CancelFlightInfoRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Cancel execution of a distributed query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The query to cancel.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The server response.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelQuery-org.apache.arrow.flight.FlightInfo-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelQuery</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../../org/apache/arrow/flight/sql/CancelResult.html" title="enum in org.apache.arrow.flight.sql">CancelResult</a> cancelQuery(<a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> info, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Prefer <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.html#cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-"><code>cancelFlightInfo(org.apache.arrow.flight.CancelFlightInfoRequest, org.apache.arrow.flight.CallOption...)</code></a>.</span></div> |
| <div class="block">Explicitly cancel a running query. |
| <p> |
| This lets a single client explicitly cancel work, no matter how many clients |
| are involved/whether the query is distributed or not, given server support. |
| The transaction/statement is not rolled back; it is the application's job to |
| commit or rollback as appropriate. This only indicates the client no longer |
| wishes to read the remainder of the query results or continue submitting |
| data.</div> |
| </li> |
| </ul> |
| <a name="renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewFlightEndpoint</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a> renewFlightEndpoint(<a href="../../../../../org/apache/arrow/flight/RenewFlightEndpointRequest.html" title="class in org.apache.arrow.flight">RenewFlightEndpointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request the server to extend the lifetime of a query result set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The result set partition.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new endpoint with an updated expiration time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionOptions</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a> setSessionOptions(<a href="../../../../../org/apache/arrow/flight/SetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">SetSessionOptionsRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| </li> |
| </ul> |
| <a name="getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionOptions</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a> getSessionOptions(<a href="../../../../../org/apache/arrow/flight/GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">GetSessionOptionsRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| </li> |
| </ul> |
| <a name="closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeSession</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a> closeSession(<a href="../../../../../org/apache/arrow/flight/CloseSessionRequest.html" title="class in org.apache.arrow.flight">CloseSessionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</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> in interface <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/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></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/FlightSqlClient.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/sql/FlightEndpointListener.html" title="class in org.apache.arrow.flight.sql"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlClient.PreparedStatement.html" title="class in org.apache.arrow.flight.sql"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/sql/FlightSqlClient.html" target="_top">Frames</a></li> |
| <li><a href="FlightSqlClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |