keel-exposed-starter/com.keel.db.table/PluginTable

PluginTable

abstract class PluginTable(pluginId: String, tableName: String) : Table(source)

Base table class that enforces plugin-specific table naming. All plugin tables MUST extend this class to ensure proper table prefixing.

Physical table name format:

${pluginId}_$

{name} Example: auth_users, user_profiles

Inheritors

Constructors

Link copied to clipboard
constructor(pluginId: String, tableName: String)

Properties

Link copied to clipboard
val autoIncColumn: Column<*>?
Link copied to clipboard
open override val columns: List<Column<*>>
Link copied to clipboard
open val ddl: List<String>
Link copied to clipboard
open override val fields: List<Expression<*>>
Link copied to clipboard
val foreignKeys: List<ForeignKeyConstraint>
Link copied to clipboard
val indices: List<Index>
Link copied to clipboard
open val primaryKey: Table.PrimaryKey?
Link copied to clipboard
open val realFields: List<Expression<*>>
Link copied to clipboard
Link copied to clipboard
val sequences: List<Sequence>
Link copied to clipboard
open override val source: ColumnSet
Link copied to clipboard
open val tableName: String

Functions

Link copied to clipboard
inline fun <E : Any> array(name: String, maximumCardinality: Int?): Column<List<E>>
fun <E> array(name: String, columnType: ColumnType<E & Any>, maximumCardinality: Int?): Column<List<E>>
inline fun <T : Any, R : List<Any>> Table.array(name: String, maximumCardinality: List<Int>?, dimensions: Int): Column<R>
fun <E, R : List<Any?>> Table.array(name: String, columnType: ColumnType<E & Any>, maximumCardinality: List<Int>?, dimensions: Int): Column<R>
Link copied to clipboard
fun Column<UUID>.autoGenerate(): Column<UUID>
Link copied to clipboard
fun <N : Any> Column<EntityID<N>>.autoinc(idSeqName: String?): Column<EntityID<N>>
Link copied to clipboard
fun <N : Any> Column<N>.autoIncrement(idSeqName: String?): Column<N>
fun <N : Any> Column<N>.autoIncrement(sequence: Sequence): Column<N>
Link copied to clipboard
fun binary(name: String): Column<ByteArray>
fun binary(name: String, length: Int): Column<ByteArray>
Link copied to clipboard
fun blob(name: String, useObjectIdentifier: Boolean): Column<ExposedBlob>
Link copied to clipboard
fun bool(name: String): Column<Boolean>
Link copied to clipboard
fun byte(name: String, checkConstraintName: String?): Column<Byte>
Link copied to clipboard
fun char(name: String): Column<Char>
fun char(name: String, length: Int, collate: String?): Column<String>
Link copied to clipboard
fun check(name: String, op: SqlExpressionBuilder.() -> Op<Boolean>)
fun <T> Column<T>.check(name: String, op: SqlExpressionBuilder.(Column<T>) -> Op<Boolean>): Column<T>
Link copied to clipboard
fun checkConstraints(): List<CheckConstraint>
Link copied to clipboard
fun <T> Column<T>.clientDefault(defaultValue: () -> T): Column<T>
Link copied to clipboard
open override fun createStatement(): List<String>
Link copied to clipboard
open infix override fun crossJoin(otherTable: ColumnSet): Join
Link copied to clipboard
fun <T : Enum<T>> customEnumeration(name: String, sql: String?, fromDb: (Any) -> T, toDb: (T) -> Any): Column<T>
Link copied to clipboard
fun <T> Column<T>.databaseGenerated(): Column<T>
Link copied to clipboard
fun decimal(name: String, precision: Int, scale: Int): Column<BigDecimal>
Link copied to clipboard
fun <T> Column<T>.default(defaultValue: T): Column<T>
fun <T> CompositeColumn<T>.default(defaultValue: T): CompositeColumn<T>
Link copied to clipboard
fun <T> Column<T>.defaultExpression(defaultValue: Expression<T>): Column<T>
Link copied to clipboard
open override fun describe(s: Transaction, queryBuilder: QueryBuilder)
Link copied to clipboard
fun double(name: String): Column<Double>
Link copied to clipboard
open override fun dropStatement(): List<String>
Link copied to clipboard
fun <T : Any> Column<T>.entityId(): Column<EntityID<T>>
fun <ID : Any> entityId(name: String, table: IdTable<ID>): Column<EntityID<ID>>
fun <ID : Any> entityId(name: String, originalColumn: Column<ID>): Column<EntityID<ID>>
Link copied to clipboard
inline fun <T : Enum<T>> enumeration(name: String): Column<T>
fun <T : Enum<T>> enumeration(name: String, klass: KClass<T>): Column<T>
Link copied to clipboard
inline fun <T : Enum<T>> enumerationByName(name: String, length: Int): Column<T>
fun <T : Enum<T>> enumerationByName(name: String, length: Int, klass: KClass<T>): Column<T>
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
fun float(name: String): Column<Float>
Link copied to clipboard
fun foreignKey(vararg references: Pair<Column<*>, Column<*>>, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: String?)
fun foreignKey(vararg from: Column<*>, target: Table.PrimaryKey, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: String?)
Link copied to clipboard
open infix override fun fullJoin(otherTable: ColumnSet): Join
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun index(isUnique: Boolean, vararg columns: Column<*>)
fun <T> Column<T>.index(customIndexName: String?, isUnique: Boolean): Column<T>
fun index(customIndexName: String?, isUnique: Boolean, vararg columns: Column<*>, functions: List<ExpressionWithColumnType<*>>?, indexType: String?, filterCondition: FilterCondition?)
Link copied to clipboard
open infix override fun innerJoin(otherTable: ColumnSet): Join
Link copied to clipboard
fun integer(name: String, checkConstraintName: String?): Column<Int>
Link copied to clipboard
open override fun join(otherTable: ColumnSet, joinType: JoinType, onColumn: Expression<*>?, otherColumn: Expression<*>?, lateral: Boolean, additionalConstraint: SqlExpressionBuilder.() -> Op<Boolean>?): Join
Link copied to clipboard
fun largeText(name: String, collate: String?, eagerLoading: Boolean): Column<String>
Link copied to clipboard
open infix override fun leftJoin(otherTable: ColumnSet): Join
Link copied to clipboard
fun long(name: String, checkConstraintName: String?): Column<Long>
Link copied to clipboard
fun mediumText(name: String, collate: String?, eagerLoading: Boolean): Column<String>
Link copied to clipboard
open override fun modifyStatement(): List<String>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T : Any, C : CompositeColumn<T>> C.nullable(): CompositeColumn<T?>
fun <T : Any> Column<T>.nullable(): Column<T?>
Link copied to clipboard
@JvmName(name = "nullTransform")
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped>.nullTransform(transformer: ColumnTransformer<Unwrapped, Wrapped?>): Column<Wrapped?>
@JvmName(name = "nullTransform")
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped>.nullTransform(wrap: (Unwrapped) -> Wrapped?, unwrap: (Wrapped?) -> Unwrapped): Column<Wrapped?>
Link copied to clipboard
fun <T : Any> optReference(name: String, foreign: IdTable<T>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<EntityID<T>?>
fun <T : Any> optReference(name: String, refColumn: Column<T>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<T?>
@JvmName(name = "optReferenceByIdColumn")
fun <T : Any, E : EntityID<T>> optReference(name: String, refColumn: Column<E>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<E?>
Link copied to clipboard
fun physicalName(): String

Generate the full physical table name.

Link copied to clipboard
fun <T : Any> reference(name: String, foreign: IdTable<T>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<EntityID<T>>
fun <T : Any> reference(name: String, refColumn: Column<T>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<T>
@JvmName(name = "referenceByIdColumn")
fun <T : Any, E : EntityID<T>> reference(name: String, refColumn: Column<E>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): Column<E>
Link copied to clipboard
infix fun <T : Any, S : T, C : Column<S>> C.references(ref: Column<T>): C
fun <T : Any, S : T, C : Column<S>> C.references(ref: Column<T>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): C
@JvmName(name = "referencesById")
fun <T : Any, S : T, C : Column<S>> C.references(ref: Column<EntityID<T>>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: String?): C
Link copied to clipboard
fun <T> registerColumn(name: String, type: IColumnType<T & Any>): Column<T>
Link copied to clipboard
fun <R, T : CompositeColumn<R>> registerCompositeColumn(column: T): T
Link copied to clipboard
fun <TColumn : Column<*>> replaceColumn(oldColumn: Column<*>, newColumn: TColumn): TColumn
Link copied to clipboard
open infix override fun rightJoin(otherTable: ColumnSet): Join
Link copied to clipboard
fun select(columns: List<Expression<*>>): Query
fun select(column: Expression<*>, vararg columns: Expression<*>): Query
Link copied to clipboard
fun short(name: String, checkConstraintName: String?): Column<Short>
Link copied to clipboard
fun text(name: String, collate: String?, eagerLoading: Boolean): Column<String>
Link copied to clipboard
@JvmName(name = "transformNullable")
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped?>.transform(transformer: ColumnTransformer<Unwrapped?, Wrapped?>): Column<Wrapped?>
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped>.transform(transformer: ColumnTransformer<Unwrapped, Wrapped>): Column<Wrapped>
@JvmName(name = "transformNullable")
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped?>.transform(wrap: (Unwrapped?) -> Wrapped?, unwrap: (Wrapped?) -> Unwrapped?): Column<Wrapped?>
fun <Unwrapped : Any, Wrapped : Any> Column<Unwrapped>.transform(wrap: (Unwrapped) -> Wrapped, unwrap: (Wrapped) -> Unwrapped): Column<Wrapped>
Link copied to clipboard
fun ubyte(name: String, checkConstraintName: String?): Column<UByte>
Link copied to clipboard
fun uinteger(name: String, checkConstraintName: String?): Column<UInt>
Link copied to clipboard
fun ulong(name: String): Column<ULong>
Link copied to clipboard
fun <T> Column<T>.uniqueIndex(customIndexName: String?): Column<T>
fun uniqueIndex(vararg columns: Column<*>, filterCondition: FilterCondition?)
fun uniqueIndex(customIndexName: String?, vararg columns: Column<*>, functions: List<ExpressionWithColumnType<*>>?, filterCondition: FilterCondition?)
Link copied to clipboard
fun ushort(name: String, checkConstraintName: String?): Column<UShort>
Link copied to clipboard
fun uuid(name: String): Column<UUID>
Link copied to clipboard
fun varchar(name: String, length: Int, collate: String?): Column<String>
Link copied to clipboard
fun <T> Column<T>.withDefinition(vararg definition: Any): Column<T>
Generated by Dokka
© 2026 Copyright