MigrateController

API reference › yii › console › controllers › MigrateController

class	`yii\console\controllers\MigrateController`
Extends	`BaseMigrateController` » `yii\console\Controller` » `yii\base\Controller` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/console/controllers/MigrateController.php`

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. 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 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
`$action`	`yii\base\Action<static>\|null`	The action that is currently being executed. Default: `null`.	`yii\base\Controller`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$color`	`bool\|null`	Whether to enable ANSI color in the output. Default: `null`.	`yii\console\Controller`
`$comment`	`string`	The comment for the table being created. Default: `''`. Available since 2.0.14.	`MigrateController`
`$compact`	`bool`	Indicates whether the console output should be compacted. Default: `false`. Available since 2.0.13.	`BaseMigrateController`
`$db`	`yii\db\Connection\|array\|string`	The DB connection object or the application component ID of the DB connection to use when applying migrations. Default: `'db'`.	`MigrateController`
`$defaultAction`	`string`	The default command action. Default: `'up'`.	`BaseMigrateController`
`$fields`	`array`	Column definition strings used for creating migration code. Default: `[]`. Available since 2.0.7.	`MigrateController`
`$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`
`$help`	`bool`	Whether to display help information about current command. Default: `false`. Available since 2.0.10.	`yii\console\Controller`
`$helpSummary` read-only	`string`	The one-line short summary describing this controller.	`yii\console\Controller`
`$id`	`string`	The ID of this controller. Default: `null`.	`yii\base\Controller`
`$interactive`	`bool`	Whether to run the command interactively. Default: `true`.	`yii\console\Controller`
`$layout`	`string\|null\|false`	The name of the layout to be applied to this controller’s views. Default: `null`.	`yii\base\Controller`
`$migrationNamespaces`	`array`	List of namespaces containing the migration classes. Default: `[]`. Available since 2.0.10.	`BaseMigrateController`
`$migrationPath`	`string\|array\|null`	The directory containing the migration classes. Default: `['@app/migrations']`.	`BaseMigrateController`
`$migrationTable`	`string`	The name of the table for keeping applied migration information. Default: `'{{%migration}}'`.	`MigrateController`
`$module`	`yii\base\T`	The module that this controller belongs to. Default: `null`.	`yii\base\Controller`
`$modules` read-only	`yii\base\Module[]`	All ancestor modules that this controller is located within.	`yii\base\Controller`
`$newFileMode`	`int\|null`	The permission to be set for newly generated migration files. Default: `null`. Available since 2.0.43.	`BaseMigrateController`
`$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`
`$passedOptions` read-only	`array`	The names of the options passed during execution.	`yii\console\Controller`
`$passedOptionValues` read-only	`array`	The properties corresponding to the passed options.	`yii\console\Controller`
`$request`	`yii\console\Request`	The request object.	`yii\console\Controller`
`$response`	`yii\console\Response`	The response object.	`yii\console\Controller`
`$route` read-only	`string`	The route (module ID, controller ID and action ID) of the current request.	`yii\base\Controller`
`$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`
`$templateFile`	`string`	Default: `'@yii/views/migration.php'`.	`MigrateController`
`$uniqueId` read-only	`string`	The controller ID that is prefixed with the module ID (if any).	`yii\base\Controller`
`$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`
`$view`	`yii\base\View\|yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Controller`
`$viewPath`	`string`	The directory containing the view files for this controller.	`yii\base\Controller`

Methods

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

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_ACTION`	`yii\base\ActionEvent`	An event raised right before executing a controller action. Event name: `'beforeAction'`.	`yii\base\Controller`
`EVENT_AFTER_ACTION`	`yii\base\ActionEvent`	An event raised right after executing a controller action. Event name: `'afterAction'`.	`yii\base\Controller`

Constants

Constant	Value	Description	Defined by
`MAX_NAME_LENGTH`	`180`	Maximum length of a migration name. Available since 2.0.13.	`MigrateController`
`BASE_MIGRATION`	`'m000000_000000_base'`	The name of the dummy migration that marks the beginning of the whole migration history.	`BaseMigrateController`

Property details

$db

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

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

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

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

This can be either a path alias (e.g. “@app/migrations/template.php”) or a file path.

$useTablePrefix

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()

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.

Parameters

Parameter	Type	Description
`$action`	`yii\base\Action<static>`	The action to be executed.

Returns

bool: Whether the action should continue to be executed.

optionAliases()

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()

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() 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()

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()

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()

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: The migration instance

createMigrationHistoryTable()

protected function createMigrationHistoryTable(): mixed

Creates the migration history table.

Returns

mixed

generateMigrationSourceCode()

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()

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()

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()

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()

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()

protected function removeMigrationHistory(mixed $version): mixed

Removes existing migration from the history.

Parameters

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

Returns

mixed

splitFieldIntoChunks()

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

Splits field into chunks

Parameters

Parameter	Type	Description
`$field`	`string`

Returns

string[]|false

truncateDatabase()

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: if not overridden

Since

2.0.13