Migrate クラス
Migrate クラスを使用すると、コントローラからマイグレーションの検証を行ったり、戻したりすることができます。
マイグレーションはアプリケーションのモジュールとパッケージでサポートされます。
current($name = 'default', $type = 'app')
マイグレーションの設定で設定されている現在のスキーマにマイグレーションします。
| 静的 |
はい |
| パラメータ |
| パラメータ |
デフォルト |
説明 |
| $name |
'default'
|
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。 |
| $type |
'app'
|
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。 |
|
| 返り値 |
bool |
| 例 |
// アプリケーションを現在のスキーマまでマイグレーションする
Migrate::current('default', 'app');
|
latest($name = 'default', $type = 'app')
マイグレーションの設定で設定されている最新のスキーマにマイグレーションします。
| 静的 |
はい |
| パラメータ |
| パラメータ |
デフォルト |
説明 |
| $name |
'default'
|
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。 |
| $type |
'app'
|
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。 |
|
| 返り値 |
bool |
| 例 |
// パッケージ 'mypackage' を最新のスキーマまでマイグレーションする
Migrate::latest('mypackage', 'package');
|
version($version, $name = 'default', $type = 'app')
version メソッドは特定のマイグレーションバージョンのスキーマにマイグレーションします。
| 静的 |
はい |
| パラメータ |
| パラメータ |
デフォルト |
説明 |
| $version |
必須 |
マイグレーションしたいバージョン。 null を指定した場合には最新のバージョンにマイグレーションします。 |
| $name |
'default'
|
パッケージまたはモジュールの名前。マイグレーションタイプが app の場合には 'default' が使用されます。 |
| $type |
'app'
|
マイグレーションのタイプ。 'app', 'module', 'package' のいずれかの値が設定可能です。 |
|
| 返り値 |
mixed - マイグレーションしたバージョン番号、またはリクエストしたバージョンがなかった場合には現在のバージョン。 |
| 例 |
// モジュール 'mymodule' をバージョン 10 にマイグレーションする
Migrate::version(10, 'mymodule', 'module');
|