| <!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>JdbcToArrowUtils (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="JdbcToArrowUtils (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JdbcToArrowUtils.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/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html" target="_top">Frames</a></li> |
| <li><a href="JdbcToArrowUtils.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.arrow.adapter.jdbc</div> |
| <h2 title="Class JdbcToArrowUtils" class="title">Class JdbcToArrowUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.adapter.jdbc.JdbcToArrowUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JdbcToArrowUtils</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Class that does most of the work to convert JDBC ResultSet data into Arrow columnar format Vector objects.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.10.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#JdbcToArrowUtils--">JdbcToArrowUtils</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></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>static <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#getArrowTypeFromJdbcType-org.apache.arrow.adapter.jdbc.JdbcFieldInfo-java.util.Calendar-">getArrowTypeFromJdbcType</a></span>(<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a> fieldInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar)</code> |
| <div class="block">Converts the provided JDBC type to its respective <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo"><code>ArrowType</code></a> counterpart.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#getConsumer-org.apache.arrow.vector.types.pojo.ArrowType-int-boolean-org.apache.arrow.vector.FieldVector-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">getConsumer</a></span>(<a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a> arrowType, |
| int columnIndex, |
| boolean nullable, |
| <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> vector, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config)</code> |
| <div class="block">Default function used for JdbcConsumerFactory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#getUtcCalendar--">getUtcCalendar</a></span>()</code> |
| <div class="block">Returns the instance of a {java.util.Calendar} with the UTC time zone and root locale.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#jdbcToArrowSchema-java.sql.ParameterMetaData-java.util.Calendar-">jdbcToArrowSchema</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ParameterMetaData.html?is-external=true" title="class or interface in java.sql">ParameterMetaData</a> parameterMetaData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar)</code> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#jdbcToArrowSchema-java.sql.ResultSetMetaData-java.util.Calendar-">jdbcToArrowSchema</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar)</code> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#jdbcToArrowSchema-java.sql.ResultSetMetaData-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">jdbcToArrowSchema</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config)</code> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#jdbcToArrowVectors-java.sql.ResultSet-org.apache.arrow.vector.VectorSchemaRoot-java.util.Calendar-">jdbcToArrowVectors</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar)</code> |
| <div class="block">Iterate the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a> object to fetch the data and transpose it to populate |
| the given Arrow Vector objects.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#jdbcToArrowVectors-java.sql.ResultSet-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">jdbcToArrowVectors</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config)</code> |
| <div class="block">Iterate the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a> object to fetch the data and transpose it to populate |
| the given Arrow Vector objects.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JdbcToArrowUtils--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JdbcToArrowUtils</h4> |
| <pre>public JdbcToArrowUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getUtcCalendar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUtcCalendar</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> getUtcCalendar()</pre> |
| <div class="block">Returns the instance of a {java.util.Calendar} with the UTC time zone and root locale.</div> |
| </li> |
| </ul> |
| <a name="jdbcToArrowSchema-java.sql.ResultSetMetaData-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcToArrowSchema</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a> jdbcToArrowSchema(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rsmd</code> - The ResultSetMetaData containing the results, to read the JDBC metadata from.</dd> |
| <dd><code>calendar</code> - The calendar to use the time zone field of, to construct Timestamp fields from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jdbcToArrowSchema-java.sql.ParameterMetaData-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcToArrowSchema</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a> jdbcToArrowSchema(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ParameterMetaData.html?is-external=true" title="class or interface in java.sql">ParameterMetaData</a> parameterMetaData, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameterMetaData</code> - The ResultSetMetaData containing the results, to read the JDBC metadata from.</dd> |
| <dd><code>calendar</code> - The calendar to use the time zone field of, to construct Timestamp fields from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getArrowTypeFromJdbcType-org.apache.arrow.adapter.jdbc.JdbcFieldInfo-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArrowTypeFromJdbcType</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a> getArrowTypeFromJdbcType(<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a> fieldInfo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar)</pre> |
| <div class="block">Converts the provided JDBC type to its respective <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo"><code>ArrowType</code></a> counterpart.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldInfo</code> - the <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> with information about the original JDBC type.</dd> |
| <dd><code>calendar</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a> to use for datetime data types.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo"><code>ArrowType</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jdbcToArrowSchema-java.sql.ResultSetMetaData-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcToArrowSchema</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a> jdbcToArrowSchema(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">Create Arrow <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a> object for the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql"><code>ResultSetMetaData</code></a>. |
| |
| <p> |
| If <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html#shouldIncludeMetadata--"><code>JdbcToArrowConfig.shouldIncludeMetadata()</code></a> returns <code>true</code>, the following fields |
| will be added to the <a href="../../../../../org/apache/arrow/vector/types/pojo/FieldType.html#getMetadata--"><code>FieldType.getMetadata()</code></a>: |
| <ul> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/Constants.html#SQL_CATALOG_NAME_KEY"><code>Constants.SQL_CATALOG_NAME_KEY</code></a> representing <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#getCatalogName-int-" title="class or interface in java.sql"><code>ResultSetMetaData.getCatalogName(int)</code></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/Constants.html#SQL_TABLE_NAME_KEY"><code>Constants.SQL_TABLE_NAME_KEY</code></a> representing <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#getTableName-int-" title="class or interface in java.sql"><code>ResultSetMetaData.getTableName(int)</code></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/Constants.html#SQL_COLUMN_NAME_KEY"><code>Constants.SQL_COLUMN_NAME_KEY</code></a> representing <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#getColumnLabel-int-" title="class or interface in java.sql"><code>ResultSetMetaData.getColumnLabel(int)</code></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/Constants.html#SQL_TYPE_KEY"><code>Constants.SQL_TYPE_KEY</code></a> representing <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#getColumnTypeName-int-" title="class or interface in java.sql"><code>ResultSetMetaData.getColumnTypeName(int)</code></a></li> |
| </ul> |
| </p> |
| <p> |
| If any columns are of type <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#ARRAY" title="class or interface in java.sql"><code>Types.ARRAY</code></a>, the configuration object will be used to look up |
| the array sub-type field. The <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html#getArraySubTypeByColumnIndex-int-"><code>JdbcToArrowConfig.getArraySubTypeByColumnIndex(int)</code></a> method will be |
| checked first, followed by the <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html#getArraySubTypeByColumnName-java.lang.String-"><code>JdbcToArrowConfig.getArraySubTypeByColumnName(String)</code></a> method. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rsmd</code> - The ResultSetMetaData containing the results, to read the JDBC metadata from.</dd> |
| <dd><code>config</code> - The configuration to use when constructing the schema.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo"><code>Schema</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>rsmd</code> contains an <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#ARRAY" title="class or interface in java.sql"><code>Types.ARRAY</code></a> but the |
| <code>config</code> does not have a sub-type definition for it.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jdbcToArrowVectors-java.sql.ResultSet-org.apache.arrow.vector.VectorSchemaRoot-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcToArrowVectors</h4> |
| <pre>public static void jdbcToArrowVectors(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> calendar) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Iterate the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a> object to fetch the data and transpose it to populate |
| the given Arrow Vector objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rs</code> - ResultSet to use to fetch the data from underlying database</dd> |
| <dd><code>root</code> - Arrow <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a> object to populate</dd> |
| <dd><code>calendar</code> - The calendar to use when reading <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Date.html?is-external=true" title="class or interface in java.sql"><code>Date</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Time.html?is-external=true" title="class or interface in java.sql"><code>Time</code></a>, or <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql"><code>Timestamp</code></a> |
| data types from the <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a>, or <code>null</code> if not converting.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jdbcToArrowVectors-java.sql.ResultSet-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jdbcToArrowVectors</h4> |
| <pre>public static void jdbcToArrowVectors(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Iterate the given JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a> object to fetch the data and transpose it to populate |
| the given Arrow Vector objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rs</code> - ResultSet to use to fetch the data from underlying database</dd> |
| <dd><code>root</code> - Arrow <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a> object to populate</dd> |
| <dd><code>config</code> - The configuration to use when reading the data.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - on error</dd> |
| <dd><code><a href="../../../../../org/apache/arrow/adapter/jdbc/consumer/exceptions/JdbcConsumerException.html" title="class in org.apache.arrow.adapter.jdbc.consumer.exceptions">JdbcConsumerException</a></code> - on error from VectorConsumer</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConsumer-org.apache.arrow.vector.types.pojo.ArrowType-int-boolean-org.apache.arrow.vector.FieldVector-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getConsumer</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a> getConsumer(<a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a> arrowType, |
| int columnIndex, |
| boolean nullable, |
| <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> vector, |
| <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> config)</pre> |
| <div class="block">Default function used for JdbcConsumerFactory. This function gets a JdbcConsumer for the |
| given column based on the Arrow type and provided vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arrowType</code> - Arrow type for the column.</dd> |
| <dd><code>columnIndex</code> - Column index to fetch from the ResultSet</dd> |
| <dd><code>nullable</code> - Whether the value is nullable or not</dd> |
| <dd><code>vector</code> - Vector to store the consumed value</dd> |
| <dd><code>config</code> - Associated JdbcToArrowConfig, used mainly for the Calendar.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer"><code>JdbcConsumer</code></a></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/JdbcToArrowUtils.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/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html" target="_top">Frames</a></li> |
| <li><a href="JdbcToArrowUtils.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
