列类型参考

使用 KColumnType

KColumnType 是 @ColumnType 接收的枚举。把它标注在 KPojo 属性上，可以指定表操作在当前数据库方言下渲染的 DDL 类型。

import com.kotlinorm.annotations.ColumnType
import com.kotlinorm.annotations.Table
import com.kotlinorm.enums.KColumnType
import com.kotlinorm.interfaces.KPojo

@Table("tb_column_type_catalog")
data class ColumnTypeCatalog(
    @ColumnType(KColumnType.VARCHAR, length = 64)
    var code: String? = null,
) : KPojo

val code = ColumnTypeCatalog().__columns.single { it.name == "code" }

结果：

文本和 UUID 类型

字符串类 KColumnType 可用于短文本、长文本和 UUID 值。

import com.kotlinorm.annotations.ColumnType
import com.kotlinorm.annotations.Table
import com.kotlinorm.enums.KColumnType
import com.kotlinorm.interfaces.KPojo

@Table("tb_text_type")
data class TextType(
    @ColumnType(KColumnType.VARCHAR, length = 64)
    var code: String? = null,

    @ColumnType(KColumnType.TEXT)
    var description: String? = null,

    @ColumnType(KColumnType.UUID)
    var externalId: String? = null,
) : KPojo

DDL 类型片段：

数值类型

数值类 KColumnType 可用于布尔值、整数和精确小数。

import com.kotlinorm.annotations.ColumnType
import com.kotlinorm.annotations.Table
import com.kotlinorm.enums.KColumnType
import com.kotlinorm.interfaces.KPojo
import java.math.BigDecimal

@Table("tb_numeric_type")
data class NumericType(
    @ColumnType(KColumnType.BIT)
    var active: Boolean? = null,

    @ColumnType(KColumnType.BIGINT)
    var visits: Long? = null,

    @ColumnType(KColumnType.DECIMAL, length = 12, scale = 4)
    var balance: BigDecimal? = null,
) : KPojo

DDL 类型片段：

日期和时间类型

时间类 KColumnType 可用于日期、时间、日期时间和时间戳列。方言支持小秒精度时，scale 会参与渲染。

import com.kotlinorm.annotations.ColumnType
import com.kotlinorm.annotations.Table
import com.kotlinorm.enums.KColumnType
import com.kotlinorm.interfaces.KPojo
import java.sql.Timestamp
import java.time.LocalDate
import java.time.LocalDateTime
import java.time.LocalTime

@Table("tb_temporal_type")
data class TemporalType(
    @ColumnType(KColumnType.DATE)
    var eventDate: LocalDate? = null,

    @ColumnType(KColumnType.TIME)
    var eventTime: LocalTime? = null,

    @ColumnType(KColumnType.DATETIME)
    var createdAt: LocalDateTime? = null,

    @ColumnType(KColumnType.TIMESTAMP, scale = 4)
    var touchedAt: Timestamp? = null,
) : KPojo

DDL 类型片段：

JSON、二进制、空间和 XML 类型

@Serialize 会把对象编码为 JSON 文本。数据库列需要 JSON 类型时，可以额外使用 @ColumnType(KColumnType.JSON) 生成对应 DDL。二进制、空间和 XML 值也使用同样的 @ColumnType 写法。

import com.kotlinorm.annotations.ColumnType
import com.kotlinorm.annotations.Serialize
import com.kotlinorm.annotations.Table
import com.kotlinorm.enums.KColumnType
import com.kotlinorm.interfaces.KPojo

data class AuditPayload(val ip: String, val tags: List<String>)

@Table("tb_document_type")
data class DocumentType(
    @ColumnType(KColumnType.JSON)
    @Serialize
    var payload: AuditPayload? = null,

    @ColumnType(KColumnType.BLOB)
    var attachment: ByteArray? = null,

    @ColumnType(KColumnType.POINT)
    var position: String? = null,

    @ColumnType(KColumnType.XML)
    var document: String? = null,
) : KPojo

DDL 类型片段：

紧凑参考表

下表展示表结构 DDL 对常见 KColumnType 的类型字符串。单元格中的 n、p、s 来自 @ColumnType 的 length 和 scale；decimal/numeric 只设置 length 时会渲染为 p,0。

Kotlin 类型自动推断见📚Kotlin Type 到 KColumnType。@ColumnType 是用户主动选择其他枚举值的入口。