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

ArrayColumnType

class ArrayColumnType<T, R : List<Any?>>(val delegate: ColumnType<T & Any>, val maximumCardinality: List<Int>? = null, val dimensions: Int = 1) : ColumnType<R>

Multi-dimensional array column type for storing a collection of nested elements.

Constructors

ArrayColumnType

constructor(delegate: ColumnType<T & Any>, maximumCardinality: Int? = null)

Constructor with maximum cardinality for a single dimension.

constructor(delegate: ColumnType<T & Any>, maximumCardinality: List<Int>? = null, dimensions: Int = 1)

Properties

delegate

val delegate: ColumnType<T & Any>

The base column type associated with this array column's individual elements.

delegateType

val delegateType: String

The SQL type definition of the delegate column type without any potential array dimensions.

dimensions

val dimensions: Int = 1

The number of dimensions of the multi-dimensional array.

isAutoInc

val IColumnType<*>.isAutoInc: Boolean

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

maximumCardinality

val maximumCardinality: List<Int>? = null

The maximum cardinality (number of allowed elements) for each dimension of the array.

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

hashCode

open override fun hashCode(): Int

nonNullValueAsDefaultString

open override fun nonNullValueAsDefaultString(value: R): 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: R): String

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

notNullValueToDB

open override fun notNullValueToDB(value: R): Any

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

parameterMarker

open fun parameterMarker(value: R?): String

Defines the appearance of parameter markers in prepared SQL statements.

readObject

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

Returns the object at the specified index in the rs.

setParameter

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

toString

open override fun toString(): String

validateValueBeforeUpdate

open fun validateValueBeforeUpdate(value: R?)

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: R?): 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): R?

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: R?): Any?

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

valueToString

open fun valueToString(value: R?): 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.