Migrate クラス

Migrate クラスを使用すると、コントローラからマイグレーションの検証を行ったり、戻したりすることができます。 マイグレーションはアプリケーションのモジュールとパッケージでサポートされます。

current($name = 'default', $type = 'app')

Migrates to the current schema set in the migration configuration file.

静的 はい
パラメータ
パラメータ デフォルト 説明
$name
'default'
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。
$type
'app'
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。
返り値 array
// アプリケーションを現在のスキーマまでマイグレーションする
Migrate::current('default', 'app');

latest($name = 'default', $type = 'app')

マイグレーションの設定で設定されている最新のスキーマにマイグレーションします。

静的 はい
パラメータ
パラメータ デフォルト 説明
$name
'default'
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。
$type
'app'
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。
戻り値 array
// パッケージ 'mypackage' を最新のスキーマまでマイグレーションする
Migrate::latest('mypackage', 'package');

version($version, $name = 'default', $type = 'app')

version メソッドは特定のマイグレーションバージョンのスキーマにマイグレーションします。

静的 はい
パラメータ
パラメータ デフォルト 説明
$version 必須 マイグレーションしたいバージョン。 null を指定した場合には最新のバージョンにマイグレーションします。
$name
'default'
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。
$type
'app'
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。
返り値 array
// モジュール 'mymodule' をバージョン 10 にマイグレーションする
Migrate::version(10, 'mymodule', 'module');

up($version, $name = 'default', $type = 'app')

The version method will move the migrations up by one, or up to a specific version if given.

Static Yes
Parameters
Param Default Description
$version required The version you want to migrating up to. If you specify null, it will migrate up to the next version.
$name
'default'
Name of the package or module. In case of app, 'default' is used.
$type
'app'
Type of migration. Valid values are 'app', 'module' and 'package'.
Returns array
Example
// migrate the module 'mymodule' up to version 10
Migrate::up(10, 'mymodule', 'module');

down($version, $name = 'default', $type = 'app')

The version method will move the migrations down by one, or down to a specific version if given.

Static Yes
Parameters
Param Default Description
$version required The version you want to migrating down to. If you specify null, it will migrate down to the next version.
$name
'default'
Name of the package or module. In case of app, 'default' is used.
$type
'app'
Type of migration. Valid values are 'app', 'module' and 'package'.
Returns array
Example
// migrate the module 'mymodule' down to version 10
Migrate::down(10, 'mymodule', 'module');

All methods return an array, specifying a list a migration files ( file names only! ) executed.
If no migrations where found, or if the version specified resulted in no migrations being executed, the array returned is empty.