public string $defaultAction = 'up'

[
    'app\migrations',
    'some\extension\migrations',
]

public array $migrationNamespaces = []

public string|array $migrationPath = ['@app/migrations']

public string $templateFile = null

actionCreate() public method

Creates a new migration.

This command creates a new migration using the available migration template. After using this command, developers should modify the created migration skeleton by filling up the actual migration logic.

yii migrate/create create_user_table

In order to generate a namespaced migration, you should specify a namespace before the migration's name. Note that backslash (\) is usually considered a special character in the shell, so you need to escape it properly to avoid shell errors or incorrect behavior. For example:

yii migrate/create 'app\\migrations\\createUserTable'

In case $migrationPath is not set and no namespace is provided, the first entry of $migrationNamespaces will be used.

public void actionCreate ( $name )
$name	string	The name of the new migration. This should only contain letters, digits, underscores and/or backslashes. Note: If the migration name is of a special form, for example create_xxx or drop_xxx, then the generated migration file will contain extra code, in this case for creating/dropping tables.
throws	yii\console\Exception	if the name argument is invalid.

actionDown() public method

Downgrades the application by reverting old migrations.

For example,

yii migrate/down     # revert the last migration
yii migrate/down 3   # revert the last 3 migrations
yii migrate/down all # revert all migrations

public integer actionDown ( $limit = 1 )
$limit	integer|string	The number of migrations to be reverted. Defaults to 1, meaning the last applied migration will be reverted. When value is "all", all migrations will be reverted.
return	integer	The status of the action execution. 0 means normal, other values mean abnormal.
throws	yii\console\Exception	if the number of the steps specified is less than 1.

actionHistory() public method

Displays the migration history.

This command will show the list of migrations that have been applied so far. For example,

yii migrate/history     # showing the last 10 migrations
yii migrate/history 5   # showing the last 5 migrations
yii migrate/history all # showing the whole history

public void actionHistory ( $limit = 10 )
$limit	integer|string	The maximum number of migrations to be displayed. If it is "all", the whole migration history will be displayed.
throws	yii\console\Exception	if invalid limit value passed

actionMark() public method

Modifies the migration history to the specified version.

No actual migration will be performed.

yii migrate/mark 101129_185401                        # using timestamp
yii migrate/mark m101129_185401_create_user_table     # using full name
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name

public integer actionMark ( $version )
$version	string	The version at which the migration history should be marked. This can be either the timestamp or the full name of the migration.
return	integer	CLI exit code
throws	yii\console\Exception	if the version argument is invalid or the version cannot be found.

actionNew() public method

Displays the un-applied new migrations.

This command will show the new migrations that have not been applied. For example,

yii migrate/new     # showing the first 10 new migrations
yii migrate/new 5   # showing the first 5 new migrations
yii migrate/new all # showing all new migrations

public void actionNew ( $limit = 10 )
$limit	integer|string	The maximum number of new migrations to be displayed. If it is all, all available new migrations will be displayed.
throws	yii\console\Exception	if invalid limit value passed

actionRedo() public method

Redoes the last few migrations.

This command will first revert the specified migrations, and then apply them again. For example,

yii migrate/redo     # redo the last applied migration
yii migrate/redo 3   # redo the last 3 applied migrations
yii migrate/redo all # redo all migrations

public integer actionRedo ( $limit = 1 )
$limit	integer|string	The number of migrations to be redone. Defaults to 1, meaning the last applied migration will be redone. When equals "all", all migrations will be redone.
return	integer	The status of the action execution. 0 means normal, other values mean abnormal.
throws	yii\console\Exception	if the number of the steps specified is less than 1.

actionTo() public method

Upgrades or downgrades till the specified version.

Can also downgrade versions to the certain apply time in the past by providing a UNIX timestamp or a string parseable by the strtotime() function. This means that all the versions applied after the specified certain time would be reverted.

This command will first revert the specified migrations, and then apply them again. For example,

yii migrate/to 101129_185401                          # using timestamp
yii migrate/to m101129_185401_create_user_table       # using full name
yii migrate/to 1392853618                             # using UNIX timestamp
yii migrate/to "2014-02-15 13:00:50"                  # using strtotime() parseable string
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name

public void actionTo ( $version )
$version	string	Either the version name or the certain time value in the past that the application should be migrated to. This can be either the timestamp, the full name of the migration, the UNIX timestamp, or the parseable datetime string.
throws	yii\console\Exception	if the version argument is invalid.

actionUp() public method

Upgrades the application by applying new migrations.

For example,

yii migrate     # apply all new migrations
yii migrate 3   # apply the first 3 new migrations

public integer actionUp ( $limit = 0 )
$limit	integer	The number of new migrations to be applied. If 0, it means applying all available new migrations.
return	integer	The status of the action execution. 0 means normal, other values mean abnormal.

addMigrationHistory() protected abstract method

Adds new migration entry to the history.

protected abstract void addMigrationHistory ( $version )
$version	string	Migration version name.

beforeAction() public method

This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the $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\base\InvalidConfigException	if directory specified in migrationPath doesn't exist and action isn't "create".

createMigration() protected method

Creates a new migration instance.

protected yii\db\MigrationInterface createMigration ( $class )
$class	string	The migration class name
return	yii\db\MigrationInterface	The migration instance

generateMigrationSourceCode() protected method (available since version 2.0.8)

Generates new migration source PHP code.

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

protected string generateMigrationSourceCode ( $params )
$params	array	Generation parameters, usually following parameters are present: name: string migration base name className: string migration class name
return	string	Generated PHP code.

getMigrationHistory() protected abstract method

Returns the migration history.

protected abstract array getMigrationHistory ( $limit )
$limit	integer	The maximum number of records in the history to be returned. null for "no limit".
return	array	The migration history

getNewMigrations() protected method

Returns the migrations that are not applied.

protected array getNewMigrations ( )
return	array	List of new migrations

includeMigrationFile() protected method (available since version 2.0.12)

Includes the migration file for a given migration class name.

This function will do nothing on namespaced migrations, which are loaded by autoloading automatically. It will include the migration file, by searching $migrationPath for classes without namespace.

protected void includeMigrationFile ( $class )
$class	string	The migration class name.

migrateDown() protected method

Downgrades with the specified migration class.

protected boolean migrateDown ( $class )
$class	string	The migration class name
return	boolean	Whether the migration is successful

migrateToTime() protected method

Migrates to the specified apply time in the past.

protected void migrateToTime ( $time )
$time	integer	UNIX timestamp value.

migrateToVersion() protected method

Migrates to the certain version.

protected integer migrateToVersion ( $version )
$version	string	Name in the full format.
return	integer	CLI exit code
throws	yii\console\Exception	if the provided version cannot be found.

migrateUp() protected method

Upgrades with the specified migration class.

protected boolean migrateUp ( $class )
$class	string	The migration class name
return	boolean	Whether the migration is successful

options() public method

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.

public string[] options ( $actionID )
$actionID	string	The action id of the current request
return	string[]	The names of the options valid for the action

removeMigrationHistory() protected abstract method

Removes existing migration from the history.

protected abstract void removeMigrationHistory ( $version )
$version	string	Migration version name.