Module org.itsallcode.jdbc

Package org.itsallcode.jdbc.metadata

Record Class ColumnMetaData

java.lang.Object

java.lang.Record

org.itsallcode.jdbc.metadata.ColumnMetaData

Record Components:

tableCatalog - table catalog (may be null)

tableSchema - table schema (may be null)

tableName - table name

columnName - column name

dataType - SQL type

typeName - Data source dependent type name, for a UDT the type name is fully qualified

columnSize - column size.

decimalDigits - the number of fractional digits. null is returned for data types where DECIMAL_DIGITS is not applicable.

numPrecisionRadix - Radix (typically either 10 or 2)

nullable - is NULL allowed.

remarks - comment describing column (may be null)

columnDef - default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (may be null)

charOctetLength - for char types the maximum number of bytes in the column

ordinalPosition - index of column in table (starting at 1)

isNullable - ISO rules are used to determine the nullability for a column.

scopeCatalog - catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF)

scopeSchema - schema of table that is the scope of a reference attribute (null if the DATA_TYPE isn't REF)

scopeTable - table name that this the scope of a reference attribute (null if the DATA_TYPE isn't REF)

sourceDataType - source type of a distinct type or user-generated Ref type, SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF)

isAutoIncrement - Indicates whether this column is auto incremented

isGeneratedColumn - Indicates whether this is a generated column

public record ColumnMetaData(String tableCatalog, String tableSchema, String tableName, String columnName, JDBCType dataType, String typeName, int columnSize, int decimalDigits, int numPrecisionRadix, ColumnMetaData.Nullability nullable, String remarks, String columnDef, int charOctetLength, int ordinalPosition, ColumnMetaData.ISONullability isNullable, String scopeCatalog, String scopeSchema, String scopeTable, short sourceDataType, ColumnMetaData.AutoIncrement isAutoIncrement, ColumnMetaData.Generated isGeneratedColumn)
extends Record

Description of a column.

See Also:

• DatabaseMetaData.getColumns(String, String, String, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColumnMetaData.AutoIncrement	Indicates whether a column is auto incremented.
static enum	ColumnMetaData.Generated	Indicates whether this is a generated column.
static enum	ColumnMetaData.ISONullability	Column ISO nullability.
static enum	ColumnMetaData.Nullability	Column nullability.

Constructor Summary

Constructors

Constructor

Description

ColumnMetaData(String tableCatalog, String tableSchema, String tableName, String columnName, JDBCType dataType, String typeName, int columnSize, int decimalDigits, int numPrecisionRadix, ColumnMetaData.Nullability nullable, String remarks, String columnDef, int charOctetLength, int ordinalPosition, ColumnMetaData.ISONullability isNullable, String scopeCatalog, String scopeSchema, String scopeTable, short sourceDataType, ColumnMetaData.AutoIncrement isAutoIncrement, ColumnMetaData.Generated isGeneratedColumn)

Creates an instance of a ColumnMetaData record class.

Method Summary

Modifier and Type	Method	Description
int	charOctetLength()	Returns the value of the charOctetLength record component.
String	columnDef()	Returns the value of the columnDef record component.
String	columnName()	Returns the value of the columnName record component.
int	columnSize()	Returns the value of the columnSize record component.
JDBCType	dataType()	Returns the value of the dataType record component.
int	decimalDigits()	Returns the value of the decimalDigits record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ColumnMetaData.AutoIncrement	isAutoIncrement()	Returns the value of the isAutoIncrement record component.
ColumnMetaData.Generated	isGeneratedColumn()	Returns the value of the isGeneratedColumn record component.
ColumnMetaData.ISONullability	isNullable()	Returns the value of the isNullable record component.
ColumnMetaData.Nullability	nullable()	Returns the value of the nullable record component.
int	numPrecisionRadix()	Returns the value of the numPrecisionRadix record component.
int	ordinalPosition()	Returns the value of the ordinalPosition record component.
String	remarks()	Returns the value of the remarks record component.
String	scopeCatalog()	Returns the value of the scopeCatalog record component.
String	scopeSchema()	Returns the value of the scopeSchema record component.
String	scopeTable()	Returns the value of the scopeTable record component.
short	sourceDataType()	Returns the value of the sourceDataType record component.
String	tableCatalog()	Returns the value of the tableCatalog record component.
String	tableName()	Returns the value of the tableName record component.
String	tableSchema()	Returns the value of the tableSchema record component.
final String	toString()	Returns a string representation of this record class.
String	typeName()	Returns the value of the typeName record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ColumnMetaData

public ColumnMetaData(String tableCatalog,
 String tableSchema,
 String tableName,
 String columnName,
 JDBCType dataType,
 String typeName,
 int columnSize,
 int decimalDigits,
 int numPrecisionRadix,
 ColumnMetaData.Nullability nullable,
 String remarks,
 String columnDef,
 int charOctetLength,
 int ordinalPosition,
 ColumnMetaData.ISONullability isNullable,
 String scopeCatalog,
 String scopeSchema,
 String scopeTable,
 short sourceDataType,
 ColumnMetaData.AutoIncrement isAutoIncrement,
 ColumnMetaData.Generated isGeneratedColumn)

Creates an instance of a ColumnMetaData record class.

Parameters:

tableCatalog - the value for the tableCatalog record component

tableSchema - the value for the tableSchema record component

tableName - the value for the tableName record component

columnName - the value for the columnName record component

dataType - the value for the dataType record component

typeName - the value for the typeName record component

columnSize - the value for the columnSize record component

decimalDigits - the value for the decimalDigits record component

numPrecisionRadix - the value for the numPrecisionRadix record component

nullable - the value for the nullable record component

remarks - the value for the remarks record component

columnDef - the value for the columnDef record component

charOctetLength - the value for the charOctetLength record component

ordinalPosition - the value for the ordinalPosition record component

isNullable - the value for the isNullable record component

scopeCatalog - the value for the scopeCatalog record component

scopeSchema - the value for the scopeSchema record component

scopeTable - the value for the scopeTable record component

sourceDataType - the value for the sourceDataType record component

isAutoIncrement - the value for the isAutoIncrement record component

isGeneratedColumn - the value for the isGeneratedColumn record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

tableCatalog

public String tableCatalog()

Returns the value of the tableCatalog record component.

Returns:

the value of the tableCatalog record component

tableSchema

public String tableSchema()

Returns the value of the tableSchema record component.

Returns:

the value of the tableSchema record component

tableName

public String tableName()

Returns the value of the tableName record component.

Returns:

the value of the tableName record component

columnName

public String columnName()

Returns the value of the columnName record component.

Returns:

the value of the columnName record component

dataType

public JDBCType dataType()

Returns the value of the dataType record component.

Returns:

the value of the dataType record component

typeName

public String typeName()

Returns the value of the typeName record component.

Returns:

the value of the typeName record component

columnSize

public int columnSize()

Returns the value of the columnSize record component.

Returns:

the value of the columnSize record component

decimalDigits

public int decimalDigits()

Returns the value of the decimalDigits record component.

Returns:

the value of the decimalDigits record component

numPrecisionRadix

public int numPrecisionRadix()

Returns the value of the numPrecisionRadix record component.

Returns:

the value of the numPrecisionRadix record component

nullable

public ColumnMetaData.Nullability nullable()

Returns the value of the nullable record component.

Returns:

the value of the nullable record component

remarks

public String remarks()

Returns the value of the remarks record component.

Returns:

the value of the remarks record component

columnDef

public String columnDef()

Returns the value of the columnDef record component.

Returns:

the value of the columnDef record component

charOctetLength

public int charOctetLength()

Returns the value of the charOctetLength record component.

Returns:

the value of the charOctetLength record component

ordinalPosition

public int ordinalPosition()

Returns the value of the ordinalPosition record component.

Returns:

the value of the ordinalPosition record component

isNullable

public ColumnMetaData.ISONullability isNullable()

Returns the value of the isNullable record component.

Returns:

the value of the isNullable record component

scopeCatalog

public String scopeCatalog()

Returns the value of the scopeCatalog record component.

Returns:

the value of the scopeCatalog record component

scopeSchema

public String scopeSchema()

Returns the value of the scopeSchema record component.

Returns:

the value of the scopeSchema record component

scopeTable

public String scopeTable()

Returns the value of the scopeTable record component.

Returns:

the value of the scopeTable record component

sourceDataType

public short sourceDataType()

Returns the value of the sourceDataType record component.

Returns:

the value of the sourceDataType record component

isAutoIncrement

public ColumnMetaData.AutoIncrement isAutoIncrement()

Returns the value of the isAutoIncrement record component.

Returns:

the value of the isAutoIncrement record component

isGeneratedColumn

public ColumnMetaData.Generated isGeneratedColumn()

Returns the value of the isGeneratedColumn record component.

Returns:

the value of the isGeneratedColumn record component