CakePHP3のMigrationsでDB接続先を切り替える方法

CakePHP3 の Migrations コマンドを使ってマイグレーションする際、DB 接続先を明示的に指定することが出来ます。

この記事の内容は、以下のように CakePHP の設定ファイルに複数の Datasource が設定されていることが前提になります。

config/app.php:

    /**
     * Connection information used by the ORM to connect
     * to your application's datastores.
     * Do not use periods in database name - it may lead to error.
     * See https://github.com/cakephp/cakephp/issues/6471 for details.
     * Drivers include Mysql Postgres Sqlite Sqlserver
     * See vendor\cakephp\cakephp\src\Database\Driver for complete list
     */
    'Datasources' => [
        'default' => [
            // 省略
        ],
        'my_other_connection' => [
            // 省略
        ]
    ],

Datasource を指定するオプション

例えば config/app.php で設定した my_other_connection の Datasource に接続する場合、以下のように -c オプションにデータソース名を指定します。

./bin/cake migrations migrate -c my_other_connection

また、以下のように接続先を指定しないとデフォルトの Datasource が使用されます。

./bin/cake migrations migrate

ただし、この方法は全てのマイグレーションファイルで指定した接続先が使用されます。マイグレーションファイルごとに接続先を切り替えたい場合は以下を参照してください。

マイグレーションファイルごとに接続先を切り替える方法

少しアナログな方法にはなりますが、少し手を加えることで実現できます。

まず、以下のように接続先ごとにフォルダを分けて、その中にマイグレーションファイルを入れておきます。

  • config/Migrations/default (default コネクション用フォルダ)
  • config/Migrations/other (my_other_connection コネクション用フォルダ)

この状態でマイグレーションをするときに -s (–source=SOURCE) オプションで上記のディレクトリを指定してマイグレーションします。

./bin/cake migrations migrate -c default -s Migrations/default

./bin/cake migrations migrate -c my_other_connection -s Migrations/other

マイグレーションの実行履歴はコネクションごとの phinxlog テーブル上で管理されるため、バッティングせずにマイグレーション出来ます。

コマンドオプション指定の組み合わせは間違えないよう注意する必要があります。

商品の販売スケジュールを管理するテーブル設計パターン

商品とその販売スケジュールを管理するためのテーブル設計をするとき、販売スケジュールの情報を別テーブルに分離しておくと再利用性の高い作りに出来る場合があります。一つの設計パターンとしてメモしておきます。

例えば、以下の様な販売方法に対応したいとします。

  • 同時に複数の商品を販売する
  • 期間ごとに販売する商品の組み合わせ(商品セット)が異なる
  • 一度販売した商品の組み合わせは以降も使いまわす場合がある

つまりこういったケースです。

  • 1月に販売する商品
    • 商品A
    • 商品B
  • 2月に販売する商品
    • 商品C
  • 3月に販売する商品(1月の商品セットの使い回し)
    • 商品A
    • 商品B

テーブル設計例

products テーブル(商品)

  • id INT AUTO_INCREMENT
  • name VARCHAR COMMENT ‘商品名’

product_sets テーブル(商品セット)

  • id INT AUTO_INCREMENT
  • name VARCHAR COMMENT ‘商品セット名’
  • is_default BOOL COMMENT ‘基本商品セットフラグ’

product_set_relations テーブル(商品セットに属する商品)

  • id INT AUTO_INCREMENT
  • product_set_id INT
  • product_id INT

product_set_sale_schedules テーブル(商品セットの販売スケジュール)

  • id INT AUTO_INCREMENT
  • product_set_id INT
  • start_datetime DATETIME COMMENT ‘販売開始日時’
  • end_datetime DATETIME COMMENT ‘販売終了日時’

上記スキーマの解説

まず products テーブルに商品情報を持ちます。商品の種類の数だけレコードが出来ます。

そして複数の商品をまとめた商品セットを product_sets としてまとめ、その商品セットの販売期間の情報を product_set_sale_schedules に持つという構成です。

product_set_relations テーブルは多:多のリレーションを解消するための中間テーブルです。商品セットに属する商品一覧の情報を持ちます。

一度販売した商品セットは今後のスケジューリングでも使い回すことが出来ます。

