テーブルスキーマ定義方法

スキーマクラス models.Tables の定義

スキーマクラスでは、データベース上のテーブル名とScalaのモデルクラスとのマッピングを設定します。
定義する箇所はデフォルトでは models.Tables オブジェクトとなります。(変更・追加する場合はデータベース接続設定の設定方法を参照ください)

スキーマ定義は com.github.aselab.activerecord.ActiveRecordTables を継承したオブジェクト上に定義します。
モデルとテーブルのマッピングは、 table メソッドでcom.github.aselab.activerecord.ActiveRecord の型を継承した
モデルを指定した定数を定義することで行われます。（定数名は何でも構いません）

以下の例は Person モデルのスキーマ定義のサンプルです。

備考 : デフォルトではモデルと対応するテーブル名はモデルクラス名を小文字化してアンダースコア区切りの複数形にしたものとなります。
(例: UserAccount モデルの場合、user_accounts)
引数で指定すると任意のテーブル名に変更することが可能です。

例: スキーマ定義 `src/main/scala/models/Tables.scala`

package models

import com.github.aselab.activerecord._

object Tables extends ActiveRecordTables {
  val people = table[Person]
  // テーブル名を任意のものに変更したい場合
  // val people = table[Person]("people")
}

テーブル定義の初期化とクリーンアップ

モデルクラスとテーブル定義を行った場合、Tables#initialize を使用前に必ず実行する必要があります。
Tables#initialize の実行時に定義したテーブルが存在しない場合、デフォルトの挙動ではテーブルを自動的に作成します。
（この挙動はデータベース接続設定の autoCreate設定で変更可能です）
自動生成されるテーブルのカラム定義（DDL）については Tables#ddl で文字列を確認できます。

また、資源の解放をプログラム終了前に行う必要がある場合は Tables#cleanup を実行してください。

// Scala ActiveRecordを使用する前に必ず呼び出すこと
Tables.initialize

...

// 解放処理を実行
Tables.cleanup

カラムのより詳細な定義方法

備考 : 詳細につきましては Squeryl ライブラリのマニュアルを参照ください

Tables#initialize でテーブルが存在しない場合に実施されるテーブル作成処理で Tables#ddl の実行結果が使用されますが、
その際にDBテーブルの属性（ユニーク属性、インデックス、自動インクリメントなど）の詳細定義を変更したい場合、
以下の例のようにtable[T] (TはActiveRecordモデル) で定義した変数に対して squerylの形式のテーブル定義を実施することで可能です。

例 : テーブルのカラムの属性変更

package models

import com.github.aselab.activerecord._
import com.github.aselab.activerecord.dsl._

object Tables extends ActiveRecordTables {
  val people = table[Person]

  on(people)(t => declare(
    t.name is(unique, indexed("idxPeopleName"), dbType("varchar(255)")),
    t.name defaultsTo("defaultName"),
    t.age  is(indexed)
  ))
}

テーブル接続ルール設定

デフォルトの命名規則ルール

タイプ	命名規則	例
テーブル名	モデルクラス名を小文字化してアンダースコア区切りの複数形にしたもの	UserAccount => user_accounts
中間テーブル名	テーブル名をアルファベット順にソートしてアンダースコア区切りの複数形にしたもの	User, Group => groups_users
変数名とDBカラム名の対応	Scalaモデルの変数名をアンダースコア区切りにしたもの	fieldName => field_name
外部キー用変数名	関連モデル名のキャメルケース + “Id”	ModelClass => modelClassId

命名規則ルールの設定上書き

デフォルトでは上記に示すようにScala ActiveRecordのテーブル名・カラム名命名規則はRuby on RailsのActiveRecordの規約に沿った形が基本となっています。
上記の動作は com.github.aselab.activerecord.ActiveRecordTables のメソッドをスキーマ定義時にオーバーライドすることで設定変更が可能です。

例: 命名規則上書き `src/main/scala/models/Tables.scala`

import com.github.aselab.activerecord._
import com.github.aselab.activerecord.dsl._

object Tables extends ActiveRecordTables {
  // テーブル名の命名規則を ModelClass => "MODEL_CLASS" のように変更する場合
  override def tableNameFromClass(c: Class[_]): String =
    c.getSimpleName.underscore.toUpperCase

  // 中間テーブル名の命名規則を (ModelClass1, ModelClass2) => "MODEL_CLASS1___MODEL_CLASS2" のように変更する場合
  override def tableNameFromClasses(c1: Class[_], c2: Class[_]): String =
    Seq(c1, c2).map(tableNameFromClass).sorted.mkString("___")

  // 変数名とDBカラム名の対応の規則を ModelField => "MODEL_FIELD" に変更する場合
  override def columnNameFromPropertyName(propertyName: String): String  =
     propertyName.underscore.toUpperCase

  // 外部キー用変数の命名規則を ModelClass => "modelClass_id" に変更する場合
  override def foreignKeyFromClass(c: Class[_]): String =
    c.getSimpleName.camelize + "_id"
}