Class yii\mongodb\console\controllers\MigrateController
| Inheritance | yii\mongodb\console\controllers\MigrateController » yii\console\controllers\BaseMigrateController |
|---|---|
| Available since version | 2.0 |
Manages application MongoDB migrations.
This is an analog of \yii\console\controllers\MigrateController for MongoDB.
This command provides support for tracking the migration history, upgrading or downloading with migrations, and creating new migration skeletons.
The migration history is stored in a MongoDB collection named as $migrationCollection. This collection will be automatically created the first time this command is executed, if it does not exist.
In order to enable this command you should adjust the configuration of your console application:
return [
// ...
'controllerMap' => [
'mongodb-migrate' => 'yii\mongodb\console\controllers\MigrateController'
],
];
Below are some common usages of this command:
# creates a new migration named 'create_user_collection'
yii mongodb-migrate/create create_user_collection
# applies ALL new migrations
yii mongodb-migrate
# reverts the last applied migration
yii mongodb-migrate/down
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $db | yii\mongodb\Connection|string | The DB connection object or the application component ID of the DB connection. | yii\mongodb\console\controllers\MigrateController |
| $migrationCollection | string|array | The name of the collection for keeping applied migration information. | yii\mongodb\console\controllers\MigrateController |
| $templateFile | yii\mongodb\console\controllers\MigrateController |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| beforeAction() | This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the \yii\mongodb\console\controllers\migrationPath. | yii\mongodb\console\controllers\MigrateController |
| options() | yii\mongodb\console\controllers\MigrateController |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| addMigrationHistory() | yii\mongodb\console\controllers\MigrateController | |
| createMigration() | Creates a new migration instance. | yii\mongodb\console\controllers\MigrateController |
| ensureBaseMigrationHistory() | Ensures migration history contains at least base migration entry. | yii\mongodb\console\controllers\MigrateController |
| getMigrationHistory() | yii\mongodb\console\controllers\MigrateController | |
| removeMigrationHistory() | yii\mongodb\console\controllers\MigrateController |
Property Details
The DB connection object or the application component ID of the DB connection.
The name of the collection for keeping applied migration information.
Method Details
| protected void addMigrationHistory ( $version ) | ||
| $version | ||
This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the \yii\mongodb\console\controllers\migrationPath.
| public boolean beforeAction ( $action ) | ||
| $action | \yii\base\Action | The action to be executed. |
| return | boolean | Whether the action should continue to be executed. |
|---|---|---|
| throws | \yii\console\Exception | if db component isn't configured |
Creates a new migration instance.
| protected yii\mongodb\Migration createMigration ( $class ) | ||
| $class | string | The migration class name |
| return | yii\mongodb\Migration | The migration instance |
|---|---|---|
Ensures migration history contains at least base migration entry.
| protected void ensureBaseMigrationHistory ( ) |
| protected void getMigrationHistory ( $limit ) | ||
| $limit | ||
| public void options ( $actionID ) | ||
| $actionID | ||
| protected void removeMigrationHistory ( $version ) | ||
| $version | ||