ScalikeJDBC 入門

最近 Scala を始めたので、DB 処理によく使用されているのを見る ScalikeJDBC を触ってみます。

GetStarted
Typeseaf Config を使用した初期化
SQLSyntaxSupport の使用
Query DSL の使用

環境

scala: 2.12
sbt: 0.13.15
scalikejdbc: 3.0.0

1. GetStarted

ScalikeJDBC の使い始めとして最もシンプルな使い方を押さえておきます。この使い方ではコードを読んで何を行っているかがすぐにわかるぐらいシンプルに処理を書くことができます。一方で Connection を明示的に初期化する必要がある等少し煩雑なところもあります。

ScalikeJDBC の使用には以下のライブラリが必要です (version は適宜変更)。 h2 に関しては使用する DB が異なればそれに応じた JDBC Driver を代わりに用意することになります。

"org.scalikejdbc" %% "scalikejdbc" % "3.0.0"
"ch.qos.logback" % "logback-classic" % "1.2.3"
"com.h2database" % "h2" % "1.4.195"

ScalikeJDBC を使用したコード例は以下の通りです。

(1) JDBC ドライバの読込
(2) コネクションプールのセットアップ
- 複数のデータソースを使用することも可能 (ref. コネクション管理)
(3) scalikejdbc.DB を使用してセッションの開始 (ref. トランザクション)
- autoCommit, readOnly, localTx, withinTx といったものがある
(4) sql 補完子によるクエリの定義
- 本来プレイスホルダを置く位置に $var_name のようにして直接変数を埋め込める
- この値はプレイスホルダ使用時と同様エスケープ処理される

import scalikejdbc._

/**
 * Insert and select records from a created 'members' table.
 */
object BasicSample extends App {

  // (1)
  Class.forName("org.h2.Driver")
  // (2)
  ConnectionPool.singleton("jdbc:h2:mem:hello", "user", "pass")

  // (3)
  DB autoCommit { implicit session =>
    sql"""
      create table members (
        id serial not null primary key,
        name nvarchar(64),
        created_at timestamp not null
      )
    """.execute.apply()
  }

  DB localTx { implicit session =>
    Seq("Alice", "Bob", "Chris") foreach { name =>
      // (4)
      sql"insert into members (name, created_at) values ($name, current_timestamp)".update.apply()
    }
  }

  DB readOnly { implicit session =>
    // (4)
    val entities: List[Map[String, Any]] = sql"select * from members".map(_.toMap).list.apply()
    println(entities)
  }

}

2. Typeseaf Config を使用した初期化

上の 1. で少し煩雑だったところをうまくやるために、Typeseaf Config を使用した Connection のセットアップを行います。まずプロジェクトに以下のライブラリを追加します (version は適宜変更)。

"org.scalikejdbc" %% "scalikejdbc-config" % "3.0.0"

次に scr/main/resources/application.conf に Connection の設定等を書きます。ここでは Connection Pool の設定は全てデフォルトのものを使用するのでコメントアウトしています。

# JDBC settings
db.default.driver="org.h2.Driver"
db.default.url="jdbc:h2:mem:hello"
db.default.user="user"
db.default.password="pass"

# Connection Pool settings
# db.default.poolInitialSize=5
# db.default.poolMaxSize=7
# db.default.poolConnectionTimeoutMillis=1000
# db.default.poolValidationQuery="select 1 as one"
# db.default.poolFactoryName="commons-dbcp"

使用時には scalikejdbc.config.DBs を使用して初期化を行います。そのあとは 1. と同様です。

import scalikejdbc._
import scalikejdbc.config._

object ConfigSample extends App {

  // Load `application.conf` and setup.
  DBs.setupAll()

  DB autoCommit { implicit session =>
  ...
  }
}

3. SQLSyntaxSupport の使用

scalikejdbc.SQLSyntaxSupport は ResultSet とモデル間の変換まわりの記述量を減らすために定義されている trait です (ref. SQLSyntaxSupport)。

ここからは Group と Member という 1 対多の関係を持つモデルを使用していきます。

(1) モデルを表すクラスのコンパニオンオブジェクトに SQLSyntaxSupport を実装させる
- schema, table の指定
- ResultSet から対象オブジェクトを作成するための apply メソッドの実装

import org.joda.time.DateTime
import scalikejdbc._

case class Group(id: Long, name: String, createdAt: DateTime)

// (1)
object Group extends SQLSyntaxSupport[Group] {

  override val schemaName: Option[String] = None
  override val tableName: String = "groups"

