exposed-dao/org.jetbrains.exposed.dao/Entity

Entity

open class Entity<ID : Any>(val id: EntityID<ID>)

Class representing a mapping to values stored in a table record in a database.

Parameters

id

The unique stored identity value for the mapped record.

Inheritors

CompositeEntity

Constructors

constructor(id: EntityID<ID>)

Properties

var _readValues: ResultRow?

var db: Database

The Database associated with the record mapped to this Entity instance.

val id: EntityID<ID>

var klass: EntityClass<ID, Entity<ID>>

The associated EntityClass that manages this Entity instance.

val readValues: ResultRow

The final column-value mapping for this Entity instance after being flushed and retrieved from the database.

val writeValues: LinkedHashMap<Column<Any?>, Any?>

The initial column-value mapping for this Entity instance before being flushed and inserted into the database.

Functions

open fun delete()

Deletes this Entity instance, both from the cache and from the database.

open fun flush(batch: EntityBatchUpdate? = null): Boolean

Sends all cached inserts and updates for this Entity instance to the database.

operator fun <Unwrapped, Wrapped> EntityFieldWithTransform<Unwrapped, Wrapped>.getValue(o: Entity<ID>, desc: KProperty<*>): Wrapped

operator fun <REF : Any, RID : Any, T : Entity<RID>> OptionalReference<REF, RID, T>.getValue(o: Entity<ID>, desc: KProperty<*>): T?

operator fun <REF : Any, RID : Any, T : Entity<RID>> Reference<REF, RID, T>.getValue(o: Entity<ID>, desc: KProperty<*>): T

operator fun <T> Column<T>.getValue(o: Entity<ID>, desc: KProperty<*>): T

operator fun <T> CompositeColumn<T>.getValue(o: Entity<ID>, desc: KProperty<*>): T

fun <T> Column<T>.lookup(): T

Returns the value assigned to this column mapping.

lookupInReadValues

fun <T, R : Any> Column<T>.lookupInReadValues(found: (T?) -> R?, notFound: () -> R?): R?

Checks if this column has been assigned a value retrieved from the database, then calls the found block with this value as its argument, and returns its result.

open fun refresh(flush: Boolean = false)

Updates the fields of this Entity instance with values retrieved from the database. Override this function to refresh some additional state, if any.

operator fun <Unwrapped, Wrapped> EntityFieldWithTransform<Unwrapped, Wrapped>.setValue(o: Entity<ID>, desc: KProperty<*>, value: Wrapped)

operator fun <REF : Any, RID : Any, T : Entity<RID>> OptionalReference<REF, RID, T>.setValue(o: Entity<ID>, desc: KProperty<*>, value: T?)

operator fun <REF : Any, RID : Any, T : Entity<RID>> Reference<REF, RID, T>.setValue(o: Entity<ID>, desc: KProperty<*>, value: T)

operator fun <T> Column<T>.setValue(o: Entity<ID>, desc: KProperty<*>, value: T)

operator fun <T> CompositeColumn<T>.setValue(o: Entity<ID>, desc: KProperty<*>, value: T)

storeWrittenValues

fun storeWrittenValues()

Transfers initial column-value mappings from writeValues to readValues and clears the former once complete.

infix fun <TID : Any, Target : Entity<TID>> EntityClass<TID, Target>.via(table: Table): InnerTableLink<ID, Entity<ID>, TID, Target>

fun <TID : Any, Target : Entity<TID>> EntityClass<TID, Target>.via(sourceColumn: Column<EntityID<ID>>, targetColumn: Column<EntityID<TID>>): InnerTableLink<ID, Entity<ID>, TID, Target>

Registers a reference as a field of the child entity class, which returns a parent object of this EntityClass, for use in many-to-many relations.