もし期間に該当する商品セットがあった場合、それが優先して有効な商品セットとなりますが、該当するスケジュール情報が無かった場合は is_default が立っている基本商品セットが有効になります。こうしておくことで該当する販売スケジュールのデータが無かった場合のフォールバックが可能となり、常に何かを販売し続けることができます。(その必要が無ければ不要)

また、過去の販売スケジュールの履歴はスケジュールテーブルに蓄積して残すことが出来るため、後から過去の販売スケジュールを確認することができます。

今回の設計パターンについて補足

今回は少し要件が特殊だと思うので、実際には要件に合わせて構成を見なおした方がいいと思います。(設計パターンとか書いておいてすみません。)

例えば今回用いた「商品セット」という概念は、商品の組み合わせの再利用をしやすくする一方で、細やかな組み合わせの変更を難しくしています。

再利用されるケースが少ない場合は商品セットテーブルを無くしてしまい、商品ごとにスケジュールを設定する構成にしたほうが柔軟に対応できるでしょう。

「運用でカバー」は悲しい

運用でカバーという名のもと無駄なデータが生まれていくのは設計者として悲しいことです。

要件をよく確認して適切にテーブル設計をしていきたいものです。

CakePHP3のPHPUnitをブラウザからテストする方法

CakePHP2 まで PHPUnit の Webrunner (webroot/test.php) が公式で提供されていましたが、CakePHP3 からはこれが削除されてしまいました。

CakePHP 3.x Migration Guide によると、「ユニットテストをしたい人は CLI による PHPUnit をインストールしてね。更にブラウザからテストしたい人は VisualPHPUnit (Webrunner) を別途インストールしてね。」という方針のようです。

便利だったのに残念ですね(´・_・`)

VisualPHPUnit とは

PHPUnit をウェブブラウザから実行してくれる外部ツールです。これまでの test.php で出来ていたことは大体出来ると思います。

UI はこのような感じで、なかなかお洒落。

VisualPHPUnit のスクリーンショット

インストールにあたっての前提

この記事のインストール方法は PHPUnit がインストール済みで、CLI から UnitTest が行える状態になっていることが前提です。

もしまだの場合、公式ドキュメントの Installing PHPUnit の項を参照してみてください。

CakePHP3.x に VisualPHPUnit をインストールする手順

今のところ公式 Cookbook にはインストール方法が載っていない為、独自の方法になります。

基本には VisualPHPUnit の README の説明の通りで、VisualPHPUnit を公開ディレクトリに入れて設定してアクセスするだけです。(本当は composer でインストールしたい..)

1. VisualPHPUnit をダウンロードする

VisualPHPUnit のリポジトリから Download ZIP してきます。git clone でも大丈夫だと思います。

2. webroot に VisualPHPUnit を入れる

ZIP 展開後のディレクトリを test にリネームして webroot/test に配置します。

3. キャッシュディレクトリの書き込み権限を設定する

webroot/test/app/resource/cache ディレクトリの権限を 777 にします。

chmod 777 -R webroot/test/app/resource/cache

4. 設定ファイルの設定を行う

設定ファイルの webroot/test/app/config/bootstrap.php を開いて以下の3箇所を書き換えます。

composer_vendor_path のパス

// 'composer_vendor_path' => $root . '/vendor',
'composer_vendor_path' => $root . '/../../vendor',

test_directories のパス

    'test_directories' => array(
        //'Sample Tests' => "{$root}/app/test",
        //'My Project' => '/var/www/sites/my.awesome.site.com/laravel/tests',
        'App' => "{$root}/../../tests/TestCase",
    ),

bootstraps のパス

    'bootstraps' => array(
        // '/path/to/bootstrap.php',
        //'/var/www/sites/my.awesome.site.com/laravel/bootstrap/autoload.php',
        "{$root}/../../tests/bootstrap.php",
    )

5. 必要に応じてウェブサーバの設定やその他設定を行う

Apache や nginx の追加設定が必要な場合があります。VisualPHPUnit の README を参照してみてください。

以上でインストール完了です。

使い方

ブラウザから webroot/test ディレクトリにアクセスし、左側の FILES 欄でテストしたいテストケースを選択し「Run Tests」をクリックするとテスト結果が表示されます。

URL例: http://example.com/test/

ちなみに TestCase 上で echo や var_dump() をすると結果画面上にデバッグ用として出力してくれるので便利です。

2016/02/22更新: 設定の test_directories のパス定義に /TestCase を追加しました。