| <!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>FlightSqlProducer (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="FlightSqlProducer (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":18,"i5":18,"i6":18,"i7":18,"i8":50,"i9":6,"i10":18,"i11":6,"i12":18,"i13":18,"i14":18,"i15":18,"i16":18,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":18,"i27":6,"i28":6,"i29":6,"i30":18,"i31":18,"i32":6,"i33":18,"i34":18,"i35":18,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":18,"i49":18,"i50":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/FlightSqlProducer.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/FlightSqlColumnMetadata.Builder.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/FlightSqlProducer.Schemas.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/FlightSqlProducer.html" target="_top">Frames</a></li> |
| <li><a href="FlightSqlProducer.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface FlightSqlProducer" class="title">Interface FlightSqlProducer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</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>, <a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/arrow/flight/sql/BasicFlightSqlProducer.html" title="class in org.apache.arrow.flight.sql">BasicFlightSqlProducer</a>, <a href="../../../../../org/apache/arrow/flight/integration/tests/FlightSqlScenarioProducer.html" title="class in org.apache.arrow.flight.integration.tests">FlightSqlScenarioProducer</a>, <a href="../../../../../org/apache/arrow/flight/sql/NoOpFlightSqlProducer.html" title="class in org.apache.arrow.flight.sql">NoOpFlightSqlProducer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FlightSqlProducer</span> |
| extends <a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a>, <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">API to Implement an Arrow Flight SQL producer.</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">Interface 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/FlightSqlProducer.Schemas.html" title="class in org.apache.arrow.flight.sql">FlightSqlProducer.Schemas</a></span></code> |
| <div class="block">Default schema templates for the <a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html" title="interface in org.apache.arrow.flight.sql"><code>FlightSqlProducer</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.arrow.flight.FlightProducer"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.arrow.flight.<a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></h3> |
| <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a>, <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a>, <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="type parameter in FlightProducer.StreamListener">T</a>></code></li> |
| </ul> |
| </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#acceptPut-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPut</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</code> |
| <div class="block">Depending on the provided command, method either: |
| 1.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#acceptPutPreparedStatementQuery-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPutPreparedStatementQuery</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</code> |
| <div class="block">Accepts uploaded parameter values for a particular prepared statement query.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#acceptPutPreparedStatementUpdate-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementUpdate-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPutPreparedStatementUpdate</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementUpdate.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementUpdate</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</code> |
| <div class="block">Accepts uploaded data for a particular prepared statement data stream.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#acceptPutStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementUpdate-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPutStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementUpdate.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementUpdate</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</code> |
| <div class="block">Accepts uploaded data for a particular SQL query based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#acceptPutSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPutSubstraitPlan</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</code> |
| <div class="block">Handle a Substrait plan with uploaded data.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#beginSavepoint-org.apache.arrow.flight.sql.impl.FlightSql.ActionBeginSavepointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">beginSavepoint</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginSavepointRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginSavepointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginSavepointResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginSavepointResult</a>> listener)</code> |
| <div class="block">Create a savepoint within a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#beginTransaction-org.apache.arrow.flight.sql.impl.FlightSql.ActionBeginTransactionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">beginTransaction</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginTransactionRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginTransactionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginTransactionResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginTransactionResult</a>> listener)</code> |
| <div class="block">Begin a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/CancelStatus.html" title="enum in org.apache.arrow.flight">CancelStatus</a>> listener)</code> |
| <div class="block">Explicitly cancel a query.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#cancelQuery-org.apache.arrow.flight.FlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/CancelResult.html" title="enum in org.apache.arrow.flight.sql">CancelResult</a>> listener)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Prefer <code>#cancelFlightInfo(CancelFlightInfoRequest, CallContext, StreamListener)</code>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#closePreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.ActionClosePreparedStatementRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">closePreparedStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionClosePreparedStatementRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionClosePreparedStatementRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</code> |
| <div class="block">Closes a prepared statement on the server.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a>> listener)</code> |
| <div class="block">Close/invalidate the session.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#createPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedStatementRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">createPreparedStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</code> |
| <div class="block">Creates a prepared statement on the server and returns a handle and metadata for in a |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.ActionCreatePreparedStatementResult</code></a> object in a <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#createPreparedSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedSubstraitPlanRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">createPreparedSubstraitPlan</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedSubstraitPlanRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedSubstraitPlanRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementResult</a>> listener)</code> |
| <div class="block">Pre-compile a Substrait plan.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#doAction-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Action-org.apache.arrow.flight.FlightProducer.StreamListener-">doAction</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/Action.html" title="class in org.apache.arrow.flight">Action</a> action, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</code> |
| <div class="block">Performs the requested Flight SQL action.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#endSavepoint-org.apache.arrow.flight.sql.impl.FlightSql.ActionEndSavepointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">endSavepoint</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionEndSavepointRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionEndSavepointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</code> |
| <div class="block">Release or roll back to a savepoint.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#endTransaction-org.apache.arrow.flight.sql.impl.FlightSql.ActionEndTransactionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">endTransaction</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionEndTransactionRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionEndTransactionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</code> |
| <div class="block">Commit or roll back to a transaction.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>default <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/FlightSqlProducer.html#getFlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Depending on the provided command, method either: |
| 1.</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/FlightSqlProducer.html#getFlightInfoCatalogs-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCatalogs-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoCatalogs</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCatalogs.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCatalogs</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the available catalogs by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCatalogs.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetCatalogs</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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/FlightSqlProducer.html#getFlightInfoCrossReference-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCrossReference-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoCrossReference</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCrossReference</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Retrieve a description of the foreign key columns that reference the given table's primary key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetCrossReference</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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/FlightSqlProducer.html#getFlightInfoExportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetExportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoExportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetExportedKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Retrieves a description of the foreign key columns that reference the given table's primary key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetExportedKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/FlightSqlProducer.html#getFlightInfoImportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetImportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoImportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetImportedKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Retrieves a description of the primary key columns that are referenced by given table's foreign key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetImportedKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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/FlightSqlProducer.html#getFlightInfoPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoPreparedStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Gets information about a particular prepared statement data stream.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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/FlightSqlProducer.html#getFlightInfoPrimaryKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetPrimaryKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoPrimaryKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetPrimaryKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the available primary keys by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetPrimaryKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</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/FlightSqlProducer.html#getFlightInfoSchemas-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetDbSchemas-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoSchemas</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetDbSchemas</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the available schemas by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetDbSchemas</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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/FlightSqlProducer.html#getFlightInfoSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoSqlInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetSqlInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the SQL Info of the server by returning a |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetSqlInfo</code></a> in a <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a>.</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/FlightSqlProducer.html#getFlightInfoStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Evaluate a SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>default <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/FlightSqlProducer.html#getFlightInfoSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoSubstraitPlan</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Evaluate a Substrait plan.</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/FlightSqlProducer.html#getFlightInfoTables-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTables-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoTables</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTables</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the available tables by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetTables</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i28" 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/FlightSqlProducer.html#getFlightInfoTableTypes-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTableTypes-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoTableTypes</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTableTypes.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTableTypes</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the available table types by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTableTypes.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetTableTypes</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i29" 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/FlightSqlProducer.html#getFlightInfoTypeInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfoTypeInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetXdbcTypeInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetXdbcTypeInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns a description of all the data types supported by source.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>default <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/FlightSqlProducer.html#getSchema-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Returns the schema of the result produced by the SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>default <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/FlightSqlProducer.html#getSchemaPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getSchemaPreparedStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Get the schema of the result set of a prepared statement.</div> |
| </td> |
| </tr> |
| <tr id="i32" 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/FlightSqlProducer.html#getSchemaStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getSchemaStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Get the result schema for a SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>default <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/FlightSqlProducer.html#getSchemaSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getSchemaSubstraitPlan</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</code> |
| <div class="block">Get the result schema for a Substrait plan.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a>> listener)</code> |
| <div class="block">Get server session option(s).</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStream-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStream</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Depending on the provided command, method either: |
| 1.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamCatalogs-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamCatalogs</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for catalogs based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamCrossReference-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCrossReference-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamCrossReference</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCrossReference</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for cross reference based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamExportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetExportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamExportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetExportedKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for foreign keys based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamImportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetImportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamImportedKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetImportedKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for foreign keys based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamPreparedStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for a particular prepared statement query instance.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamPrimaryKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetPrimaryKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamPrimaryKeys</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetPrimaryKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for primary keys based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamSchemas-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetDbSchemas-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamSchemas</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetDbSchemas</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for schemas based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamSqlInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetSqlInfo</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for SQL info based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamStatement-org.apache.arrow.flight.sql.impl.FlightSql.TicketStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamStatement</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.TicketStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.TicketStatementQuery</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for a SQL query based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamTables-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTables-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamTables</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTables</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for tables based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamTableTypes-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamTableTypes</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for table types based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#getStreamTypeInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStreamTypeInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetXdbcTypeInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetXdbcTypeInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</code> |
| <div class="block">Returns data for type info based data stream.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#listActions-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">listActions</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/ActionType.html" title="class in org.apache.arrow.flight">ActionType</a>> listener)</code> |
| <div class="block">Lists all available Flight SQL actions.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a>> listener)</code> |
| <div class="block">Renew the duration of the given endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/sql/FlightSqlProducer.html#setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a>> listener)</code> |
| <div class="block">Set server session options(s).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.flight.FlightProducer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.arrow.flight.<a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></h3> |
| <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#doExchange-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">doExchange</a>, <a href="../../../../../org/apache/arrow/flight/FlightProducer.html#listFlights-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Criteria-org.apache.arrow.flight.FlightProducer.StreamListener-">listFlights</a>, <a href="../../../../../org/apache/arrow/flight/FlightProducer.html#pollFlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">pollFlightInfo</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.AutoCloseable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<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></h3> |
| <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></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfo</h4> |
| <pre>default <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfo(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Depending on the provided command, method either: |
| 1. Return information about a SQL query, or |
| 2. Return information about a prepared statement. In this case, parameters binding is allowed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#getFlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getFlightInfo</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>information about the given SQL query, or the given prepared statement.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>default <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchema(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the schema of the result produced by the SQL query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#getSchema-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-">getSchema</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result set schema.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStream-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStream</h4> |
| <pre>default void getStream(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Depending on the provided command, method either: |
| 1. Return data for a stream produced by executing the provided SQL query, or |
| 2. Return data for a prepared statement. In this case, parameters binding is allowed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#getStream-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.FlightProducer.ServerStreamListener-">getStream</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>ticket</code> - The application-defined ticket identifying this stream.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptPut-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptPut</h4> |
| <pre>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a> acceptPut(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</pre> |
| <div class="block">Depending on the provided command, method either: |
| 1. Execute provided SQL query as an update statement, or |
| 2. Execute provided update SQL query prepared statement. In this case, parameters binding |
| is allowed, or |
| 3. Binds parameters to the provided prepared statement.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#acceptPut-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-">acceptPut</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>flightStream</code> - The data stream being uploaded.</dd> |
| <dd><code>ackStream</code> - The data stream listener for update result acknowledgement.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Runnable to process the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listActions-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listActions</h4> |
| <pre>default void listActions(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/ActionType.html" title="class in org.apache.arrow.flight">ActionType</a>> listener)</pre> |
| <div class="block">Lists all available Flight SQL actions.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#listActions-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-">listActions</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doAction-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Action-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doAction</h4> |
| <pre>default void doAction(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/Action.html" title="class in org.apache.arrow.flight">Action</a> action, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</pre> |
| <div class="block">Performs the requested Flight SQL action.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html#doAction-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.Action-org.apache.arrow.flight.FlightProducer.StreamListener-">doAction</a></code> in interface <code><a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>action</code> - Client-supplied parameters.</dd> |
| <dd><code>listener</code> - A stream of responses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beginSavepoint-org.apache.arrow.flight.sql.impl.FlightSql.ActionBeginSavepointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginSavepoint</h4> |
| <pre>default void beginSavepoint(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginSavepointRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginSavepointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginSavepointResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginSavepointResult</a>> listener)</pre> |
| <div class="block">Create a savepoint within a transaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The savepoint request.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - The newly created savepoint ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beginTransaction-org.apache.arrow.flight.sql.impl.FlightSql.ActionBeginTransactionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginTransaction</h4> |
| <pre>default void beginTransaction(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginTransactionRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginTransactionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionBeginTransactionResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionBeginTransactionResult</a>> listener)</pre> |
| <div class="block">Begin a transaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The transaction request.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - The newly created transaction ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelFlightInfo</h4> |
| <pre>default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/CancelStatus.html" title="enum in org.apache.arrow.flight">CancelStatus</a>> listener)</pre> |
| <div class="block">Explicitly cancel a query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The CancelFlightInfoRequest for the query to cancel.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelQuery-org.apache.arrow.flight.FlightInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </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> |
| default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/CancelResult.html" title="enum in org.apache.arrow.flight.sql">CancelResult</a>> listener)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Prefer <code>#cancelFlightInfo(CancelFlightInfoRequest, CallContext, StreamListener)</code>.</span></div> |
| <div class="block">Explicitly cancel a query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - The FlightInfo of the query to cancel.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - Whether cancellation succeeded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionOptions</h4> |
| <pre>default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a>> listener)</pre> |
| <div class="block">Set server session options(s).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The session options to set. For *DBC driver compatibility, servers |
| should support converting values from strings.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionOptions</h4> |
| <pre>default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a>> listener)</pre> |
| <div class="block">Get server session option(s).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The (empty) GetSessionOptionsRequest.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeSession</h4> |
| <pre>default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a>> listener)</pre> |
| <div class="block">Close/invalidate the session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The (empty) CloseSessionRequest.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedStatementRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPreparedStatement</h4> |
| <pre>void createPreparedStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</pre> |
| <div class="block">Creates a prepared statement on the server and returns a handle and metadata for in a |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.ActionCreatePreparedStatementResult</code></a> object in a <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> |
| object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The sql command to generate the prepared statement.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - A stream of responses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createPreparedSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedSubstraitPlanRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPreparedSubstraitPlan</h4> |
| <pre>default void createPreparedSubstraitPlan(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedSubstraitPlanRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedSubstraitPlanRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementResult</a>> listener)</pre> |
| <div class="block">Pre-compile a Substrait plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The plan.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - The resulting prepared statement.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closePreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.ActionClosePreparedStatementRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closePreparedStatement</h4> |
| <pre>void closePreparedStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionClosePreparedStatementRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionClosePreparedStatementRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</pre> |
| <div class="block">Closes a prepared statement on the server. No result is expected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The sql command to generate the prepared statement.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - A stream of responses.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endSavepoint-org.apache.arrow.flight.sql.impl.FlightSql.ActionEndSavepointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endSavepoint</h4> |
| <pre>default void endSavepoint(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionEndSavepointRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionEndSavepointRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</pre> |
| <div class="block">Release or roll back to a savepoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The savepoint, and whether to release/rollback.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - Call <code>StreamListener#onCompleted()</code> or |
| <code>StreamListener#onError(Throwable)</code> when done; do not send a result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endTransaction-org.apache.arrow.flight.sql.impl.FlightSql.ActionEndTransactionRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endTransaction</h4> |
| <pre>default void endTransaction(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionEndTransactionRequest.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionEndTransactionRequest</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> listener)</pre> |
| <div class="block">Commit or roll back to a transaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The transaction, and whether to release/rollback.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - Call <code>StreamListener#onCompleted()</code> or |
| <code>StreamListener#onError(Throwable)</code> when done; do not send a result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoStatement</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Evaluate a SQL query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The SQL query.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoSubstraitPlan</h4> |
| <pre>default <a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoSubstraitPlan(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Evaluate a Substrait plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The Substrait plan.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoPreparedStatement</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoPreparedStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Gets information about a particular prepared statement data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The prepared statement to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaStatement</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchemaStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Get the result schema for a SQL query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The SQL query.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the schema of the result set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaPreparedStatement</h4> |
| <pre>default <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchemaPreparedStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Get the schema of the result set of a prepared statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The prepared statement handle.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the schema of the result set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaSubstraitPlan</h4> |
| <pre>default <a href="../../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchemaSubstraitPlan(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Get the result schema for a Substrait plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The Substrait plan.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Schema for the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamStatement-org.apache.arrow.flight.sql.impl.FlightSql.TicketStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamStatement</h4> |
| <pre>void getStreamStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.TicketStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.TicketStatementQuery</a> ticket, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for a SQL query based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ticket</code> - Ticket message containing the statement handle.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamPreparedStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamPreparedStatement</h4> |
| <pre>void getStreamPreparedStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for a particular prepared statement query instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The prepared statement to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptPutStatement-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementUpdate-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptPutStatement</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a> acceptPutStatement(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementUpdate.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementUpdate</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</pre> |
| <div class="block">Accepts uploaded data for a particular SQL query based data stream. |
| <p>`PutResult`s must be in the form of a <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.DoPutUpdateResult.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.DoPutUpdateResult</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The sql command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>flightStream</code> - The data stream being uploaded.</dd> |
| <dd><code>ackStream</code> - The result data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A runnable to process the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptPutSubstraitPlan-org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptPutSubstraitPlan</h4> |
| <pre>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a> acceptPutSubstraitPlan(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandStatementSubstraitPlan.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandStatementSubstraitPlan</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</pre> |
| <div class="block">Handle a Substrait plan with uploaded data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The Substrait plan to evaluate.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>flightStream</code> - The data stream being uploaded.</dd> |
| <dd><code>ackStream</code> - The result data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A runnable to process the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptPutPreparedStatementUpdate-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementUpdate-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptPutPreparedStatementUpdate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a> acceptPutPreparedStatementUpdate(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementUpdate.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementUpdate</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</pre> |
| <div class="block">Accepts uploaded data for a particular prepared statement data stream. |
| <p>`PutResult`s must be in the form of a <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.DoPutUpdateResult.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.DoPutUpdateResult</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The prepared statement to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>flightStream</code> - The data stream being uploaded.</dd> |
| <dd><code>ackStream</code> - The result data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A runnable to process the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptPutPreparedStatementQuery-org.apache.arrow.flight.sql.impl.FlightSql.CommandPreparedStatementQuery-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightStream-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptPutPreparedStatementQuery</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a> acceptPutPreparedStatementQuery(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandPreparedStatementQuery.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandPreparedStatementQuery</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> flightStream, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/PutResult.html" title="class in org.apache.arrow.flight">PutResult</a>> ackStream)</pre> |
| <div class="block">Accepts uploaded parameter values for a particular prepared statement query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The prepared statement the parameter values will bind to.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>flightStream</code> - The data stream being uploaded.</dd> |
| <dd><code>ackStream</code> - The result data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A runnable to process the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoSqlInfo</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoSqlInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetSqlInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the SQL Info of the server by returning a |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetSqlInfo</code></a> in a <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamSqlInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamSqlInfo</h4> |
| <pre>void getStreamSqlInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetSqlInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetSqlInfo</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for SQL info based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoTypeInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoTypeInfo</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoTypeInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetXdbcTypeInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetXdbcTypeInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns a description of all the data types supported by source.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamTypeInfo-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetXdbcTypeInfo-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamTypeInfo</h4> |
| <pre>void getStreamTypeInfo(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetXdbcTypeInfo.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetXdbcTypeInfo</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for type info based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoCatalogs-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCatalogs-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoCatalogs</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoCatalogs(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCatalogs.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCatalogs</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the available catalogs by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCatalogs.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetCatalogs</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamCatalogs-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamCatalogs</h4> |
| <pre>void getStreamCatalogs(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for catalogs based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoSchemas-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetDbSchemas-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoSchemas</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoSchemas(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetDbSchemas</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the available schemas by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetDbSchemas</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamSchemas-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetDbSchemas-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamSchemas</h4> |
| <pre>void getStreamSchemas(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetDbSchemas.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetDbSchemas</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for schemas based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoTables-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTables-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoTables</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoTables(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTables</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the available tables by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetTables</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamTables-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTables-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamTables</h4> |
| <pre>void getStreamTables(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTables.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTables</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for tables based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoTableTypes-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetTableTypes-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoTableTypes</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoTableTypes(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTableTypes.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetTableTypes</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the available table types by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetTableTypes.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetTableTypes</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamTableTypes-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamTableTypes</h4> |
| <pre>void getStreamTableTypes(<a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for table types based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoPrimaryKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetPrimaryKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoPrimaryKeys</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoPrimaryKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetPrimaryKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Returns the available primary keys by returning a stream of |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetPrimaryKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamPrimaryKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetPrimaryKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamPrimaryKeys</h4> |
| <pre>void getStreamPrimaryKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetPrimaryKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetPrimaryKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for primary keys based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoExportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetExportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoExportedKeys</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoExportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetExportedKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Retrieves a description of the foreign key columns that reference the given table's primary key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetExportedKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoImportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetImportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoImportedKeys</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoImportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetImportedKeys</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Retrieves a description of the primary key columns that are referenced by given table's foreign key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetImportedKeys</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightInfoCrossReference-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCrossReference-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfoCrossReference</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getFlightInfoCrossReference(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCrossReference</a> request, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor)</pre> |
| <div class="block">Retrieve a description of the foreign key columns that reference the given table's primary key columns |
| <a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl"><code>FlightSql.CommandGetCrossReference</code></a> objects in <a href="../../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight"><code>Result</code></a> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request filter parameters.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>descriptor</code> - The descriptor identifying the data stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about the stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamExportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetExportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamExportedKeys</h4> |
| <pre>void getStreamExportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetExportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetExportedKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for foreign keys based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamImportedKeys-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetImportedKeys-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamImportedKeys</h4> |
| <pre>void getStreamImportedKeys(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetImportedKeys.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetImportedKeys</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for foreign keys based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamCrossReference-org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCrossReference-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.ServerStreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamCrossReference</h4> |
| <pre>void getStreamCrossReference(<a href="../../../../../org/apache/arrow/flight/sql/impl/FlightSql.CommandGetCrossReference.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.CommandGetCrossReference</a> command, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.ServerStreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.ServerStreamListener</a> listener)</pre> |
| <div class="block">Returns data for cross reference based data stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to generate the data stream.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.FlightProducer.CallContext-org.apache.arrow.flight.FlightProducer.StreamListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>renewFlightEndpoint</h4> |
| <pre>default void 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/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight">FlightProducer.CallContext</a> context, |
| <a href="../../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html" title="interface in org.apache.arrow.flight">FlightProducer.StreamListener</a><<a href="../../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a>> listener)</pre> |
| <div class="block">Renew the duration of the given endpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The endpoint to renew.</dd> |
| <dd><code>context</code> - Per-call context.</dd> |
| <dd><code>listener</code> - An interface for sending data back to the client.</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/FlightSqlProducer.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/FlightSqlColumnMetadata.Builder.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/FlightSqlProducer.Schemas.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/FlightSqlProducer.html" target="_top">Frames</a></li> |
| <li><a href="FlightSqlProducer.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
