Google Git
Sign in
apache / arrow-site / asf-site / . / docs / dev / java / reference / org / apache / arrow / adapter / jdbc / class-use / JdbcToArrowConfig.html
blob: 2511e305b345d4b63a289aa49bdc8b8b3a2eb932 [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.JdbcToArrowConfig (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.JdbcToArrowConfig (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/JdbcToArrowConfig.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/JdbcToArrowConfig.html" target="_top">Frames</a></li>
<li><a href="JdbcToArrowConfig.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.JdbcToArrowConfig" class="title">Uses of Class<br>org.apache.arrow.adapter.jdbc.JdbcToArrowConfig</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/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</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/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</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/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</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/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a></code></td>
<td class="colLast"><span class="typeNameLabel">JdbcToArrowConfigBuilder.</span><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>
</tbody>
</table>
<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> with parameters of type <a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</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/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a></code></td>
<td class="colLast"><span class="typeNameLabel">JdbcToArrowConfig.JdbcConsumerFactory.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.JdbcConsumerFactory.html#apply-org.apache.arrow.vector.types.pojo.ArrowType-int-boolean-org.apache.arrow.vector.FieldVector-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">apply</a></span>(<a href="../../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo">ArrowType</a>&nbsp;arrowType,
int&nbsp;columnIndex,
boolean&nbsp;nullable,
<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/adapter/jdbc/ArrowVectorIterator.html" title="class in org.apache.arrow.adapter.jdbc">ArrowVectorIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">ArrowVectorIterator.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/ArrowVectorIterator.html#create-java.sql.ResultSet-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">create</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>&nbsp;resultSet,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;config)</code>
<div class="block">Create a ArrowVectorIterator to partially convert data.</div>
</td>
</tr>
<tr class="altColor">
<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"><span class="typeNameLabel">JdbcToArrowUtils.</span><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>&nbsp;arrowType,
int&nbsp;columnIndex,
boolean&nbsp;nullable,
<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;config)</code>
<div class="block">Default function used for JdbcConsumerFactory.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">JdbcToArrowUtils.</span><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>&nbsp;rsmd,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;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 class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">JdbcToArrowUtils.</span><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>&nbsp;rs,
<a href="../../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;root,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;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>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/adapter/jdbc/ArrowVectorIterator.html" title="class in org.apache.arrow.adapter.jdbc">ArrowVectorIterator</a></code></td>
<td class="colLast"><span class="typeNameLabel">JdbcToArrow.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrow.html#sqlToArrowVectorIterator-java.sql.ResultSet-org.apache.arrow.adapter.jdbc.JdbcToArrowConfig-">sqlToArrowVectorIterator</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>&nbsp;resultSet,
<a href="../../../../../../org/apache/arrow/adapter/jdbc/JdbcToArrowConfig.html" title="class in org.apache.arrow.adapter.jdbc">JdbcToArrowConfig</a>&nbsp;config)</code>
<div class="block">For 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>, fetch the data from Relational DB and convert it to Arrow objects.</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/JdbcToArrowConfig.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/JdbcToArrowConfig.html" target="_top">Frames</a></li>
<li><a href="JdbcToArrowConfig.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>