Version 0.3

Q: どの依存関係を設定すればよいですか？

A: ldbcを利用するには、用途に応じて以下の依存関係を設定する必要があります。

コネクタ

ldbcを使用してデータベース接続処理を行うには以下のいずれかの依存関係を設定します。

jdbc-connector

Javaで書かれた従来のコネクタを使用する場合は以下の依存関係を設定します。

libraryDependencies ++= Seq(
  "io.github.takapi327" %% "jdbc-connector" % "0.3.0-beta11",
  "com.mysql" % "mysql-connector-j" % "8.4.0"
)

ldbc-connector

Scalaで書かれた新しいコネクタを使用する場合は以下の依存関係を設定します。

libraryDependencies ++= Seq(
  "io.github.takapi327" %% "ldbc-connector" % "0.3.0-beta11"
)

ldbc-connectorは、JVMだけではなくJS, Nativeのプラットフォームでも動作します。

Scala.jsやScala Nativeでldbcを使用する場合は、以下のように依存関係を設定します。

libraryDependencies ++= Seq(
  "com.example" %%% "ldbc-connector" % "0.3.0-beta11"
)

プレーンなDSL

プレーンなDSLを使用する場合、以下の依存関係を設定します.

libraryDependencies ++= Seq(
  "io.github.takapi327" %% "ldbc-dsl" % "0.3.0-beta11"
)

プレーンなDSLは、シンプルなSQL文をそのまま記述する方法です。たとえば、直接SQLリテラルを用いてクエリを実行できます。

import ldbc.dsl.*

val plainResult = sql"SELECT name FROM user"
  .query[String]
  .to[List]
  .readOnly(conn)
// plainResultはList[String]として返される

クエリビルダー

クエリビルダーを使用する場合、以下の依存関係を設定します.

libraryDependencies ++= Seq(
  "io.github.takapi327" %% "ldbc-query-builder" % "0.3.0-beta11"
)

クエリビルダーは、型安全なAPIでクエリを構築できる方法です。次の例では、Userモデルを定義し、TableQueryを使ってSELECT文を構築しています。

import ldbc.dsl.codec.Codec
import ldbc.query.builder.*

case class User(id: Int, name: String, email: String) derives Table
object User:
  given Codec[User] = Codec.derived[User]

val userQuery = TableQuery[User]
  .select(user => user.id *: user.name *: user.email)
  .where(_.email === "alice@example.com")

// userQuery.statementは "SELECT id, name, email FROM user WHERE email = ?" として生成される

スキーマ定義とモデルマッピング

スキーマ定義とモデルマッピングを使用する場合、以下の依存関係を設定します.

libraryDependencies ++= Seq(
  "io.github.takapi327" %% "ldbc-schema" % "0.3.0-beta11"
)

スキーマ定義とモデルマッピングを利用すると、テーブル定義とScalaモデルとの1対1のマッピングを実現できます。以下は、Userテーブルを定義する例です。

import ldbc.schema.*

case class User(id: Long, name: String, email: String)

class UserTable extends Table[User]("user"):
  def id: Column[Long] = bigint().autoIncrement.primaryKey
  def name: Column[String] = varchar(255)
  def email: Column[String] = varchar(255)
  
  override def * : Column[User] = (id *: name *: email).to[User]

val userQuery = TableQuery[UserTable]
  .select(user => user.id *: user.name *: user.email)
  .where(_.email === "alice@example.com")

// userQuery.statementは "SELECT id, name, email FROM user WHERE email = ?" として生成される

参考資料