「[:ja]データベース[:en]Database[:]」タグアーカイブ

FuelPHP で複数データベースへ migration を行うやり方を説明します。 FuelPHP 1.7.2 を想定しています。

FuelPHP では php oil g model item name:string などのようにすると、 model と migration のためのコードが生成されます。 php oil g scaffold ... とやった場合にも migration のコードが生成されます。ここで生成される migration コードに手を加えることで複数データベースに対応させることができます。

変更前のコード

<?php
namespace Fuel\Migrations;
class Create_items
{
public function up()
{
\DBUtil::create_table('items', array(
'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),
'name' => array('constraint' => 255, 'type' => 'varchar'),
'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
), array('id'));
}
public function down()
{
\DBUtil::drop_table('items');
}
}

<?php

namespace Fuel\Migrations;

class Create_items

{

public function up()

{

\DBUtil::create_table('items', array(

'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),

'name' => array('constraint' => 255, 'type' => 'varchar'),

'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

), array('id'));

}

public function down()

{

\DBUtil::drop_table('items');

}

変更後のコード

<?php
namespace Fuel\Migrations;
class Create_items
{
public function up()
{
\DBUtil::create_table('items', array(
'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),
'name' => array('constraint' => 255, 'type' => 'varchar'),
'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
), array('id'), true, false, null, array(), 'db_config_key');
}
public function down()
{
\DBUtil::drop_table('items', 'db_config_key');
}
}

<?php

namespace Fuel\Migrations;

class Create_items

{

public function up()

{

\DBUtil::create_table('items', array(

'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),

'name' => array('constraint' => 255, 'type' => 'varchar'),

'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

), array('id'), true, false, null, array(), 'db_config_key');

}

public function down()

{

\DBUtil::drop_table('items', 'db_config_key');

}

db_config_key というのを付け加えました。このパラメータでデータベースを指定できます。具体的には config/db.php 内のキーになります。たとえば 'default' なんてのが入ります。何も指定がなければ 'default' が採用されます。

このようにして複数データベースに対応させることができます。 migration のコードごとにデータベースを書き換えればいいですからね。

Model のコードを活用した書き方

Model を利用してやってみましょう。

<?php
namespace FuelMigrations;
class Create_items
{
public function up()
{
DBUtil::create_table(Model_Item::table(), array(
'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),
'name' => array('constraint' => 255, 'type' => 'varchar'),
'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),
), Model_Item::primary_key(), true, false, null, array(), Model_Item::connection());
}
public function down()
{
DBUtil::drop_table(Model_Item::table(), Model_Item::connection());
}
}

<?php

namespace FuelMigrations;

class Create_items

{

public function up()

{

DBUtil::create_table(Model_Item::table(), array(

'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),

'name' => array('constraint' => 255, 'type' => 'varchar'),

'created_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

'updated_at' => array('constraint' => 11, 'type' => 'int', 'null' => true),

), Model_Item::primary_key(), true, false, null, array(), Model_Item::connection());

}

public function down()

{

DBUtil::drop_table(Model_Item::table(), Model_Item::connection());

}

Model_Item が Orm を使っているという前提の話ですが、データベースの指定に Model_Item::connection() を、テーブルの指定に Model_Item::table() を、主キーの指定に Model_Item::primary_key() を使っています。このようにすると、 model の中に書いておけば migration のコードを変更しなくても済みます。 (ただし既存テーブルについて model のテーブル名や $_connection を変更する場合には注意が必要になります。)

この記事を見た人は次の記事も見ています

コード

FuelPHP で使用可能なデータベース

2014年12月05日 Kenji

FuelPHP でどのデータベースが使えるのか、コードを覗いてみました。

環境

FuelPHP 1.8 (GitHub)

使用可能なデータベース

FuelPHP では次の DBMS を扱うことができます。扱うことができるといってもドライバとして参照するというだけで、完璧に使えるわけではありません。

Cubrid
FreeTDS
Microsoft SQL Server
Sybase
~~Firebird~~
IBM DB2
IBM Informix Dynamic Server
MySQL
Oracle Call Interface
ODBC v3 (IBM DB2, unixODBC and win32 ODBC)
PostgreSQL
SQLite 3, 2
SQL Azure
4D

調べ方

まずはマニュアルを読みます。 Database Introduction のところに Can be mysql, mysqli or pdo とあります。つまり、 mysql の専用ドライバか、PDOドライバが使えるんですね。

続いて PDO について PHP のドキュメントを確認します。すると、上述の DBMS すべてについて PDO が使えることがわかります。もちろん PDOドライバがマシンに入っていればの話ですし、PDOとDBMSのバージョンには気をつけないといけませんね。

本当に PDO で繋がるのか？と思ったら、 FuelPHP のコアファイルの中の接続部分を担っているコードを見ましょう。 mysql, mysqli, PDO の3通りの connection.php があり、 PDO であれば PDO ドライバを使って DB に接続するようになっていることがわかります。

sqlite を使う場合の注意点

sqlite を使う場合にはいくつか気をつけることがあります。 (FuelPHP version 1.7.2)

Primary Key に注意

Primary Key を他のデータベースと同じように設定しようとすると migration が動きません。 sqlite3 では、 Primary Key に名前をつけることができません。例えば MySQL なら Primary Key id (id) となるところが、 sqlite3 だと Primary Key (id) というようになります。

直接SQLを作って実行するか、 FuelPHP の該当箇所を書き換えるかして凌ぐしかないです。 Primary Key を使わないという選択肢もありますが、おすすめはしません。

また通常は migration file を php oil を使って作成すると自動で UNSIGNED の id が作成されて AUTO_INCREMENT が設定されますが、 sqlite ではこれが動きません。 sqlite では AUTO_INCREMENT ではなく AUTOINCREMENT になります。いまのところ自動生成のスクリプトでは対応していませんので FuelPHP の core のコードを変更する必要があります。そして自動生成される UNSIGNED は削除しましょう。 sqlite では UNSIGNED BIT INT というのが使えますが、使ったところで INTEGER と解釈されます。

charset を空にする

sqlite3 では charset の指定方法が他のデータベースとは異なります。 PRAGMA statement を使います。 (確か sqlite3 では標準文字コードが utf-8 だったと思います。)

データベースの設定(config/db.php)で文字コードの指定をしないと php oil migrate を実行する際に CREATE TABLE の構文で末尾に DEFAULT CHARACTER SET utf8 のついたSQLが発行されてしまい、エラーになります。これを防ぐためには charset => '' と、 charset に空文字列を指定します。すると、 DEFAULT から始まる文字コード指定部分がなくなり、 sqlite3 でも php oil migrate が動くようになります。

db.php は次のように書きます。

<?php
return array(
'default' => array(
'type' => 'pdo',
'connection'  => array(
'dsn'        => 'sqlite:'.APPPATH.'migrations/'.Fuel::$env.'.sqlite3',
),
'table_prefix' => '',
'charset' => '',
),
);

<?php

return array(

'default' => array(

'type' => 'pdo',

'connection' => array(

'dsn' => 'sqlite:'.APPPATH.'migrations/'.Fuel::$env.'.sqlite3',

'table_prefix' => '',

'charset' => '',

);

このようにすると、環境ごとに別の DB が作成されます。 table_prefix は php oil r migration の時には不要ですが、 php oil r migration:down の時に必要になることがあります。

PostgreSQL を使う場合の注意点

migration ファイルを作っても動きません。これは Syntax が MySQL とだいぶ違うからです。 FuelPHP に PostgreSQL を使うためのプラグインがあるのでそちらを使うという方法もあります。

charset を空にする

charset に値が入っていると接続情報(dns)に charset が含まれるようになるのですが、 PostgreSQL はこれを受け付けません。そこで charset = '' と設定しておきましょう。この点は SQLITE と同じです。

constraint を削除する

php oil g migration create_xxx のようにしてテーブル作成のマイグレーションファイルを作成すると、 id カラムが自動的に作成され、 'constraint' => 11 という設定がされます。この状態だとテーブル作成の SQL で id カラムは INT(11) に指定されます。しかし、 PostgreSQL は INT(11) を受け付けません。 INT なら SQL が通ります。

そこで 'constraint' => 11 の設定を削除します。