exposed-core/org.jetbrains.exposed.v1.core.datetime/LocalDateColumnType

LocalDateColumnType

abstract class LocalDateColumnType<T> : ColumnType<T> , IDateColumnType

Base column type for storing date values without time components.

This abstract class provides the foundation for date-only columns across different database dialects. It handles the conversion between application date types and database representations, ensuring proper formatting and parsing based on the current database dialect.

Type Parameters

The application-specific date type (e.g., LocalDate, kotlinx.datetime.LocalDate)

Constructors

LocalDateColumnType

constructor()

Properties

hasTimePart

open override val hasTimePart: Boolean = false

isAutoInc

val IColumnType<*>.isAutoInc: Boolean

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

nullable

open override var nullable: Boolean

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

Functions

equals

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

fromLocalDate

abstract fun fromLocalDate(value: LocalDate): T

hashCode

open override fun hashCode(): Int

nonNullValueAsDefaultString

open override 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 override fun nonNullValueToString(value: T & Any): String

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

notNullValueToDB

open override 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.

readObject

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

Returns the object at the specified index in the rs.

setParameter

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

Sets the value at the specified index into the stmt.

sqlType

open override fun sqlType(): String

Returns the SQL type of this column.

toLocalDate

abstract fun toLocalDate(value: T): LocalDate

toString

open override fun toString(): String

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.

valueFromDB

open override 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.

valueToDB

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

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

valueToString

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.

LocalDateColumnType

Type Parameters

See also

Constructors

Properties

Functions