| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Tue May 07 14:19:41 GMT 2024 --> |
| <title>FlightSqlConnection (Apache Arrow ADBC Java Root POM 1.0.0-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2024-05-07"> |
| <meta name="description" content="declaration: package: org.apache.arrow.adbc.driver.flightsql, class: FlightSqlConnection"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/FlightSqlConnection.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.arrow.adbc.driver.flightsql</a></div> |
| <h1 title="Class FlightSqlConnection" class="title">Class FlightSqlConnection</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.arrow.adbc.driver.flightsql.FlightSqlConnection</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code>, <code><a href="../../core/AdbcOptions.html" title="interface in org.apache.arrow.adbc.core">AdbcOptions</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FlightSqlConnection</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.arrow.adbc.core.AdbcConnection">Nested classes/interfaces inherited from interface org.apache.arrow.adbc.core.<a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></h2> |
| <code><a href="../../core/AdbcConnection.GetObjectsDepth.html" title="enum in org.apache.arrow.adbc.core">AdbcConnection.GetObjectsDepth</a></code></div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../core/AdbcStatement.html" title="interface in org.apache.arrow.adbc.core">AdbcStatement</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bulkIngest(java.lang.String,org.apache.arrow.adbc.core.BulkIngestMode)" class="member-name-link">bulkIngest</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> targetTableName, |
| <a href="../../core/BulkIngestMode.html" title="enum in org.apache.arrow.adbc.core">BulkIngestMode</a> mode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a new statement to bulk insert a <a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/VectorSchemaRoot.html" title="class or interface in org.apache.arrow.vector" class="external-link"><code>VectorSchemaRoot</code></a> into a table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commit()" class="member-name-link">commit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Commit the pending transaction.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../core/AdbcStatement.html" title="interface in org.apache.arrow.adbc.core">AdbcStatement</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createStatement()" class="member-name-link">createStatement</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a new statement that can be executed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAutoCommit()" class="member-name-link">getAutoCommit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the autocommit state.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInfo(int%5B%5D)" class="member-name-link">getInfo</a><wbr>(int @Nullable [] infoCodes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get metadata about the driver/database.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjects(org.apache.arrow.adbc.core.AdbcConnection.GetObjectsDepth,java.lang.String,java.lang.String,java.lang.String,java.lang.String%5B%5D,java.lang.String)" class="member-name-link">getObjects</a><wbr>(<a href="../../core/AdbcConnection.GetObjectsDepth.html" title="enum in org.apache.arrow.adbc.core">AdbcConnection.GetObjectsDepth</a> depth, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> catalogPattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dbSchemaPattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tableNamePattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] tableTypes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnNamePattern)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get a hierarchical view of all catalogs, database schemas, tables, and columns.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readPartition(java.nio.ByteBuffer)" class="member-name-link">readPartition</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> descriptor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a result set from a serialized PartitionDescriptor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rollback()" class="member-name-link">rollback</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Rollback the pending transaction.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAutoCommit(boolean)" class="member-name-link">setAutoCommit</a><wbr>(boolean enableAutoCommit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Toggle whether autocommit is enabled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.arrow.adbc.core.AdbcConnection">Methods inherited from interface org.apache.arrow.adbc.core.<a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></h3> |
| <code><a href="../../core/AdbcConnection.html#cancel()">cancel</a>, <a href="../../core/AdbcConnection.html#getCurrentCatalog()">getCurrentCatalog</a>, <a href="../../core/AdbcConnection.html#getCurrentDbSchema()">getCurrentDbSchema</a>, <a href="../../core/AdbcConnection.html#getInfo()">getInfo</a>, <a href="../../core/AdbcConnection.html#getInfo(org.apache.arrow.adbc.core.AdbcInfoCode%5B%5D)">getInfo</a>, <a href="../../core/AdbcConnection.html#getIsolationLevel()">getIsolationLevel</a>, <a href="../../core/AdbcConnection.html#getReadOnly()">getReadOnly</a>, <a href="../../core/AdbcConnection.html#getStatisticNames()">getStatisticNames</a>, <a href="../../core/AdbcConnection.html#getStatistics(java.lang.String,java.lang.String,java.lang.String,boolean)">getStatistics</a>, <a href="../../core/AdbcConnection.html#getTableSchema(java.lang.String,java.lang.String,java.lang.String)">getTableSchema</a>, <a href="../../core/AdbcConnection.html#getTableTypes()">getTableTypes</a>, <a href="../../core/AdbcConnection.html#setCurrentCatalog(java.lang.String)">setCurrentCatalog</a>, <a href="../../core/AdbcConnection.html#setCurrentDbSchema(java.lang.String)">setCurrentDbSchema</a>, <a href="../../core/AdbcConnection.html#setIsolationLevel(org.apache.arrow.adbc.core.IsolationLevel)">setIsolationLevel</a>, <a href="../../core/AdbcConnection.html#setReadOnly(boolean)">setReadOnly</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.arrow.adbc.core.AdbcOptions">Methods inherited from interface org.apache.arrow.adbc.core.<a href="../../core/AdbcOptions.html" title="interface in org.apache.arrow.adbc.core">AdbcOptions</a></h3> |
| <code><a href="../../core/AdbcOptions.html#getOption(org.apache.arrow.adbc.core.TypedKey)">getOption</a>, <a href="../../core/AdbcOptions.html#setOption(org.apache.arrow.adbc.core.TypedKey,T)">setOption</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="commit()"> |
| <h3>commit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">commit</span>() |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#commit()">AdbcConnection</a></code></span></div> |
| <div class="block">Commit the pending transaction.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#commit()">commit</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStatement()"> |
| <h3>createStatement</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../core/AdbcStatement.html" title="interface in org.apache.arrow.adbc.core">AdbcStatement</a></span> <span class="element-name">createStatement</span>() |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#createStatement()">AdbcConnection</a></code></span></div> |
| <div class="block">Create a new statement that can be executed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#createStatement()">createStatement</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readPartition(java.nio.ByteBuffer)"> |
| <h3>readPartition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></span> <span class="element-name">readPartition</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> descriptor)</span> |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#readPartition(java.nio.ByteBuffer)">AdbcConnection</a></code></span></div> |
| <div class="block">Create a result set from a serialized PartitionDescriptor.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#readPartition(java.nio.ByteBuffer)">readPartition</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>descriptor</code> - The descriptor to load (<a href="../../core/PartitionDescriptor.html#getDescriptor()"><code>PartitionDescriptor.getDescriptor()</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>A statement that can be immediately executed.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../core/AdbcStatement.PartitionResult.html" title="class in org.apache.arrow.adbc.core"><code>AdbcStatement.PartitionResult</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bulkIngest(java.lang.String,org.apache.arrow.adbc.core.BulkIngestMode)"> |
| <h3>bulkIngest</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../core/AdbcStatement.html" title="interface in org.apache.arrow.adbc.core">AdbcStatement</a></span> <span class="element-name">bulkIngest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> targetTableName, |
| <a href="../../core/BulkIngestMode.html" title="enum in org.apache.arrow.adbc.core">BulkIngestMode</a> mode)</span> |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#bulkIngest(java.lang.String,org.apache.arrow.adbc.core.BulkIngestMode)">AdbcConnection</a></code></span></div> |
| <div class="block">Create a new statement to bulk insert a <a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/VectorSchemaRoot.html" title="class or interface in org.apache.arrow.vector" class="external-link"><code>VectorSchemaRoot</code></a> into a table. |
| |
| <p>Bind data to the statement, then call <a href="../../core/AdbcStatement.html#executeUpdate()"><code>AdbcStatement.executeUpdate()</code></a>. See <a href="../../core/BulkIngestMode.html" title="enum in org.apache.arrow.adbc.core"><code>BulkIngestMode</code></a> for description of behavior around creating tables.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#bulkIngest(java.lang.String,org.apache.arrow.adbc.core.BulkIngestMode)">bulkIngest</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjects(org.apache.arrow.adbc.core.AdbcConnection.GetObjectsDepth,java.lang.String,java.lang.String,java.lang.String,java.lang.String[],java.lang.String)"> |
| <h3>getObjects</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></span> <span class="element-name">getObjects</span><wbr><span class="parameters">(<a href="../../core/AdbcConnection.GetObjectsDepth.html" title="enum in org.apache.arrow.adbc.core">AdbcConnection.GetObjectsDepth</a> depth, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> catalogPattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> dbSchemaPattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tableNamePattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] tableTypes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnNamePattern)</span> |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#getObjects(org.apache.arrow.adbc.core.AdbcConnection.GetObjectsDepth,java.lang.String,java.lang.String,java.lang.String,java.lang.String%5B%5D,java.lang.String)">AdbcConnection</a></code></span></div> |
| <div class="block">Get a hierarchical view of all catalogs, database schemas, tables, and columns. |
| |
| <p>The result is an Arrow dataset with the following schema: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> </tr> |
| <tr><td>catalog_name</td> <td>utf8</td> </tr> |
| <tr><td>catalog_db_schemas</td> <td>list[DB_SCHEMA_SCHEMA]</td> </tr> |
| <caption>The definition of the GetObjects result schema.</caption> |
| </table> |
| |
| <p>DB_SCHEMA_SCHEMA is a Struct with fields: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> </tr> |
| <tr><td>db_schema_name</td> <td>utf8</td> </tr> |
| <tr><td>db_schema_tables</td> <td>list[TABLE_SCHEMA]</td> </tr> |
| <caption>The definition of DB_SCHEMA_SCHEMA.</caption> |
| </table> |
| |
| <p>TABLE_SCHEMA is a Struct with fields: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> </tr> |
| <tr><td>table_name</td> <td>utf8 not null</td> </tr> |
| <tr><td>table_type</td> <td>utf8 not null</td> </tr> |
| <tr><td>table_columns</td> <td>list[COLUMN_SCHEMA]</td> </tr> |
| <tr><td>table_constraints</td> <td>list[CONSTRAINT_SCHEMA]</td></tr> |
| <caption>The definition of TABLE_SCHEMA.</caption> |
| </table> |
| |
| <p>COLUMN_SCHEMA is a Struct with fields: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> <th>Comments</th></tr> |
| <tr><td>column_name</td> <td>utf8 not null</td> <td></td></tr> |
| <tr><td>ordinal_position</td> <td>int32</td> <td>(1)</td></tr> |
| <tr><td>remarks</td> <td>utf8</td> <td>(2)</td></tr> |
| <tr><td>xdbc_data_type</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_type_name</td> <td>utf8 </td> <td>(3)</td></tr> |
| <tr><td>xdbc_column_size</td> <td>int32</td> <td>(3)</td></tr> |
| <tr><td>xdbc_decimal_digits</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_num_prec_radix</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_nullable</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_column_def</td> <td>utf8</td> <td>(3)</td></tr> |
| <tr><td>xdbc_sql_data_type</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_datetime_sub</td> <td>int16</td> <td>(3)</td></tr> |
| <tr><td>xdbc_char_octet_length</td> <td>int32</td> <td>(3)</td></tr> |
| <tr><td>xdbc_is_nullable</td> <td>utf8</td> <td>(3)</td></tr> |
| <tr><td>xdbc_scope_catalog</td> <td>utf8</td> <td>(3)</td></tr> |
| <tr><td>xdbc_scope_schema</td> <td>utf8</td> <td>(3)</td></tr> |
| <tr><td>xdbc_scope_table</td> <td>utf8</td> <td>(3)</td></tr> |
| <tr><td>xdbc_is_autoincrement</td> <td>bool</td> <td>(3)</td></tr> |
| <tr><td>xdbc_is_generatedcolumn</td> <td>bool</td> <td>(3)</td></tr> |
| <caption>The definition of COLUMN_SCHEMA.</caption> |
| </table> |
| |
| <p>Notes: |
| |
| <ol> |
| <li>The column's ordinal position in the table (starting from 1). |
| <li>Database-specific description of the column. |
| <li>Optional value. Should be null if not supported by the driver. xdbc_ values are meant to |
| provide JDBC/ODBC-compatible metadata in an agnostic manner. |
| </ol> |
| |
| <p>CONSTRAINT_SCHEMA is a Struct with fields: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> <th>Comments</th></tr> |
| <tr><td>constraint_name</td> <td>utf8 not null</td> <td></td></tr> |
| <tr><td>constraint_type</td> <td>utf8 not null</td> <td>(1)</td></tr> |
| <tr><td>constraint_column_names</td> <td>list[utf8] not null</td> <td>(2)</td></tr> |
| <tr><td>constraint_column_usage</td> <td>list[USAGE_SCHEMA]</td> <td>(3)</td></tr> |
| <caption>The definition of CONSTRAINT_SCHEMA.</caption> |
| </table> |
| |
| <ol> |
| <li>One of 'CHECK', 'FOREIGN KEY', 'PRIMARY KEY', or 'UNIQUE'. |
| <li>The columns on the current table that are constrained, in order. |
| <li>For FOREIGN KEY only, the referenced table and columns. |
| </ol> |
| |
| <p>USAGE_SCHEMA is a Struct with fields: |
| |
| <table border="1"> |
| <tr><th>Field Name</th> <th>Field Type</th> </tr> |
| <tr><td>fk_catalog</td> <td>utf8</td> </tr> |
| <tr><td>fk_db_schema</td> <td>utf8</td> </tr> |
| <tr><td>fk_table</td> <td>utf8 not null</td> </tr> |
| <tr><td>fk_column_name</td> <td>utf8 not null</td> </tr> |
| <caption>The definition of USAGE_SCHEMA.</caption> |
| </table></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#getObjects(org.apache.arrow.adbc.core.AdbcConnection.GetObjectsDepth,java.lang.String,java.lang.String,java.lang.String,java.lang.String%5B%5D,java.lang.String)">getObjects</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>depth</code> - The level of nesting to display. If ALL, display all levels (up through columns). |
| If CATALOGS, display only catalogs (i.e. catalog_schemas will be null), and so on. May be a |
| search pattern (see class documentation).</dd> |
| <dd><code>catalogPattern</code> - Only show tables in the given catalog. If null, do not filter by catalog. |
| If an empty string, only show tables without a catalog. May be a search pattern (see class |
| documentation).</dd> |
| <dd><code>dbSchemaPattern</code> - Only show tables in the given database schema. If null, do not filter by |
| database schema. If an empty string, only show tables without a database schema. May be a |
| search pattern (see class documentation).</dd> |
| <dd><code>tableNamePattern</code> - Only show tables with the given name. If an empty string, only show |
| tables without a catalog. May be a search pattern (see class documentation).</dd> |
| <dd><code>tableTypes</code> - Only show tables matching one of the given table types. If null, show tables |
| of any type. Valid table types can be fetched from <a href="../../core/AdbcConnection.html#getTableTypes()"><code>AdbcConnection.getTableTypes()</code></a>.</dd> |
| <dd><code>columnNamePattern</code> - Only show columns with the given name. If null, do not filter by name. |
| May be a search pattern (see class documentation).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInfo(int[])"> |
| <h3>getInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://arrow.apache.org/docs/java/reference/org/apache/arrow/vector/ipc/ArrowReader.html" title="class or interface in org.apache.arrow.vector.ipc" class="external-link">ArrowReader</a></span> <span class="element-name">getInfo</span><wbr><span class="parameters">(int @Nullable [] infoCodes)</span> |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#getInfo(int%5B%5D)">AdbcConnection</a></code></span></div> |
| <div class="block">Get metadata about the driver/database.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#getInfo(int%5B%5D)">getInfo</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>infoCodes</code> - The metadata items to fetch.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rollback()"> |
| <h3>rollback</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">rollback</span>() |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#rollback()">AdbcConnection</a></code></span></div> |
| <div class="block">Rollback the pending transaction.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#rollback()">rollback</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code> - if a database error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAutoCommit()"> |
| <h3>getAutoCommit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getAutoCommit</span>() |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#getAutoCommit()">AdbcConnection</a></code></span></div> |
| <div class="block">Get the autocommit state. |
| |
| <p>Connections start in autocommit mode by default.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#getAutoCommit()">getAutoCommit</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAutoCommit(boolean)"> |
| <h3>setAutoCommit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAutoCommit</span><wbr><span class="parameters">(boolean enableAutoCommit)</span> |
| throws <span class="exceptions"><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../core/AdbcConnection.html#setAutoCommit(boolean)">AdbcConnection</a></code></span></div> |
| <div class="block">Toggle whether autocommit is enabled.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../core/AdbcConnection.html#setAutoCommit(boolean)">setAutoCommit</a></code> in interface <code><a href="../../core/AdbcConnection.html" title="interface in org.apache.arrow.adbc.core">AdbcConnection</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../core/AdbcException.html" title="class in org.apache.arrow.adbc.core">AdbcException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html#close--" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
