ktorm-core/org.ktorm.schema/SqlType

SqlType

abstract class SqlType<T : Any>(val typeCode: Int, val typeName: String)(source)

Abstraction of SQL data types.

Based on JDBC, SqlType and its subclasses encapsulate the common operations of obtaining data from a ResultSet and setting parameters to a PreparedStatement.

Inheritors

Constructors

SqlType

constructor(typeCode: Int, typeName: String)

Types

Companion

object Companion

Companion object provides some utility functions.

Properties

typeCode

val typeCode: Int

a constant value defined in java.sql.Types to identify JDBC types.

typeName

val typeName: String

the name of the type in specific databases, such as int, bigint, varchar, etc.

Functions

equals

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

Indicates whether some other object is "equal to" this SQL type. Two SQL types are equal if they have the same type codes and names.

getResult

open fun getResult(rs: ResultSet, index: Int): T?

Obtain a result from a given ResultSet by index.

open fun getResult(rs: ResultSet, columnLabel: String): T?

Obtain a result from a given ResultSet by columnLabel.

hashCode

open override fun hashCode(): Int

Return a hash code value for this SQL type.

setParameter

open fun setParameter(ps: PreparedStatement, index: Int, parameter: T?)

Set the nullable parameter to a given PreparedStatement.

transform

open fun <R : Any> transform(fromUnderlyingValue: (T) -> R, toUnderlyingValue: (R) -> T): SqlType<R>

Transform this SqlType to another. The returned SqlType has the same typeCode and typeName as the underlying one, and performs the specific transformations on column values.