| <!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>JdbcFieldInfo (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="JdbcFieldInfo (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}; |
| 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/JdbcFieldInfo.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/JdbcAdapterBenchmarks.RowConsumeState.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcParameterBinder.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/JdbcFieldInfo.html" target="_top">Frames</a></li> |
| <li><a href="JdbcFieldInfo.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 JdbcFieldInfo" class="title">Class JdbcFieldInfo</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.JdbcFieldInfo</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JdbcFieldInfo</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 represents the information about a JDBC ResultSet Field that is |
| needed to construct an <a href="../../../../../org/apache/arrow/vector/types/pojo/ArrowType.html" title="class in org.apache.arrow.vector.types.pojo"><code>ArrowType</code></a>. |
| Currently, this is: |
| <ul> |
| <li>The JDBC <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> type.</li> |
| <li>The nullability.</li> |
| <li>The field's precision (used for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> types).</li> |
| <li>The field's scale (used for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> types).</li> |
| </ul></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/JdbcFieldInfo.html#JdbcFieldInfo-int-">JdbcFieldInfo</a></span>(int jdbcType)</code> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> using only the <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> type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#JdbcFieldInfo-int-int-int-">JdbcFieldInfo</a></span>(int jdbcType, |
| int precision, |
| int scale)</code> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the <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> type, precision, and scale.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#JdbcFieldInfo-int-int-int-int-">JdbcFieldInfo</a></span>(int jdbcType, |
| int nullability, |
| int precision, |
| int scale)</code> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the <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> type, nullability, precision, and scale.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#JdbcFieldInfo-java.sql.ResultSet-">JdbcFieldInfo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs)</code> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the corresponding row from a <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DatabaseMetaData.html?is-external=true#getColumns-java.lang.String-java.lang.String-java.lang.String-java.lang.String-" title="class or interface in java.sql"><code>DatabaseMetaData.getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></a> |
| ResultSet.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#JdbcFieldInfo-java.sql.ResultSetMetaData-int-">JdbcFieldInfo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| int column)</code> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the corresponding <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> column.</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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#getColumn--">getColumn</a></span>()</code> |
| <div class="block">The column index for query column.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#getDisplaySize--">getDisplaySize</a></span>()</code> |
| <div class="block">The max number of characters for the column.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#getJdbcType--">getJdbcType</a></span>()</code> |
| <div class="block">The <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> type.</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/JdbcFieldInfo.html#getPrecision--">getPrecision</a></span>()</code> |
| <div class="block">The numeric precision, for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> types.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#getScale--">getScale</a></span>()</code> |
| <div class="block">The numeric scale, for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> types.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#getTypeName--">getTypeName</a></span>()</code> |
| <div class="block">The type name as reported by the database.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcFieldInfo.html#isNullable--">isNullable</a></span>()</code> |
| <div class="block">The nullability.</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="JdbcFieldInfo-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcFieldInfo</h4> |
| <pre>public JdbcFieldInfo(int jdbcType)</pre> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> using only the <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> type. Do not use this constructor |
| if the field type is <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a>; the precision and |
| scale will be set to <code>0</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jdbcType</code> - The <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> type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if jdbcType is <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JdbcFieldInfo-int-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcFieldInfo</h4> |
| <pre>public JdbcFieldInfo(int jdbcType, |
| int precision, |
| int scale)</pre> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the <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> type, precision, and scale. |
| Use this constructor for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> types.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jdbcType</code> - The <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> type.</dd> |
| <dd><code>precision</code> - The field's numeric precision.</dd> |
| <dd><code>scale</code> - The field's numeric scale.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JdbcFieldInfo-int-int-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcFieldInfo</h4> |
| <pre>public JdbcFieldInfo(int jdbcType, |
| int nullability, |
| int precision, |
| int scale)</pre> |
| <div class="block">Builds a <code>JdbcFieldInfo</code> from the <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> type, nullability, precision, and scale.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jdbcType</code> - The <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> type.</dd> |
| <dd><code>nullability</code> - The nullability. Must be one of <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#columnNoNulls" title="class or interface in java.sql"><code>ResultSetMetaData.columnNoNulls</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#columnNullable" title="class or interface in java.sql"><code>ResultSetMetaData.columnNullable</code></a>, or <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true#columnNullableUnknown" title="class or interface in java.sql"><code>ResultSetMetaData.columnNullableUnknown</code></a>.</dd> |
| <dd><code>precision</code> - The field's numeric precision.</dd> |
| <dd><code>scale</code> - The field's numeric scale.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JdbcFieldInfo-java.sql.ResultSetMetaData-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JdbcFieldInfo</h4> |
| <pre>public JdbcFieldInfo(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> rsmd, |
| int column) |
| 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">Builds a <code>JdbcFieldInfo</code> from the corresponding <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> column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rsmd</code> - The <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> to get the field information from.</dd> |
| <dd><code>column</code> - The column to get the field information for (on a 1-based index).</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 the column information cannot be retrieved.</dd> |
| <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>rsmd</code> is <code>null</code>.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>column</code> is out of bounds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="JdbcFieldInfo-java.sql.ResultSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JdbcFieldInfo</h4> |
| <pre>public JdbcFieldInfo(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs) |
| 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">Builds a <code>JdbcFieldInfo</code> from the corresponding row from a <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DatabaseMetaData.html?is-external=true#getColumns-java.lang.String-java.lang.String-java.lang.String-java.lang.String-" title="class or interface in java.sql"><code>DatabaseMetaData.getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></a> |
| ResultSet.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rs</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a> to get the field information from.</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 the column information cannot be retrieved.</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="getJdbcType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJdbcType</h4> |
| <pre>public int getJdbcType()</pre> |
| <div class="block">The <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> type.</div> |
| </li> |
| </ul> |
| <a name="isNullable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNullable</h4> |
| <pre>public int isNullable()</pre> |
| <div class="block">The nullability.</div> |
| </li> |
| </ul> |
| <a name="getPrecision--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecision</h4> |
| <pre>public int getPrecision()</pre> |
| <div class="block">The numeric precision, for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> types.</div> |
| </li> |
| </ul> |
| <a name="getScale--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScale</h4> |
| <pre>public int getScale()</pre> |
| <div class="block">The numeric scale, for <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#NUMERIC" title="class or interface in java.sql"><code>Types.NUMERIC</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#DECIMAL" title="class or interface in java.sql"><code>Types.DECIMAL</code></a> types.</div> |
| </li> |
| </ul> |
| <a name="getColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumn</h4> |
| <pre>public int getColumn()</pre> |
| <div class="block">The column index for query column.</div> |
| </li> |
| </ul> |
| <a name="getTypeName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeName</h4> |
| <pre>public <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> getTypeName()</pre> |
| <div class="block">The type name as reported by the database.</div> |
| </li> |
| </ul> |
| <a name="getDisplaySize--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDisplaySize</h4> |
| <pre>public int getDisplaySize()</pre> |
| <div class="block">The max number of characters for the column.</div> |
| </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/JdbcFieldInfo.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/JdbcAdapterBenchmarks.RowConsumeState.html" title="class in org.apache.arrow.adapter.jdbc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/adapter/jdbc/JdbcParameterBinder.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/JdbcFieldInfo.html" target="_top">Frames</a></li> |
| <li><a href="JdbcFieldInfo.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> |
