exposed-core/org.jetbrains.exposed.sql/IColumnType

IColumnType

interface IColumnType<T>

Interface common to all column types.

Inheritors

AutoIncColumnType

Properties

val IColumnType<*>.isAutoInc: Boolean

Returns true if this is an auto-increment column, false otherwise.

abstract var nullable: Boolean

Returns true if the column type is nullable, false otherwise.

Functions

nonNullValueAsDefaultString

open fun nonNullValueAsDefaultString(value: T & Any): String

Returns the String representation of the specified non-null value when value is set as the default for the column.

nonNullValueToString

open fun nonNullValueToString(value: T & Any): String

Returns the SQL representation of the specified non-null value, for this column type.

notNullValueToDB

open fun notNullValueToDB(value: T & Any): Any

Returns an object compatible with the database, from the specified non-null value, for this column type.

parameterMarker

open fun parameterMarker(value: T?): String

Defines the appearance of parameter markers in prepared SQL statements.

open fun readObject(rs: ResultSet, index: Int): Any?

Returns the object at the specified index in the rs.

open fun setParameter(stmt: PreparedStatementApi, index: Int, value: Any?)

Sets the value at the specified index into the stmt.

abstract fun sqlType(): String

Returns the SQL type of this column.

validateValueBeforeUpdate

open fun validateValueBeforeUpdate(value: T?)

Function checks that provided value is suites the column type and throws IllegalArgumentException otherwise. value can be of any type (including Expression)

valueAsDefaultString

open fun valueAsDefaultString(value: T?): String

Returns the String representation of the specified value when value is set as the default for the column. If the value is null and the column is not nullable, an exception will be thrown. Used for metadata default value comparison.

abstract fun valueFromDB(value: Any): T?

Converts the specified value (from the database) to an object of the appropriated type, for this column type. Default implementation returns the same instance.

open fun valueToDB(value: T?): Any?

Returns an object compatible with the database, from the specified value, for this column type.

open fun valueToString(value: T?): String

Returns the SQL representation of the specified value, for this column type. If the value is null and the column is not nullable, an exception will be thrown. Used when generating an SQL statement and when logging that statement.