dataframe-jdbc/org.jetbrains.kotlinx.dataframe.io.db/TableColumnMetadata

TableColumnMetadata

class TableColumnMetadata(val name: String, val sqlTypeName: String, val jdbcType: Int, val size: Int, val javaClassName: String, val isNullable: Boolean = false)

Represents a column in a database table to keep all required meta-information.

Constructors

TableColumnMetadata

constructor(name: String, sqlTypeName: String, jdbcType: Int, size: Int, javaClassName: String, isNullable: Boolean = false)

Properties

isMultiBit

internal val TableColumnMetadata.isMultiBit: Boolean

true for a multi-bit BIT(M) column, M > 1, in MySQL and MariaDB.

isNullable

val isNullable: Boolean

true if column could contain nulls.

javaClassName

val javaClassName: String

the class name in Java.

jdbcType

val jdbcType: Int

the JDBC data type of the column produced from java.sql.Types.

name

val name: String

the name of the DataFrame column: the SQL AS alias, or the column name when there is no alias, made unique within the result (see DbType.getTableColumnsMetadata).

size

val size: Int

the declared width of the column, as reported by java.sql.ResultSetMetaData.getColumnDisplaySize, or 0 when the driver does not report one. A few type mappings depend on it — it is what tells a BIT(1) column apart from a BIT(M) one in MySQL, MariaDB and PostgreSQL, where the driver reports identical metadata for both but returns values of different classes. A custom DbType branching on it should treat 0 as "unknown" rather than as a width.

sqlTypeName

val sqlTypeName: String

the SQL data type of the column.

Functions

copy

fun copy(name: String = this.name, sqlTypeName: String = this.sqlTypeName, jdbcType: Int = this.jdbcType, size: Int = this.size, javaClassName: String = this.javaClassName, isNullable: Boolean = this.isNullable): TableColumnMetadata

Creates a copy of the current TableColumnMetadata instance with optionally modified attributes.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String