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

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Column(val name: String = "", val sqlType: KClass<out SqlType<*>> = Nothing::class, val propertyName: String = "")

Specify the mapped column for an entity property. If no @Column annotation is specified, the default values apply.

Ignore

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Ignore

Ignore the annotated property, not generating the column definition.

PrimaryKey

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class PrimaryKey

Mark the annotated column as a primary key.

References

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

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

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.

Table

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Table(val name: String = "", val alias: String = "", val catalog: String = "", val schema: String = "", val className: String = "", val entitySequenceName: String = "", val ignoreProperties: Array<String> = [])

Specify the table for an entity class.

Undefined

object Undefined

Utility class that creates unique undefined values for any class.