Version v1.8 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
データ型
概要
KotlinとSQLのデータ型の対応関係について説明します。
ダイアレクトのデータ型
データ型に関するKotlinとSQLのデフォルトの対応関係は利用する ダイアレクト によって決まります。
ユーザー定義のデータ型
独自に定義したKotlinのデータ型とSQLのデータ型をマッピングさせるには、 Service Provider Interfaceの仕様に則ったクラスの作成と登録が必要です。
例えば、次のようなexample.AgeというKotlinのデータ型をデータベースのINTEGER型にマッピングするとします。
package example
data class Age(val value: Int)
JDBCの場合
マッピングを実行するクラスをorg.komapper.jdbc.spi.JdbcUserDefinedDataTypeを実装して作成します。
package example.jdbc
import example.Age
import org.komapper.jdbc.spi.JdbcUserDefinedDataType
import java.sql.JDBCType
import java.sql.PreparedStatement
import java.sql.ResultSet
import kotlin.reflect.KClass
class AgeType : JdbcUserDefinedDataType<Age> {
override val name: String = "integer"
override val klass: KClass<Age> = Age::class
override val jdbcType: JDBCType = JDBCType.INTEGER
override fun getValue(rs: ResultSet, index: Int): Age {
return Age(rs.getInt(index))
}
override fun getValue(rs: ResultSet, columnLabel: String): Age {
return Age(rs.getInt(columnLabel))
}
override fun setValue(ps: PreparedStatement, index: Int, value: Age) {
ps.setInt(index, value.value)
}
override fun toString(value: Age): String {
return value.value.toString()
}
}
上述のクラスは次の名前のファイルに登録します。
META-INF/services/org.komapper.jdbc.spi.JdbcUserDefinedDataType
ファイルには次のようにクラスの完全修飾名を記載します。
example.jdbc.AgeType
この例では1つのクラスのみを登録していますが、行を分けて記載すれば複数のクラスをまとめて登録できます。
R2DBCの場合
マッピングを実行するクラスをorg.komapper.r2dbc.spi.R2dbcUserDefinedDataTypeを実装して作成します。
package example.r2dbc
import example.Age
import io.r2dbc.spi.Row
import io.r2dbc.spi.Statement
import org.komapper.r2dbc.spi.R2dbcUserDefinedDataType
import kotlin.reflect.KClass
class AgeType : R2dbcUserDefinedDataType<Age> {
override val name: String = "integer"
override val klass: KClass<Age> = Age::class
override val javaObjectType: Class<*> = Int::class.javaObjectType
override fun getValue(row: Row, index: Int): Age? {
return row.get(index, Int::class.javaObjectType)?.let { Age(it) }
}
override fun getValue(row: Row, columnLabel: String): Age? {
return row.get(columnLabel, Int::class.javaObjectType)?.let { Age(it) }
}
override fun setValue(statement: Statement, index: Int, value: Age) {
statement.bind(index, value.value)
}
override fun setValue(statement: Statement, name: String, value: Age) {
statement.bind(name, value.value)
}
override fun toString(value: Age): String {
return value.value.toString()
}
}
上述のクラスは次の名前のファイルに登録します。
META-INF/services/org.komapper.r2dbc.spi.R2dbcUserDefinedDataType
ファイルには次のようにクラスの完全修飾名を記載します。
example.r2dbc.AgeType
この例では1つのクラスのみを登録していますが、行を分けて記載すれば複数のクラスをまとめて登録できます。
データ型の変換
データ型を他の型に変換してアプリケーションで扱うには Service Provider Interfaceの仕様に則ったクラスの作成と登録が必要です。
例えば、Intをアプリケーションでは次のようなexample.PhoneNumberとして扱うものとします。
package example
data class PhoneNumber(val value: Int)
変換を実行するクラスをorg.komapper.core.spi.DataTypeConverterを実装して作成します。
package example
import org.komapper.core.spi.DataTypeConverter
import kotlin.reflect.KClass
class PhoneNumberTypeConverter : DataTypeConverter<PhoneNumber, Int> {
override val exteriorClass: KClass<PhoneNumber> = PhoneNumber::class
override val interiorClass: KClass<Int> = Int::class
override fun unwrap(exterior: PhoneNumber): Int {
return exterior.value
}
override fun wrap(interior: Int): PhoneNumber {
return PhoneNumber(interior)
}
}
上述のクラスは次の名前のファイルに登録します。
META-INF/services/org.komapper.core.spi.DataTypeConverter
ファイルには次のようにクラスの完全修飾名を記載します。
example.PhoneNumberTypeConverter
この例では1つのクラスのみを登録していますが、行を分けて記載すれば複数のクラスをまとめて登録できます。
Value class
value classを利用する場合、value classの内側の型がマッピングに利用されます。
Alternate type
@KomapperColumnのalternateTypeプロパティにvalue classを指定することでマッピング対象のSQL型を変更できます。
例えば、kotlin.StringをVARCHARやVARCHAR2ではなくCLOBまたはTEXTにマッピングしたい場合、
org.komapper.core.type.ClobStringを指定します。
@KomapperColumn(alternateType = ClobString::class)
val description: String
alternateTypeプロパティにはユーザーが独自に作成したvalue classを指定できます。
ただし、そのvalue classに対応するユーザー定義のデータ型の作成と登録が必要です。
なお、value classは次の要件を満たす必要があります。
- コンストラクターがpublicである
- パラメータープロパティがpublicでnon-nullableである
- パラメータープロパティの型が
@KomapperColumnで注釈されたエンティティプロパティの型と同じである
kotlinx-datetimeのサポート
Komapperは kotlinx-datetime の以下のデータ型をサポートします。
- kotlinx.datetime.Instant
- kotlinx.datetime.LocalDate
- kotlinx.datetime.LocalDateTime
これらの型を利用するには、Gradleの依存関係の宣言で次のように宣言してください。
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.3.2")
}
また、komapper-datetime-jdbcもしくはkomapper-datetime-r2dbcを追加してください。
val komapperVersion: String by project
dependencies {
runtimeOnly("org.komapper:komapper-datetime-jdbc:$komapperVersion")
}