# MigrateController

> Manages application migrations.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [console](/docs/api/yii/console/index.md) › [controllers](/docs/api/yii/console/controllers/index.md) › MigrateController

| class | `yii\console\controllers\MigrateController` |
| --- | --- |
| Extends | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) » [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) » [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/console/controllers/MigrateController.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/console/controllers/MigrateController.php#L81) |

Manages application migrations.

A migration means a set of persistent changes to the application environment
that is shared among different developers. For example, in an application
backed by a database, a migration may refer to a set of changes to
the database, such as creating a new table, adding a new table column.

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 database table named
as [`$migrationTable`](/docs/api/yii/console/controllers/migratecontroller/index.md#property-migrationTable). The table will be automatically created the first time
this command is executed, if it does not exist. You may also manually
create it as follows:

```
CREATE TABLE migration (
    version varchar(180) PRIMARY KEY,
    apply_time bigint
)
```

Below are some common usages of this command:

```
# creates a new migration named 'create_user_table'
yii migrate/create create_user_table

# applies ALL new migrations
yii migrate

# reverts the last applied migration
yii migrate/down
```

Since 2.0.10 you can use namespaced migrations. In order to enable this feature you should configure [`$migrationNamespaces`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-migrationNamespaces)
property for the controller at application configuration:

```
return [
    'controllerMap' => [
        'migrate' => [
            'class' => 'yii\console\controllers\MigrateController',
            'migrationNamespaces' => [
                'app\migrations',
                'some\extension\migrations',
            ],
            //'migrationPath' => null, // allows to disable not namespaced migration completely
        ],
    ],
];
```

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-action"></span>[`$action`](/docs/api/yii/base/controller/index.md#property-action) | [`yii\base\Action`](/docs/api/yii/base/action/index.md)`<static>\|null` | The action that is currently being executed. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-color"></span>[`$color`](/docs/api/yii/console/controller/index.md#property-color) | `bool\|null` | Whether to enable ANSI color in the output. Default: `null`. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-comment"></span>`$comment` | `string` | The comment for the table being created. Default: `''`. Available since 2.0.14. | `MigrateController` |
| <span id="property-compact"></span>[`$compact`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-compact) | `bool` | Indicates whether the console output should be compacted. Default: `false`. Available since 2.0.13. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| [`$db`](#property-db) | [`yii\db\Connection`](/docs/api/yii/db/connection/index.md)`\|array\|string` | The DB connection object or the application component ID of the DB connection to use when applying migrations. Default: `'db'`. | `MigrateController` |
| <span id="property-defaultAction"></span>[`$defaultAction`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-defaultAction) | `string` | The default command action. Default: `'up'`. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| [`$fields`](#property-fields) | `array` | Column definition strings used for creating migration code. Default: `[]`. Available since 2.0.7. | `MigrateController` |
| [`$generatorTemplateFiles`](#property-generatorTemplateFiles) | `array` | A set of template paths for generating migration code automatically. Default: `['create_table' => '@yii/views/createTableMigration.php', 'drop_table' => '@yii/views/dropTableMigration.php', 'add_column' => '@yii/views/addColumnMigration.php', 'drop_column' => '@yii/views/dropColumnMigration.php', 'create_junction' => '@yii/views/createTableMigration.php']`. Available since 2.0.7. | `MigrateController` |
| <span id="property-help"></span>[`$help`](/docs/api/yii/console/controller/index.md#property-help) | `bool` | Whether to display help information about current command. Default: `false`. Available since 2.0.10. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-helpSummary"></span>[`$helpSummary`](/docs/api/yii/console/controller/index.md#property-helpSummary) read-only | `string` | The one-line short summary describing this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/controller/index.md#property-id) | `string` | The ID of this controller. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-interactive"></span>[`$interactive`](/docs/api/yii/console/controller/index.md#property-interactive) | `bool` | Whether to run the command interactively. Default: `true`. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-layout"></span>[`$layout`](/docs/api/yii/base/controller/index.md#property-layout) | `string\|null\|false` | The name of the layout to be applied to this controller's views. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-migrationNamespaces"></span>[`$migrationNamespaces`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-migrationNamespaces) | `array` | List of namespaces containing the migration classes. Default: `[]`. Available since 2.0.10. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="property-migrationPath"></span>[`$migrationPath`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-migrationPath) | `string\|array\|null` | The directory containing the migration classes. Default: `['@app/migrations']`. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="property-migrationTable"></span>`$migrationTable` | `string` | The name of the table for keeping applied migration information. Default: `'{{%migration}}'`. | `MigrateController` |
| <span id="property-module"></span>[`$module`](/docs/api/yii/base/controller/index.md#property-module) | `yii\base\T` | The module that this controller belongs to. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-modules"></span>[`$modules`](/docs/api/yii/base/controller/index.md#property-modules) read-only | [`yii\base\Module`](/docs/api/yii/base/module/index.md)`[]` | All ancestor modules that this controller is located within. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-newFileMode"></span>[`$newFileMode`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-newFileMode) | `int\|null` | The permission to be set for newly generated migration files. Default: `null`. Available since 2.0.43. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="property-newFileOwnership"></span>[`$newFileOwnership`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-newFileOwnership) | `string\|int\|null` | The user and/or group ownership to be set for newly generated migration files. Default: `null`. Available since 2.0.43. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="property-passedOptions"></span>[`$passedOptions`](/docs/api/yii/console/controller/index.md#property-passedOptions) read-only | `array` | The names of the options passed during execution. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-passedOptionValues"></span>[`$passedOptionValues`](/docs/api/yii/console/controller/index.md#property-passedOptionValues) read-only | `array` | The properties corresponding to the passed options. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-request"></span>[`$request`](/docs/api/yii/console/controller/index.md#property-request) | [`yii\console\Request`](/docs/api/yii/console/request/index.md) | The request object. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-response"></span>[`$response`](/docs/api/yii/console/controller/index.md#property-response) | [`yii\console\Response`](/docs/api/yii/console/response/index.md) | The response object. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-route"></span>[`$route`](/docs/api/yii/base/controller/index.md#property-route) read-only | `string` | The route (module ID, controller ID and action ID) of the current request. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-silentExitOnException"></span>[`$silentExitOnException`](/docs/api/yii/console/controller/index.md#property-silentExitOnException) | `bool\|null` | If true - script finish with `ExitCode::OK` in case of exception. false - `ExitCode::UNSPECIFIED_ERROR`. Default: `null`. Available since 2.0.36. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`$templateFile`](#property-templateFile) | `string` | Default: `'@yii/views/migration.php'`. | `MigrateController` |
| <span id="property-uniqueId"></span>[`$uniqueId`](/docs/api/yii/base/controller/index.md#property-uniqueId) read-only | `string` | The controller ID that is prefixed with the module ID (if any). | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| [`$useTablePrefix`](#property-useTablePrefix) | `bool` | Indicates whether the table names generated should consider the `tablePrefix` setting of the DB connection. Default: `true`. Available since 2.0.8. | `MigrateController` |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/controller/index.md#property-view) | [`yii\base\View`](/docs/api/yii/base/view/index.md)`\|`[`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/controller/index.md#property-viewPath) | `string` | The directory containing the view files for this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/controller/index.md#method-__construct) |  | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-actionCreate"></span>[`actionCreate()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionCreate) | Creates a new migration. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionDown"></span>[`actionDown()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionDown) | Downgrades the application by reverting old migrations. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionFresh"></span>[`actionFresh()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionFresh) | Drops all tables and related constraints. Starts the migration from the beginning. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionHistory"></span>[`actionHistory()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionHistory) | Displays the migration history. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionMark"></span>[`actionMark()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionMark) | Modifies the migration history to the specified version. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionNew"></span>[`actionNew()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionNew) | Displays the un-applied new migrations. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionRedo"></span>[`actionRedo()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionRedo) | Redoes the last few migrations. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actions"></span>[`actions()`](/docs/api/yii/base/controller/index.md#method-actions) | Declares external actions for the controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-actionTo"></span>[`actionTo()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionTo) | Upgrades or downgrades till the specified version. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-actionUp"></span>[`actionUp()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-actionUp) | Upgrades the application by applying new migrations. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-afterAction"></span>[`afterAction()`](/docs/api/yii/base/controller/index.md#method-afterAction) | This method is invoked right after an action is executed. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-ansiFormat"></span>[`ansiFormat()`](/docs/api/yii/console/controller/index.md#method-ansiFormat) | Formats a string with ANSI codes. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`beforeAction()`](#method-beforeAction) | This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the [`$migrationPath`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-migrationPath). | `MigrateController` |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-bindActionParams"></span>[`bindActionParams()`](/docs/api/yii/console/controller/index.md#method-bindActionParams) | Binds the parameters to the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-confirm"></span>[`confirm()`](/docs/api/yii/console/controller/index.md#method-confirm) | Asks user to confirm by typing y or n. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-createAction"></span>[`createAction()`](/docs/api/yii/base/controller/index.md#method-createAction) | Creates an action based on the given action ID. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-findLayoutFile"></span>[`findLayoutFile()`](/docs/api/yii/base/controller/index.md#method-findLayoutFile) | Finds the applicable layout file. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getActionArgsHelp"></span>[`getActionArgsHelp()`](/docs/api/yii/console/controller/index.md#method-getActionArgsHelp) | Returns the help information for the anonymous arguments for the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionHelp"></span>[`getActionHelp()`](/docs/api/yii/console/controller/index.md#method-getActionHelp) | Returns the detailed help information for the specified action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionHelpSummary"></span>[`getActionHelpSummary()`](/docs/api/yii/console/controller/index.md#method-getActionHelpSummary) | Returns a one-line short summary describing the specified action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionOptionsHelp"></span>[`getActionOptionsHelp()`](/docs/api/yii/console/controller/index.md#method-getActionOptionsHelp) | Returns the help information for the options for the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getHelp"></span>[`getHelp()`](/docs/api/yii/console/controller/index.md#method-getHelp) | Returns help information for this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getHelpSummary"></span>[`getHelpSummary()`](/docs/api/yii/console/controller/index.md#method-getHelpSummary) | Returns one-line short summary describing this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getModules"></span>[`getModules()`](/docs/api/yii/base/controller/index.md#method-getModules) | Returns all ancestor modules of this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getOptionValues"></span>[`getOptionValues()`](/docs/api/yii/console/controller/index.md#method-getOptionValues) | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getPassedOptions"></span>[`getPassedOptions()`](/docs/api/yii/console/controller/index.md#method-getPassedOptions) | Returns the names of valid options passed during execution. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getPassedOptionValues"></span>[`getPassedOptionValues()`](/docs/api/yii/console/controller/index.md#method-getPassedOptionValues) | Returns the properties corresponding to the passed options. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getRoute"></span>[`getRoute()`](/docs/api/yii/base/controller/index.md#method-getRoute) | Returns the route of the current request. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getUniqueId"></span>[`getUniqueId()`](/docs/api/yii/base/controller/index.md#method-getUniqueId) | Returns the unique ID of the controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/controller/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/controller/index.md#method-getViewPath) | Returns the directory containing view files for this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-init"></span>[`init()`](/docs/api/yii/base/controller/index.md#method-init) | Initializes the object. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-isColorEnabled"></span>[`isColorEnabled()`](/docs/api/yii/console/controller/index.md#method-isColorEnabled) | Returns a value indicating whether ANSI color is enabled. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`optionAliases()`](#method-optionAliases) | Returns option alias names. | `MigrateController` |
| [`options()`](#method-options) | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. | `MigrateController` |
| <span id="method-prompt"></span>[`prompt()`](/docs/api/yii/console/controller/index.md#method-prompt) | Prompts the user for input and validates it. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/controller/index.md#method-render) | Renders a view and applies layout if available. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderContent"></span>[`renderContent()`](/docs/api/yii/base/controller/index.md#method-renderContent) | Renders a static string by applying a layout. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/controller/index.md#method-renderFile) | Renders a view file. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderPartial"></span>[`renderPartial()`](/docs/api/yii/base/controller/index.md#method-renderPartial) | Renders a view without applying layout. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-run"></span>[`run()`](/docs/api/yii/base/controller/index.md#method-run) | Runs a request specified in terms of a route. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-runAction"></span>[`runAction()`](/docs/api/yii/console/controller/index.md#method-runAction) | Runs an action with the specified action ID and parameters. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-select"></span>[`select()`](/docs/api/yii/console/controller/index.md#method-select) | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/controller/index.md#method-setView) | Sets the view object to be used by this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-setViewPath"></span>[`setViewPath()`](/docs/api/yii/base/controller/index.md#method-setViewPath) | Sets the directory that contains the view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-stderr"></span>[`stderr()`](/docs/api/yii/console/controller/index.md#method-stderr) | Prints a string to STDERR. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-stdout"></span>[`stdout()`](/docs/api/yii/console/controller/index.md#method-stdout) | Prints a string to STDOUT. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`addDefaultPrimaryKey()`](#method-addDefaultPrimaryKey) protected | Adds default primary key to fields list if there's no primary key specified. | `MigrateController` |
| [`addMigrationHistory()`](#method-addMigrationHistory) protected | Adds new migration entry to the history. | `MigrateController` |
| <span id="method-bindInjectedParams"></span>[`bindInjectedParams()`](/docs/api/yii/base/controller/index.md#method-bindInjectedParams) protected final | Fills parameters based on types and names in action method signature. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| [`createMigration()`](#method-createMigration) protected | Creates a new migration instance. | `MigrateController` |
| [`createMigrationHistoryTable()`](#method-createMigrationHistoryTable) protected | Creates the migration history table. | `MigrateController` |
| [`generateMigrationSourceCode()`](#method-generateMigrationSourceCode) protected | Generates new migration source PHP code. | `MigrateController` |
| [`generateTableName()`](#method-generateTableName) protected | If `useTablePrefix` equals true, then the table name will contain the prefix format. | `MigrateController` |
| <span id="method-getActionMethodReflection"></span>[`getActionMethodReflection()`](/docs/api/yii/console/controller/index.md#method-getActionMethodReflection) protected |  | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`getMigrationHistory()`](#method-getMigrationHistory) protected | Returns the migration history. | `MigrateController` |
| [`getMigrationNameLimit()`](#method-getMigrationNameLimit) protected | Return the maximum name length for a migration. | `MigrateController` |
| <span id="method-getNewMigrations"></span>[`getNewMigrations()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-getNewMigrations) protected | Returns the migrations that are not applied. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-includeMigrationFile"></span>[`includeMigrationFile()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-includeMigrationFile) protected | Includes the migration file for a given migration class name. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-migrateDown"></span>[`migrateDown()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-migrateDown) protected | Downgrades with the specified migration class. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-migrateToTime"></span>[`migrateToTime()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-migrateToTime) protected | Migrates to the specified apply time in the past. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-migrateToVersion"></span>[`migrateToVersion()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-migrateToVersion) protected | Migrates to the certain version. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-migrateUp"></span>[`migrateUp()`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#method-migrateUp) protected | Upgrades with the specified migration class. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |
| <span id="method-parseDocCommentDetail"></span>[`parseDocCommentDetail()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentDetail) protected | Returns full description from the docblock. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-parseDocCommentSummary"></span>[`parseDocCommentSummary()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentSummary) protected | Returns the first line of docblock. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-parseDocCommentTags"></span>[`parseDocCommentTags()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentTags) protected | Parses the comment block into tags. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`parseFields()`](#method-parseFields) protected | Parse the command line migration fields. | `MigrateController` |
| [`removeMigrationHistory()`](#method-removeMigrationHistory) protected | Removes existing migration from the history. | `MigrateController` |
| [`splitFieldIntoChunks()`](#method-splitFieldIntoChunks) protected | Splits field into chunks | `MigrateController` |
| [`truncateDatabase()`](#method-truncateDatabase) protected | Truncates the database. | `MigrateController` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_BEFORE_ACTION"></span>[`EVENT_BEFORE_ACTION`](/docs/api/yii/base/controller/index.md#event-EVENT_BEFORE_ACTION) | [`yii\base\ActionEvent`](/docs/api/yii/base/actionevent/index.md) | An event raised right before executing a controller action. Event name: `'beforeAction'`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="event-EVENT_AFTER_ACTION"></span>[`EVENT_AFTER_ACTION`](/docs/api/yii/base/controller/index.md#event-EVENT_AFTER_ACTION) | [`yii\base\ActionEvent`](/docs/api/yii/base/actionevent/index.md) | An event raised right after executing a controller action. Event name: `'afterAction'`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-MAX_NAME_LENGTH"></span>`MAX_NAME_LENGTH` | `180` | Maximum length of a migration name. Available since 2.0.13. | `MigrateController` |
| <span id="const-BASE_MIGRATION"></span>[`BASE_MIGRATION`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#const-BASE_MIGRATION) | `'m000000_000000_base'` | The name of the dummy migration that marks the beginning of the whole migration history. | [`BaseMigrateController`](/docs/api/yii/console/controllers/basemigratecontroller/index.md) |

## Property details

### $db <span id="property-db"></span>

```php
public yii\db\Connection|array|string $db = 'db'
```

The DB connection object or the application component ID of the DB connection to use when applying migrations.

Starting from version 2.0.3, this can also be a configuration array
for creating the object.

### $fields <span id="property-fields"></span>

```php
public array $fields = []
```

Column definition strings used for creating migration code.

The format of each definition is `COLUMN_NAME:COLUMN_TYPE:COLUMN_DECORATOR`. Delimiter is `,`.
For example, `--fields="name:string(12):notNull:unique"`
produces a string column of size 12 which is not null and unique values.

Note: primary key is added automatically and is named id by default.
If you want to use another name you may specify it explicitly like
`--fields="id_key:primaryKey,name:string(12):notNull:unique"`

**Since**

2.0.7

### $generatorTemplateFiles <span id="property-generatorTemplateFiles"></span>

```php
public array $generatorTemplateFiles = ['create_table' => '@yii/views/createTableMigration.php', 'drop_table' => '@yii/views/dropTableMigration.php', 'add_column' => '@yii/views/addColumnMigration.php', 'drop_column' => '@yii/views/dropColumnMigration.php', 'create_junction' => '@yii/views/createTableMigration.php']
```

A set of template paths for generating migration code automatically.

The key is the template type, the value is a path or the alias. Supported types are:
- `create_table`: table creating template
- `drop_table`: table dropping template
- `add_column`: adding new column template
- `drop_column`: dropping column template
- `create_junction`: create junction template

**Since**

2.0.7

### $templateFile <span id="property-templateFile"></span>

```php
public string $templateFile = '@yii/views/migration.php'
```

This can be either a [path alias](/docs/guide/concept-aliases/index.md) (e.g. "@app/migrations/template.php")
or a file path.

### $useTablePrefix <span id="property-useTablePrefix"></span>

```php
public bool $useTablePrefix = true
```

Indicates whether the table names generated should consider the `tablePrefix` setting of the DB connection.

For example, if the table
name is `post` the generator wil return `{{%post}}`.

**Since**

2.0.8

## Method details

### beforeAction() <span id="method-beforeAction"></span>

```php
public function beforeAction(yii\base\Action<static> $action): bool
```

This method is invoked right before an action is to be executed (after all possible filters.)
It checks the existence of the [`$migrationPath`](/docs/api/yii/console/controllers/basemigratecontroller/index.md#property-migrationPath).

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$action` | [`yii\base\Action`](/docs/api/yii/base/action/index.md)`<static>` | The action to be executed. |

**Returns**

`bool`: Whether the action should continue to be executed.

### optionAliases() <span id="method-optionAliases"></span>

```php
public function optionAliases(): array
```

Returns option alias names.

Child classes may override this method to specify alias options.

**Returns**

`array`: The options alias names valid for the action where the keys is alias name for option and value is option name.

**Since**

2.0.8

### options() <span id="method-options"></span>

```php
public function options(mixed $actionID): string[]
```

Returns the names of valid options for the action (id)
An option requires the existence of a public member variable whose
name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available
until [`beforeAction()`](/docs/api/yii/console/controllers/migratecontroller/index.md#method-beforeAction) is being called.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$actionID` | `mixed` | The action id of the current request |

**Returns**

`string[]`: The names of the options valid for the action

### addDefaultPrimaryKey() <span id="method-addDefaultPrimaryKey"></span>

```php
protected function addDefaultPrimaryKey(array &$fields): mixed
```

Adds default primary key to fields list if there's no primary key specified.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$fields` | `array` | Parsed fields |

**Returns**

`mixed`

**Since**

2.0.7

### addMigrationHistory() <span id="method-addMigrationHistory"></span>

```php
protected function addMigrationHistory(mixed $version): mixed
```

Adds new migration entry to the history.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$version` | `mixed` | Migration version name. |

**Returns**

`mixed`

### createMigration() <span id="method-createMigration"></span>

```php
protected function createMigration(string $class): yii\db\Migration
```

Creates a new migration instance.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$class` | `string` | The migration class name |

**Returns**

[`yii\db\Migration`](/docs/api/yii/db/migration/index.md): The migration instance

### createMigrationHistoryTable() <span id="method-createMigrationHistoryTable"></span>

```php
protected function createMigrationHistoryTable(): mixed
```

Creates the migration history table.

**Returns**

`mixed`

### generateMigrationSourceCode() <span id="method-generateMigrationSourceCode"></span>

```php
protected function generateMigrationSourceCode(mixed $params): string
```

Generates new migration source PHP code.

Child class may override this method, adding extra logic or variation to the process.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$params` | `mixed` | Generation parameters, usually following parameters are present: - name: string migration base name - className: string migration class name |

**Returns**

`string`: Generated PHP code.

**Since**

2.0.8

### generateTableName() <span id="method-generateTableName"></span>

```php
protected function generateTableName(string $tableName): string
```

If `useTablePrefix` equals true, then the table name will contain the
prefix format.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$tableName` | `string` | The table name to generate. |

**Returns**

`string`

**Since**

2.0.8

### getMigrationHistory() <span id="method-getMigrationHistory"></span>

```php
protected function getMigrationHistory(mixed $limit): array
```

Returns the migration history.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$limit` | `mixed` | The maximum number of records in the history to be returned. `null` for "no limit". |

**Returns**

`array`: The migration history

### getMigrationNameLimit() <span id="method-getMigrationNameLimit"></span>

```php
protected function getMigrationNameLimit(): int|null
```

Return the maximum name length for a migration.

Subclasses may override this method to define a limit.

**Returns**

`int|null`: The maximum name length for a migration or `null` if no limit applies.

**Since**

2.0.13

### parseFields() <span id="method-parseFields"></span>

```php
protected function parseFields(): array
```

Parse the command line migration fields.

**Returns**

`array`: Parse result with following fields: - fields: array, parsed fields - foreignKeys: array, detected foreign keys

**Since**

2.0.7

### removeMigrationHistory() <span id="method-removeMigrationHistory"></span>

```php
protected function removeMigrationHistory(mixed $version): mixed
```

Removes existing migration from the history.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$version` | `mixed` | Migration version name. |

**Returns**

`mixed`

### splitFieldIntoChunks() <span id="method-splitFieldIntoChunks"></span>

```php
protected function splitFieldIntoChunks(string $field): string[]|false
```

Splits field into chunks

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$field` | `string` |  |

**Returns**

`string[]|false`

### truncateDatabase() <span id="method-truncateDatabase"></span>

```php
protected function truncateDatabase(): mixed
```

Truncates the database.

This method should be overwritten in subclasses to implement the task of clearing the database.

**Returns**

`mixed`

**Throws**

- [`yii\base\NotSupportedException`](/docs/api/yii/base/notsupportedexception/index.md): if not overridden

**Since**

2.0.13