| <!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>JdbcToArrowConfigBuilder (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="JdbcToArrowConfigBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JdbcToArrowConfigBuilder.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/JdbcToArrowConfig.JdbcConsumerFactory.html" title="interface in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" target="_top">Frames</a></li> |
| <li><a href="JdbcToArrowConfigBuilder.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 JdbcToArrowConfigBuilder" class="title">Class JdbcToArrowConfigBuilder</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.JdbcToArrowConfigBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JdbcToArrowConfigBuilder</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">This class builds <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcToArrowConfig</code></a>s.</div> |
| </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/JdbcToArrowConfigBuilder.html#JdbcToArrowConfigBuilder--">JdbcToArrowConfigBuilder</a></span>()</code> |
| <div class="block">Default constructor for the <code>JdbcToArrowConfigBuilder}</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#JdbcToArrowConfigBuilder-org.apache.arrow.memory.BufferAllocator-java.util.Calendar-">JdbcToArrowConfigBuilder</a></span>(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <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">Constructor for the <code>JdbcToArrowConfigBuilder</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#JdbcToArrowConfigBuilder-org.apache.arrow.memory.BufferAllocator-java.util.Calendar-boolean-">JdbcToArrowConfigBuilder</a></span>(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <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, |
| boolean includeMetadata)</code> |
| <div class="block">Constructor for the <code>JdbcToArrowConfigBuilder</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#build--">build</a></span>()</code> |
| <div class="block">This builds the <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcToArrowConfig</code></a> from the provided |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory"><code>BufferAllocator</code></a> and <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>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setAllocator-org.apache.arrow.memory.BufferAllocator-">setAllocator</a></span>(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">Sets the memory allocator to use when constructing the Arrow vectors from the ResultSet.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setArraySubTypeByColumnIndexMap-java.util.Map-">setArraySubTypeByColumnIndexMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</code> |
| <div class="block">Sets the mapping of column-index-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for columns 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>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setArraySubTypeByColumnNameMap-java.util.Map-">setArraySubTypeByColumnNameMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</code> |
| <div class="block">Sets the mapping of column-name-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for columns 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>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setBigDecimalRoundingMode-java.math.RoundingMode-">setBigDecimalRoundingMode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a> bigDecimalRoundingMode)</code> |
| <div class="block">Set the rounding mode used when the scale of the actual value does not match the declared scale.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setCalendar-java.util.Calendar-">setCalendar</a></span>(<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">Sets 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 when constructing timestamp fields in the |
| Arrow schema, and reading time-based fields from the JDBC <code>ResultSet</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setColumnMetadataByColumnIndex-java.util.Map-">setColumnMetadataByColumnIndex</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> columnMetadataByColumnIndex)</code> |
| <div class="block">Set metadata from columnIndex->meta map on per field basis.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setExplicitTypesByColumnIndex-java.util.Map-">setExplicitTypesByColumnIndex</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</code> |
| <div class="block">Sets the mapping of column-index-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for column types.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setExplicitTypesByColumnName-java.util.Map-">setExplicitTypesByColumnName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</code> |
| <div class="block">Sets the mapping of column-name-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for column types.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setIncludeMetadata-boolean-">setIncludeMetadata</a></span>(boolean includeMetadata)</code> |
| <div class="block">Sets whether to include JDBC ResultSet field metadata in the Arrow Schema field metadata.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setJdbcConsumerGetter-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig.JdbcConsumerFactory-">setJdbcConsumerGetter</a></span>(<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.JdbcConsumerFactory.html" title="interface in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig.JdbcConsumerFactory</a> jdbcConsumerGetter)</code> |
| <div class="block">Set the function used to get a JDBC consumer for a given type.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setJdbcToArrowTypeConverter-java.util.function.Function-">setJdbcToArrowTypeConverter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>,<a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a>> jdbcToArrowTypeConverter)</code> |
| <div class="block">Set the function used to convert JDBC types to Arrow types.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setReuseVectorSchemaRoot-boolean-">setReuseVectorSchemaRoot</a></span>(boolean reuseVectorSchemaRoot)</code> |
| <div class="block">Set whether to use the same <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a> instance on each iteration, |
| or to allocate a new one.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setSchemaMetadata-java.util.Map-">setSchemaMetadata</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> schemaMetadata)</code> |
| <div class="block">Set metadata for schema.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setTargetBatchSize-int-">setTargetBatchSize</a></span>(int targetBatchSize)</code> |
| <div class="block">Set the target number of rows to convert at once.</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="JdbcToArrowConfigBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcToArrowConfigBuilder</h4> |
| <pre>public JdbcToArrowConfigBuilder()</pre> |
| <div class="block">Default constructor for the <code>JdbcToArrowConfigBuilder}</code>. |
| Use the setter methods for the allocator and calendar; the allocator must be |
| set. Otherwise, <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#build--"><code>build()</code></a> will throw a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>.</div> |
| </li> |
| </ul> |
| <a name="JdbcToArrowConfigBuilder-org.apache.arrow.memory.BufferAllocator-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcToArrowConfigBuilder</h4> |
| <pre>public JdbcToArrowConfigBuilder(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <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">Constructor for the <code>JdbcToArrowConfigBuilder</code>. The |
| allocator is required, and a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> |
| will be thrown if it is <code>null</code>. |
| <p> |
| The allocator is used to construct Arrow vectors from the JDBC ResultSet. |
| The calendar is used to determine the time zone of <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> |
| fields and convert <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>, and |
| <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> fields to a single, common time zone when reading |
| from the result set. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - The Arrow Vector memory allocator.</dd> |
| <dd><code>calendar</code> - The calendar to use when constructing timestamp fields.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JdbcToArrowConfigBuilder-org.apache.arrow.memory.BufferAllocator-java.util.Calendar-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JdbcToArrowConfigBuilder</h4> |
| <pre>public JdbcToArrowConfigBuilder(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <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, |
| boolean includeMetadata)</pre> |
| <div class="block">Constructor for the <code>JdbcToArrowConfigBuilder</code>. Both the |
| allocator and calendar are required. A <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> |
| will be thrown if either of those arguments is <code>null</code>. |
| <p> |
| The allocator is used to construct Arrow vectors from the JDBC ResultSet. |
| The calendar is used to determine the time zone of <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> |
| fields and convert <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>, and |
| <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> fields to a single, common time zone when reading |
| from the result set. |
| </p> |
| <p> |
| The <code>includeMetadata</code> argument, if <code>true</code> will cause |
| various information about each database field to be added to the Vector |
| Schema's field metadata. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - The Arrow Vector memory allocator.</dd> |
| <dd><code>calendar</code> - The calendar to use when constructing timestamp fields.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setAllocator-org.apache.arrow.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllocator</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setAllocator(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block">Sets the memory allocator to use when constructing the Arrow vectors from the ResultSet.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - the allocator to set.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>allocator</code> is null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCalendar-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCalendar</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setCalendar(<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">Sets 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 when constructing timestamp fields in the |
| Arrow schema, and reading time-based fields from the JDBC <code>ResultSet</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>calendar</code> - the calendar to set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIncludeMetadata-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludeMetadata</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setIncludeMetadata(boolean includeMetadata)</pre> |
| <div class="block">Sets whether to include JDBC ResultSet field metadata in the Arrow Schema field metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>includeMetadata</code> - Whether to include or exclude JDBC metadata in the Arrow Schema field metadata.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance of the <code>JdbcToArrowConfig</code>, for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setArraySubTypeByColumnIndexMap-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArraySubTypeByColumnIndexMap</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setArraySubTypeByColumnIndexMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</pre> |
| <div class="block">Sets the mapping of column-index-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for columns 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 column index is 1-based, to match the JDBC column index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - The mapping.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance of the <code>JdbcToArrowConfig</code>, for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setArraySubTypeByColumnNameMap-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArraySubTypeByColumnNameMap</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setArraySubTypeByColumnNameMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</pre> |
| <div class="block">Sets the mapping of column-name-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for columns 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>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - The mapping.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This instance of the <code>JdbcToArrowConfig</code>, for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplicitTypesByColumnIndex-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplicitTypesByColumnIndex</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setExplicitTypesByColumnIndex(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</pre> |
| <div class="block">Sets the mapping of column-index-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for column types. |
| <p> |
| This can be useful to override type information from JDBC drivers that provide incomplete type info, |
| e.g. DECIMAL with precision = scale = 0. |
| <p> |
| The column index is 1-based, to match the JDBC column index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - The mapping.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplicitTypesByColumnName-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplicitTypesByColumnName</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setExplicitTypesByColumnName(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>> map)</pre> |
| <div class="block">Sets the mapping of column-name-to-<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcFieldInfo</code></a> used for column types. |
| <p> |
| This can be useful to override type information from JDBC drivers that provide incomplete type info, |
| e.g. DECIMAL with precision = scale = 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - The mapping.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTargetBatchSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTargetBatchSize</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setTargetBatchSize(int targetBatchSize)</pre> |
| <div class="block">Set the target number of rows to convert at once. |
| <p> |
| Use <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html#NO_LIMIT_BATCH_SIZE"><code>JdbcToArrowConfig.NO_LIMIT_BATCH_SIZE</code></a> to read all rows at once.</div> |
| </li> |
| </ul> |
| <a name="setJdbcToArrowTypeConverter-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJdbcToArrowTypeConverter</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setJdbcToArrowTypeConverter(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html" title="class in org.apache.arrow.adapter.jdbc">JdbcFieldInfo</a>,<a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a>> jdbcToArrowTypeConverter)</pre> |
| <div class="block">Set the function used to convert JDBC types to Arrow types. |
| <p> |
| Defaults to wrapping <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html#getArrowTypeFromJdbcType-org.apache.arrow.adapter.jdbc.JdbcFieldInfo-java.util.Calendar-"><code>JdbcToArrowUtils.getArrowTypeFromJdbcType(JdbcFieldInfo, Calendar)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setJdbcConsumerGetter-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig.JdbcConsumerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJdbcConsumerGetter</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setJdbcConsumerGetter(<a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.JdbcConsumerFactory.html" title="interface in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig.JdbcConsumerFactory</a> jdbcConsumerGetter)</pre> |
| <div class="block">Set the function used to get a JDBC consumer for a given type. |
| <p> |
| Defaults to wrapping <code>JdbcToArrowUtils#getConsumer(ArrowType, Integer, Boolean, FieldVector, JdbcToArrowConfig)</code>.</div> |
| </li> |
| </ul> |
| <a name="setReuseVectorSchemaRoot-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReuseVectorSchemaRoot</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setReuseVectorSchemaRoot(boolean reuseVectorSchemaRoot)</pre> |
| <div class="block">Set whether to use the same <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a> instance on each iteration, |
| or to allocate a new one.</div> |
| </li> |
| </ul> |
| <a name="setSchemaMetadata-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaMetadata</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setSchemaMetadata(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> schemaMetadata)</pre> |
| <div class="block">Set metadata for schema.</div> |
| </li> |
| </ul> |
| <a name="setColumnMetadataByColumnIndex-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumnMetadataByColumnIndex</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setColumnMetadataByColumnIndex(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> columnMetadataByColumnIndex)</pre> |
| <div class="block">Set metadata from columnIndex->meta map on per field basis.</div> |
| </li> |
| </ul> |
| <a name="setBigDecimalRoundingMode-java.math.RoundingMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBigDecimalRoundingMode</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> setBigDecimalRoundingMode(<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a> bigDecimalRoundingMode)</pre> |
| <div class="block">Set the rounding mode used when the scale of the actual value does not match the declared scale. |
| <p> |
| By default, an error is raised in such cases.</div> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a> build()</pre> |
| <div class="block">This builds the <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcToArrowConfig</code></a> from the provided |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory"><code>BufferAllocator</code></a> and <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>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The built <a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc"><code>JdbcToArrowConfig</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either the allocator or calendar was not set.</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/JdbcToArrowConfigBuilder.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/JdbcToArrowConfig.JdbcConsumerFactory.html" title="interface in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowUtils.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" target="_top">Frames</a></li> |
| <li><a href="JdbcToArrowConfigBuilder.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> |
