Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / adapter / jdbc / class-use / JdbcToArrowConfigBuilder.html
blob: 7f3acf9a34110031e71ba6264e5d037040701274 [file] [log] [blame]
<!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>Uses of Class org.apache.arrow.adapter.jdbc.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="Uses of Class org.apache.arrow.adapter.jdbc.JdbcToArrowConfigBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../../overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/class-use/JdbcToArrowConfigBuilder.html" target="_top">Frames</a></li>
<li><a href="JdbcToArrowConfigBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.arrow.adapter.jdbc.JdbcToArrowConfigBuilder" class="title">Uses of Class<br>org.apache.arrow.adapter.jdbc.JdbcToArrowConfigBuilder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.arrow.adapter.jdbc">org.apache.arrow.adapter.jdbc</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.arrow.adapter.jdbc">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a> in <a href="../../../../../../org/apache/arrow/adapter/jdbc/package-summary.html">org.apache.arrow.adapter.jdbc</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/apache/arrow/adapter/jdbc/package-summary.html">org.apache.arrow.adapter.jdbc</a> that return <a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfigBuilder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&nbsp;allocator)</code>
<div class="block">Sets the memory allocator to use when constructing the Arrow vectors from the ResultSet.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&lt;<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>&gt;&gt;&nbsp;columnMetadataByColumnIndex)</code>
<div class="block">Set metadata from columnIndex->meta map on per field basis.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setIncludeMetadata-boolean-">setIncludeMetadata</a></span>(boolean&nbsp;includeMetadata)</code>
<div class="block">Sets whether to include JDBC ResultSet field metadata in the Arrow Schema field metadata.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&nbsp;jdbcConsumerGetter)</code>
<div class="block">Set the function used to get a JDBC consumer for a given type.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;jdbcToArrowTypeConverter)</code>
<div class="block">Set the function used to convert JDBC types to Arrow types.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setReuseVectorSchemaRoot-boolean-">setReuseVectorSchemaRoot</a></span>(boolean&nbsp;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 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>&lt;<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>&gt;&nbsp;schemaMetadata)</code>
<div class="block">Set metadata for schema.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html#setTargetBatchSize-int-">setTargetBatchSize</a></span>(int&nbsp;targetBatchSize)</code>
<div class="block">Set the target number of rows to convert at once.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfigBuilder.html" title="class in org.apache.arrow.adapter.jdbc">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../../overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/class-use/JdbcToArrowConfigBuilder.html" target="_top">Frames</a></li>
<li><a href="JdbcToArrowConfigBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>