  def apply(g: ResultName[Group])(rs: WrappedResultSet): Group = {
    Group(rs.long(g.id), rs.string(g.name), rs.jodaDateTime(g.createdAt))
  }

}

// Cannot remove groupId to use in query...
case class Member(id: Long, name: Option[String], groupId: Long, group: Group, createdAt: DateTime)

// (1)
object Member extends SQLSyntaxSupport[Member] {

  override val schemaName: Option[String] = None
  override val tableName: String = "members"

  def apply(m: ResultName[Member], g: ResultName[Group])(rs: WrappedResultSet): Member = {
    val group = Group(g)(rs)
    Member(rs.long(m.id), rs.stringOpt(m.name), rs.long(m.groupId), group, rs.jodaDateTime(m.createdAt))
  }

}

実際にクエリを作成するコードは以下のようになります。

(2) 上で定義したコンパニオンオブジェクトの column フィールドにモデルが持つカラム一覧が入っている
- 初回テーブルアクセス時に取得してきている?
(3) (2) で取得した column を使用して INSERT クエリを投げる
(4) SELECT に関しては、はじめにコンパニオンオブジェクトの syntax メソッドを実行し、それを利用してクエリを作成する
- m.id, m.result.id, m.resultName がそれぞれ違う意味を持っていることに注意

import com.tiqwab.example.scalikejdbc.model.{Group, Member}
import scalikejdbc._
import scalikejdbc.config._

object SyntaxSupportSample extends App {

  DBs.setupAll()

  DB autoCommit { implicit session =>
    sql"""
      create table groups (
        id serial not null primary key,
        name nvarchar(64) not null,
        created_at timestamp not null
      )
    """.execute.apply()

    sql"""
      create table members (
        id serial not null primary key,
        name nvarchar(64),
        group_id bigint,
        created_at timestamp not null,
        foreign key (group_id) references groups (id)
      )
    """.execute.apply()
  }

  DB localTx { implicit session =>
    // (2)
    val g = Group.column
    Seq("group1", "group2") foreach { name =>
      // (3)
      sql"insert into ${Group.table} (${g.name}, ${g.createdAt}) values ($name, current_timestamp)".update.apply()
    }
    // (2)
    val m = Member.column
    Seq(("Alice", 1), ("Bob", 1), ("Chris", 2)) foreach {
      case (name, groupId) =>
        // (3)
        sql"insert into ${Member.table} (${m.name}, ${m.groupId}, ${m.createdAt}) values ($name, $groupId, current_timestamp)".update.apply()
    }
  }

  DB readOnly { implicit session =>
    // (4)
    val (m, g) = (Member.syntax("m"), Group.syntax("g"))
    val member =
      sql"""
        select
          ${m.result.*}, ${g.result.*}
        from
          ${Member as m} inner join ${Group as g}
        where
          ${m.groupId} = ${g.id}
      """.map(Member(m.resultName, g.resultName)(_)).first.apply()
    println(member)
  }

}

4. Query DSL の使用

最後に型安全に SQL を構築できる Query DSL を使用してみます (ref. Query DSL)。上の 3. で使用した例を Query DSL で書き直すと以下のようになります。

(1) withSQL の中で SQL like なメソッドチェーンによりクエリを構築する

import com.tiqwab.example.scalikejdbc.model.{Group, Member}
import org.joda.time.DateTime
import scalikejdbc._
import scalikejdbc.config._

object QuerySample extends App {

  DBs.setupAll()

  DB localTx { implicit session =>
    val (m, g) = (Member.column, Group.column)
    Seq("group1", "group2") foreach { name =>
      // (1)
      withSQL {
        insert.into(Group).columns(g.name, g.createdAt).values(name, DateTime.now)
      }.update.apply()
    }
    Seq(("Alice", 1), ("Bob", 1), ("Chris", 2)) foreach {
      case (name, groupId) =>
        // (1)
        withSQL {
          insert.into(Member).columns(m.name, m.groupId, m.createdAt).values(name, groupId, DateTime.now)
        }.update.apply()
    }
  }

  DB.readOnly { implicit session =>
    val id = 1
    val (m, g) = (Member.syntax("m"), Group.syntax("g"))
    // (1)
    val member = withSQL {
      select.from(Member as m).innerJoin(Group as g).on(m.groupId, g.id)
        .where.eq(m.id, id)
    }.map(Member(m.resultName, g.resultName)(_)).single.apply()
    println(member)
  }

}

環境

1. GetStarted

2. Typeseaf Config を使用した初期化

3. SQLSyntaxSupport の使用

4. Query DSL の使用

References