# Kotlin Exposed ORMによるクエリビルダーの使い方

## 目次

1. 1-1 Exposed ORMとは

2. 1-2 Kotlin Exposedのインストールとセットアップ

3. 1-3 Exposed ORMの基本構文

    - 1-3-1 データベース接続の設定

    - 1-3-2 テーブル定義

4. 1-4 クエリビルダーの使用方法

    - 1-4-1 INSERTクエリ

    - 1-4-2 SELECTクエリ

    - 1-4-3 UPDATEクエリ

    - 1-4-4 DELETEクエリ

5. 1-5 トランザクション管理

6. 1-6 理解を深めるための応用例

7. 1-7 Exposed ORMの利点と注意点

8. 1-8 まとめ

## 1-1 Exposed ORMとは

Kotlin Exposedは、Kotlinプログラミング言語に特化した軽量のORマッパー（Object Relational Mapper）です。データベースのテーブルをKotlinオブジェクトとして扱い、クエリのビルドと実行を容易にします。Exposedは主に2つのDSL（Domain Specific Language）を提供しています。ひとつはクエリビルダー、もうひとつはDAO（Data Access Object）です。この記事ではクエリビルダーを中心に解説します。

## 1-2 Kotlin Exposedのインストールとセットアップ

Kotlin Exposedを使用するためには、プロジェクトに依存関係を追加する必要があります。具体的にはGradleを用いて以下のように設定します。

```kotlin

dependencies {

    implementation("org.jetbrains.exposed:exposed-core:0.41.1")

    implementation("org.jetbrains.exposed:exposed-dao:0.41.1")

    implementation("org.jetbrains.exposed:exposed-jdbc:0.41.1")

    implementation("org.jetbrains.exposed:exposed-java-time:0.41.1") // Optional for Java Time Support

    implementation("org.xerial:sqlite-jdbc:3.36.0.3") // JDBC Driver

}

```

上記の依存関係を追加することで、KotlinでExposedを活用したORM機能を使用できるようになります。

## 1-3 Exposed ORMの基本構文

### 1-3-1 データベース接続の設定

Exposedを使用する際は、まずデータベースへの接続設定を行います。以下の例はSQLiteデータベースへの接続設定となります。

```kotlin

import org.jetbrains.exposed.sql.Database

fun connectToDatabase() {

    Database.connect("jdbc:sqlite:sample.db", driver = "org.sqlite.JDBC")

}

```

### 1-3-2 テーブル定義

Exposedにおけるテーブルの定義は、`Table`オブジェクトを継承して行います。以下に`Users`テーブルの定義例を示します。

```kotlin

import org.jetbrains.exposed.sql.Table

object Users : Table() {

    val id = integer("id").autoIncrement()

    val name = varchar("name", 50)

    val age = integer("age")

    override val primaryKey = PrimaryKey(id, name = "PK_User_ID") // カスタム主キー定義

}

```

## 1-4 クエリビルダーの使用方法

### 1-4-1 INSERTクエリ

新しいデータを挿入するためには、`insert`関数を使用します。以下の例では、`Users`テーブルに新たなレコードを追加しています。

```kotlin

import org.jetbrains.exposed.sql.transactions.transaction

import org.jetbrains.exposed.sql.insert

transaction {

    Users.insert {

        it[name] = "John Doe"

        it[age] = 30

    }

}

```

### 1-4-2 SELECTクエリ

特定のデータを取得するには、`select`関数を使います。以下の例では、年齢が20以上のユーザーを取得するクエリを実行しています。

```kotlin

import org.jetbrains.exposed.sql.select

transaction {

    val query = Users.select { Users.age greaterEq 20 }

    query.forEach {

        println("${it[Users.name]} is ${it[Users.age]} years old")

    }

}

```

### 1-4-3 UPDATEクエリ

既存のデータを更新するには、`update`関数を用います。以下の例では、特定のユーザーの年齢を更新するクエリを実行しています。

```kotlin

import org.jetbrains.exposed.sql.update

transaction {

    Users.update({ Users.id eq 1 }) {

        it[age] = 31

    }

}

```

### 1-4-4 DELETEクエリ

レコードを削除するには、`deleteWhere`関数を使用します。以下の例は、特定のIDのユーザーを削除するクエリです。

```kotlin

import org.jetbrains.exposed.sql.deleteWhere

transaction {

    Users.deleteWhere { Users.id eq 1 }

}

```

## 1-5 トランザクション管理

Exposedを使用する際には、データベース操作がトランザクション内で行われることを保証するため、`transaction`ブロックを用います。トランザクションはデータベース一貫性を保つために重要な役割を持っています。

```kotlin

transaction {

    // データベース操作をここに記述

}

```

## 1-6 理解を深めるための応用例

Exposedのクエリビルダーを使いこなすためには、複雑なクエリや結合クエリにも慣れておく必要があります。以下の例は、`Users`テーブルと`Orders`テーブルの結合を行うクエリです。

```kotlin

import org.jetbrains.exposed.sql.JoinType

import org.jetbrains.exposed.sql.Table

object Orders : Table() {

    val id = integer("id").autoIncrement()

    val userId = integer("user_id") references Users.id

    val amount = decimal("amount", 10, 2)

    override val primaryKey = PrimaryKey(id)

}

transaction {

    val joinQuery = (Users innerJoin Orders)

        .select { Orders.amount greater 50.00.toBigDecimal() }

    joinQuery.forEach {

        println("User: ${it[Users.name]}, Order Amount: $${it[Orders.amount]}")

    }

}

```

## 1-7 Exposed ORMの利点と注意点

Exposed ORMは直感的であると同時に、Kotlinの型安全性を最大限に活かせるところが魅力です。特に小規模から中規模のプロジェクトにおいて、コードの簡潔性と可読性に貢献します。しかし、Exposedの持つ取扱いにおける制約や、データベースの複雑性が増した場合のパフォーマンスなど、注意すべき点も存在します。

### 利点

- Kotlinの特性を活かした型安全なクエリビルディング

- シンプルで柔軟なAPI

- 最小限の設定で始めることができる

### 注意点

- 大規模のプロジェクトには不向きな場合がある

- 特定のデータベース機能を利用したい場合、設定が必要となることも

## 1-8 まとめ

Kotlin Exposedのクエリビルダーは、Kotlinを用いた開発においてシンプルかつ型安全な方法でデータベース操作を行う強力なツールです。効率的にデータベースとやりとりを行いたい場合、Exposedを選択肢に加えると良いでしょう。今回の記事を通じ、基本的な設定や操作方法を把握することができたはずです。しかし、どのORMやデータベースライブラリを使うにしても、プロジェクトの特性やスケールに合った選択を心がけることが重要です。

Kotlin Exposed ORMによるクエリビルダーの使い方

目次

続きを読むには単価診断を受けてください（30秒）