org.apache.arrow.adapter.jdbc

Class JdbcFieldInfo

java.lang.Object

org.apache.arrow.adapter.jdbc.JdbcFieldInfo

public class JdbcFieldInfo
extends Object

This class represents the information about a JDBC ResultSet Field that is needed to construct an ArrowType. Currently, this is:

• The JDBC Types type.
• The nullability.
• The field's precision (used for Types.DECIMAL and Types.NUMERIC types).
• The field's scale (used for Types.DECIMAL and Types.NUMERIC types).

Constructor Summary

Constructors

Constructor and Description
JdbcFieldInfo(int jdbcType) Builds a JdbcFieldInfo using only the Types type.
JdbcFieldInfo(int jdbcType, int precision, int scale) Builds a JdbcFieldInfo from the Types type, precision, and scale.
JdbcFieldInfo(int jdbcType, int nullability, int precision, int scale) Builds a JdbcFieldInfo from the Types type, nullability, precision, and scale.
JdbcFieldInfo(ResultSet rs) Builds a JdbcFieldInfo from the corresponding row from a DatabaseMetaData.getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) ResultSet.
JdbcFieldInfo(ResultSetMetaData rsmd, int column) Builds a JdbcFieldInfo from the corresponding ResultSetMetaData column.

Method Summary

Modifier and Type	Method and Description
int	getColumn() The column index for query column.
int	getDisplaySize() The max number of characters for the column.
int	getJdbcType() The Types type.
int	getPrecision() The numeric precision, for Types.NUMERIC and Types.DECIMAL types.
int	getScale() The numeric scale, for Types.NUMERIC and Types.DECIMAL types.
String	getTypeName() The type name as reported by the database.
int	isNullable() The nullability.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JdbcFieldInfo

public JdbcFieldInfo(int jdbcType)

Builds a JdbcFieldInfo using only the Types type. Do not use this constructor if the field type is Types.DECIMAL or Types.NUMERIC; the precision and scale will be set to 0.

Parameters:

jdbcType - The Types type.

Throws:

IllegalArgumentException - if jdbcType is Types.DECIMAL or Types.NUMERIC.

JdbcFieldInfo

public JdbcFieldInfo(int jdbcType,
                     int precision,
                     int scale)

Builds a JdbcFieldInfo from the Types type, precision, and scale. Use this constructor for Types.DECIMAL and Types.NUMERIC types.

Parameters:

jdbcType - The Types type.

precision - The field's numeric precision.

scale - The field's numeric scale.

JdbcFieldInfo

public JdbcFieldInfo(int jdbcType,
                     int nullability,
                     int precision,
                     int scale)

Builds a JdbcFieldInfo from the Types type, nullability, precision, and scale.

Parameters:

jdbcType - The Types type.

nullability - The nullability. Must be one of ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown.

precision - The field's numeric precision.

scale - The field's numeric scale.

JdbcFieldInfo

public JdbcFieldInfo(ResultSetMetaData rsmd,
                     int column)
              throws SQLException

Builds a JdbcFieldInfo from the corresponding ResultSetMetaData column.

Parameters:

rsmd - The ResultSetMetaData to get the field information from.

column - The column to get the field information for (on a 1-based index).

Throws:

SQLException - If the column information cannot be retrieved.

NullPointerException - if rsmd is null.

IllegalArgumentException - if column is out of bounds.

JdbcFieldInfo

public JdbcFieldInfo(ResultSet rs)
              throws SQLException

Builds a JdbcFieldInfo from the corresponding row from a DatabaseMetaData.getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String) ResultSet.

Parameters:

rs - The ResultSet to get the field information from.

Throws:

SQLException - If the column information cannot be retrieved.

Method Detail

getJdbcType

public int getJdbcType()

The Types type.

isNullable

public int isNullable()

The nullability.

getPrecision

public int getPrecision()

The numeric precision, for Types.NUMERIC and Types.DECIMAL types.

getScale

public int getScale()

The numeric scale, for Types.NUMERIC and Types.DECIMAL types.

getColumn

public int getColumn()

The column index for query column.

getTypeName

public String getTypeName()

The type name as reported by the database.

getDisplaySize

public int getDisplaySize()

The max number of characters for the column.