Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / adapter / jdbc / binder / ColumnBinder.html
blob: 0f373d057369b50c0b449802145a5b5e7772056b [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>ColumnBinder (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="ColumnBinder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":17,"i2":17,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/ColumnBinder.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/binder/BitBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinderArrowTypeVisitor.html" title="class in org.apache.arrow.adapter.jdbc.binder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" target="_top">Frames</a></li>
<li><a href="ColumnBinder.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.binder</div>
<h2 title="Interface ColumnBinder" class="title">Interface ColumnBinder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/BaseColumnBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">BaseColumnBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/BigIntBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">BigIntBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/BitBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">BitBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/DateDayBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">DateDayBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/DateMilliBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">DateMilliBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Decimal128Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Decimal128Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Decimal256Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Decimal256Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/FixedSizeBinaryBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">FixedSizeBinaryBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Float4Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Float4Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Float8Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Float8Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/IntBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">IntBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ListBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">ListBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/MapBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">MapBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/NullableColumnBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">NullableColumnBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/SmallIntBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">SmallIntBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Time32Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Time32Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/Time64Binder.html" title="class in org.apache.arrow.adapter.jdbc.binder">Time64Binder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/TimeStampBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">TimeStampBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/TinyIntBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">TinyIntBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/VarBinaryBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">VarBinaryBinder</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/VarCharBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder">VarCharBinder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ColumnBinder</span></pre>
<div class="block">A helper to bind values from a wrapped Arrow vector to a JDBC PreparedStatement.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html#bind-java.sql.PreparedStatement-int-int-">bind</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a>&nbsp;statement,
int&nbsp;parameterIndex,
int&nbsp;rowIndex)</code>
<div class="block">Bind the given row to the given parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" title="interface in org.apache.arrow.adapter.jdbc.binder">ColumnBinder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html#forVector-org.apache.arrow.vector.FieldVector-">forVector</a></span>(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector)</code>
<div class="block">Create a column binder for a vector, using the default JDBC type code for null values.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" title="interface in org.apache.arrow.adapter.jdbc.binder">ColumnBinder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html#forVector-org.apache.arrow.vector.FieldVector-java.lang.Integer-">forVector</a></span>(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector,
<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>&nbsp;jdbcType)</code>
<div class="block">Create a column binder for a vector, overriding the JDBC type code used for null values.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html#getJdbcType--">getJdbcType</a></span>()</code>
<div class="block">Get the JDBC type code used by this binder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html#getVector--">getVector</a></span>()</code>
<div class="block">Get the vector used by this binder.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="bind-java.sql.PreparedStatement-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bind</h4>
<pre>void&nbsp;bind(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a>&nbsp;statement,
int&nbsp;parameterIndex,
int&nbsp;rowIndex)
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">Bind the given row to the given parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statement</code> - The statement to bind to.</dd>
<dd><code>parameterIndex</code> - The parameter to bind to (1-indexed)</dd>
<dd><code>rowIndex</code> - The row to bind values from (0-indexed)</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> - if an error occurs</dd>
</dl>
</li>
</ul>
<a name="getJdbcType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJdbcType</h4>
<pre>int&nbsp;getJdbcType()</pre>
<div class="block">Get the JDBC type code used by this binder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A type code from <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true" title="class or interface in java.sql"><code>Types</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getVector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVector</h4>
<pre><a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;getVector()</pre>
<div class="block">Get the vector used by this binder.</div>
</li>
</ul>
<a name="forVector-org.apache.arrow.vector.FieldVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forVector</h4>
<pre>static&nbsp;<a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" title="interface in org.apache.arrow.adapter.jdbc.binder">ColumnBinder</a>&nbsp;forVector(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector)</pre>
<div class="block">Create a column binder for a vector, using the default JDBC type code for null values.</div>
</li>
</ul>
<a name="forVector-org.apache.arrow.vector.FieldVector-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>forVector</h4>
<pre>static&nbsp;<a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" title="interface in org.apache.arrow.adapter.jdbc.binder">ColumnBinder</a>&nbsp;forVector(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector,
<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>&nbsp;jdbcType)</pre>
<div class="block">Create a column binder for a vector, overriding the JDBC type code used for null values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vector</code> - The vector that the column binder will wrap.</dd>
<dd><code>jdbcType</code> - The JDBC type code to use (or null to use the default).</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/ColumnBinder.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/binder/BitBinder.html" title="class in org.apache.arrow.adapter.jdbc.binder"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/arrow/adapter/jdbc/binder/ColumnBinderArrowTypeVisitor.html" title="class in org.apache.arrow.adapter.jdbc.binder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/binder/ColumnBinder.html" target="_top">Frames</a></li>
<li><a href="ColumnBinder.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>