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

AutoIncColumnType

class AutoIncColumnType<T>(val delegate: ColumnType<T>, _autoincSeq: String?, fallbackSeqName: String) : IColumnType<T>

Auto-increment column type.

Constructors

AutoIncColumnType

constructor(delegate: ColumnType<T>, sequence: Sequence)

constructor(delegate: ColumnType<T>, _autoincSeq: String?, fallbackSeqName: String)

Properties

val autoincSeq: String?

The name of the sequence used to generate new values for this auto-increment column.

val delegate: ColumnType<T>

Returns the base column type of this auto-increment column.

val IColumnType<*>.isAutoInc: Boolean

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

nextValExpression

val nextValExpression: NextVal<*>?

The SQL expression that advances the sequence of this auto-increment column.

open override var nullable: Boolean

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

val sequence: Sequence?

The sequence used to generate new values for this auto-increment column.

Functions

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

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 override fun parameterMarker(value: T?): String

Defines the appearance of parameter markers in prepared SQL statements.

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

Returns the object at the specified index in the rs.

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

Sets the value at the specified index into the stmt.

open override fun sqlType(): String

Returns the SQL type of this column.

validateValueBeforeUpdate

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

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.

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

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

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