ScalikeJDBC - SQL-Based DB Access Library for Scala

Just write SQL

ScalikeJDBC is A tidy SQL-based DB access library for Scala developers.

This library naturally wraps JDBC APIs and provides you easy-to-use APIs.

Users do nothing other than writing SQL and mapping from java.sql.ResultSet objects to Scala values.

If you want to create mapper modules easily, also take a look at scalikejdbc-mapper-generator.

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-mapper-generator

Supported RDBMS

We never release without passing all the unit tests with the following RDBMS.

• PostgreSQL
• MySQL
• H2 Database Engine
• HSQLDB

Scaladoc

http://seratch.github.com/scalikejdbc/api/index.html#scalikejdbc.package

Setup

sbt

libraryDependencies ++= Seq(
  "com.github.seratch" %% "scalikejdbc" % "[1.4,)",
  "postgresql" % "postgresql" % "9.1-901.jdbc4",  // your JDBC driver
  "org.slf4j" % "slf4j-simple" % "[1.7,)"         // slf4j implementation
)

Maven

<dependency>
  <groupId>com.github.seratch</groupId>
  <artifactId>scalikejdbc_2.9.2</artifactId>
  <version>[1.4,)</version>
</dependency>
<dependency>
  <groupId>postgresql</groupId>
  <artifactId>postgresql</artifactId>
  <version>9.1-901.jdbc4</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-simple</artifactId>
  <version>[1.7,)</version>
</dependency>

Try it now

Try ScalikeJDBC right now!

git clone git://github.com/seratch/scalikejdbc.git
cd scalikejdbc/sandbox
sbt console

"members" table is already created. You can execute queries as follows:

case class Member(id: Long, name: Option[String] = None)

val members: List[Member] = DB readOnly { implicit session => 
  SQL("select * from members")
    .map { rs => Member(rs.long("id"), rs.stringOpt("name")) }
    .list.apply()
}

val createdMember: Member = DB localTx { implicit session => 
  val id = SQL("insert into members (name) values ({name})")
    .bindByName('name -> Some("Charley")).updateAndReturnGeneratedKey.apply() 
  Member(id, Some("Charley"))
}

If you need more information(connection management, transaction, CRUD), please check the following wiki page or scaladoc in detail.

https://github.com/seratch/scalikejdbc/wiki/GettingStarted

Features

Basic SQL Template

The most basic way is just using prepared statement as follows.

SQL("""insert into members values (?, ?)""")
  .bind(132430, Some("Bob")).update.apply()

Named Parameters SQL Template

Instead of embedding ?(place holder), you can specify named place holder that is similar to Anorm.

SQL("insert into members values ({id}, {name})")
  .bindByName('id -> 132430, 'name -> Some("Bob"))
  .update.apply()

Executable SQL Template

Instead of embedding ?(place holder), you can specify executable SQL as template. Using this API, it's possible to validate SQL before building into application.

Usage is simple. Use Scala Symbol literal in comment with dummy value in SQL template, and pass named values by using not bind(Any*) but bindByName((Symbol, Any)*). When some of the passed names by #bindByName are not used, or #bind is used although the template seems to be executable SQL template, runtime exception will be thrown.

SQL("insert into members values (/*'id*/123, /*'name*/'Alice')")
  .bindByName('id -> 132430, 'name -> Some("Bob"))
  .update.apply()

SQLInterpolation since Scala 2.10

New powerful SQL template using SIP-11 String Interpolation.

def create(email: String, name: String, encryptedPassword: Sting): Member = {
  val id = sql"insert into members values (${email}, ${name}, ${encryptedPassword})"
    .updateAndReturnGeneratedKey.apply()
  Member(id, email, name, encryptedPassword)
}

See in detail:

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-interpolation

Flexible transactions

DB.autoCommit { session => }, DB.localTx { session => }, DB.withinTx { session => } and 'DB.readOnly { session => }` are supported.

In addition, passing AutoSession as an implicit parameter is quite useful. Like this:

object Member {
  def find(id: Long)(implicit session: DBSession = AutoSession): Option[Member] = {
    SQL("select * from members where id = ?").bind(id).map(*).single.apply() 
  }
  def setProfileVerified(member: Member)(implicit session: DBSession = AutoSession) = {
    SQL("update members set profile_verified = true where id = ?").bind(id).update.apply()
  }
}

Member.find(id) // new read-only session provided by AutoSession

Member.setProfileVerified(member) // new auto-commit session provided by AutoSession

DB localTx { implicit session =>
  // begin transaction 
  Member.findByName(name).foreach { member => 
    member.setProfileVerified(member)
  } 
  val mightBeUpdated = Member.find(id) 
  // end transaction
}

Logging SQL and timing

Using LogginSQLAndTime feature, you can check the actual SQL(not exactly) and time.

https://github.com/seratch/scalikejdbc/wiki/LoggingSQLAndTime

Source code generator

If you want to create mapper modules easily, also take a look at this sbt plugin.

sbt "scalikejdbc-gen [table-name (class-name)]"

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-mapper-generator

Testing support

Testing support for ScalaTest:

class AutoRollbackSpec extends fixture.FlatSpec with AutoRollback {

  override def fixture(implicit session: DBSession) {
    SQL("insert into members values (?, ?, ?)").bind(1, "Alice", DateTime.now).update.apply()
  }

  it should "create a new record" in { implicit session =>
    val before = Member.count() 
    Member.create(3, "Chris")
    Member.count() should equal(before + 1)
  }

}

for specs2(unit):

object MemberSpec extends Specification {

  "Member should create a new record" in new AutoRollback {
    val before = Member.count()
    Member.create(3, "Chris")
    Member.count() must_==(before + 1) 
  }

  trait AutoRollbackWithFixture extends AutoRollback {
    override def fixture(implicit session: DBSession) { ... }
  }

  "Member should ..." in new AutoRollbackWithFixture { ... }

}

Support for specs2(acceptance) is also available. See in detail:

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-test

Play! Framework 2.x support

You can use ScalikeJDBC with Play framework 2.x seamlessly.

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-play-plugin

We promise you that it becomes more useful when using together with scalikejdbc-mapper-generator.

dbconsle

dbconsole is an extended sbt console to connect database. Try it now!

• Mac OS X, Linux

curl -L http://git.io/dbconsole | sh

• Windows

http://git.io/dbconsole.bat

https://github.com/seratch/scalikejdbc/tree/master/scalikejdbc-cli

ScalikeJDBC Cookbook on the Kindle store

"ScalikeJDBC Cookbook" is the e-book for ScalikeJDBC users.

https://github.com/seratch/scalikejdbc-cookbook

License

Apache License, Version 2.0

http://www.apache.org/licenses/LICENSE-2.0.html