ktorm-ksp-annotations/org.ktorm.ksp.annotation/References

References

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class References(val name: String = "", val propertyName: String = "", val refTablePropertyName: String = "")(source)

Specify the mapped column for an entity property, and bind this column to a reference table. Typically, this column is a foreign key in relational databases. Entity sequence APIs would automatically left-join all references (recursively) by default.

Properties

name

val name: String

The name of the column.

propertyName

val propertyName: String

The name of the corresponding column property in the generated table class.

refTablePropertyName

val refTablePropertyName: String

The name of the corresponding referenced table property in the Refs wrapper class.