Class yii\console\controllers\MigrateController
Inheritance | yii\console\controllers\MigrateController » yii\console\controllers\BaseMigrateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/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 integer
)
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
],
],
];
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$action | yii\base\Action | The action that is currently being executed. | yii\base\Controller |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$color | boolean | Whether to enable ANSI color in the output. | yii\console\Controller |
$comment | string | The comment for the table being created. | yii\console\controllers\MigrateController |
$compact | boolean | Indicates whether the console output should be compacted. | yii\console\controllers\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. | yii\console\controllers\MigrateController |
$defaultAction | string | The default command action. | yii\console\controllers\BaseMigrateController |
$fields | array | Column definition strings used for creating migration code. | yii\console\controllers\MigrateController |
$generatorTemplateFiles | array | A set of template paths for generating migration code automatically. | yii\console\controllers\MigrateController |
$help | boolean | Whether to display help information about current command. | yii\console\Controller |
$helpSummary | string | yii\console\Controller | |
$id | string | The ID of this controller. | yii\base\Controller |
$interactive | boolean | Whether to run the command interactively. | yii\console\Controller |
$layout | null|string|false | The name of the layout to be applied to this controller's views. | yii\base\Controller |
$migrationNamespaces | array | List of namespaces containing the migration classes. | yii\console\controllers\BaseMigrateController |
$migrationPath | string|array | The directory containing the migration classes. | yii\console\controllers\BaseMigrateController |
$migrationTable | string | The name of the table for keeping applied migration information. | yii\console\controllers\MigrateController |
$module | yii\base\Module | The module that this controller belongs to. | yii\base\Controller |
$modules | yii\base\Module[] | All ancestor modules that this controller is located within. | yii\base\Controller |
$passedOptionValues | array | The properties corresponding to the passed options | yii\console\Controller |
$passedOptions | array | The names of the options passed during execution | yii\console\Controller |
$route | string | The route (module ID, controller ID and action ID) of the current request. | yii\base\Controller |
$templateFile | string | The template file for generating new migrations. | yii\console\controllers\MigrateController |
$uniqueId | string | The controller ID that is prefixed with the module ID (if any). | yii\base\Controller |
$useTablePrefix | boolean | Indicates whether the table names generated should consider
the tablePrefix setting of the DB connection. |
yii\console\controllers\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 view path that may be prefixed to a relative view name. | yii\base\ViewContextInterface |
Public Methods
Method | Description | Defined By |
---|---|---|
__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 |
__construct() | yii\base\Controller | |
__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. | yii\console\controllers\BaseMigrateController |
actionDown() | Downgrades the application by reverting old migrations. | yii\console\controllers\BaseMigrateController |
actionFresh() | Truncates the whole database and starts the migration from the beginning. | yii\console\controllers\BaseMigrateController |
actionHistory() | Displays the migration history. | yii\console\controllers\BaseMigrateController |
actionMark() | Modifies the migration history to the specified version. | yii\console\controllers\BaseMigrateController |
actionNew() | Displays the un-applied new migrations. | yii\console\controllers\BaseMigrateController |
actionRedo() | Redoes the last few migrations. | yii\console\controllers\BaseMigrateController |
actionTo() | Upgrades or downgrades till the specified version. | yii\console\controllers\BaseMigrateController |
actionUp() | Upgrades the application by applying new migrations. | yii\console\controllers\BaseMigrateController |
actions() | Declares external actions for the controller. | yii\base\Controller |
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. | yii\console\controllers\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() | 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 |
getPassedOptionValues() | Returns the properties corresponding to the passed options. | yii\console\Controller |
getPassedOptions() | Returns the names of valid options passed during execution. | 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() | yii\base\ViewContextInterface | |
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\BaseObject |
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. | yii\console\controllers\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. | yii\console\controllers\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 |
Protected Methods
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | An event raised right after executing a controller action. | yii\base\Controller |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | An event raised right before executing a controller action. | yii\base\Controller |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
BASE_MIGRATION | 'm000000_000000_base' | The name of the dummy migration that marks the beginning of the whole migration history. | yii\console\controllers\BaseMigrateController |
EXIT_CODE_ERROR | 1 | Deprecated since 2.0.13. Use \yii\console\controllers\ExitCode::UNSPECIFIED_ERROR instead. | yii\console\Controller |
EXIT_CODE_NORMAL | 0 | Deprecated since 2.0.13. Use \yii\console\controllers\ExitCode::OK instead. | yii\console\Controller |
MAX_NAME_LENGTH | 180 | Maximum length of a migration name. | yii\console\controllers\MigrateController |
Property Details
The comment for the table being created.
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.
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"
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 templatedrop_table
: table dropping templateadd_column
: adding new column templatedrop_column
: dropping column templatecreate_junction
: create junction template
The name of the table for keeping applied migration information.
The template file for generating new migrations. This can be either a path alias (e.g. "@app/migrations/template.php") or a file path.
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}}
.
Method Details
Adds default primary key to fields list if there's no primary key specified.
protected void addDefaultPrimaryKey ( &$fields ) | ||
$fields | array | Parsed fields |
Adds new migration entry to the history.
protected void addMigrationHistory ( $version ) | ||
$version | string | Migration version name. |
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. |
---|
Creates a new migration instance.
protected yii\db\Migration createMigration ( $class ) | ||
$class | string | The migration class name |
return | yii\db\Migration | The migration instance |
---|
Creates the migration history table.
protected void createMigrationHistoryTable ( ) |
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:
|
return | string | Generated PHP code. |
---|
If useTablePrefix
equals true, then the table name will contain the
prefix format.
protected string generateTableName ( $tableName ) | ||
$tableName | string | The table name to generate. |
Returns the migration history.
protected array getMigrationHistory ( $limit ) | ||
$limit | integer | The maximum number of records in the history to be returned. |
return | array | The migration history |
---|
Return the maximum name length for a migration.
Subclasses may override this method to define a limit.
protected integer|null getMigrationNameLimit ( ) | ||
return | integer|null | The maximum name length for a migration or |
---|
Returns option alias names.
Child classes may override this method to specify alias options.
public array optionAliases ( ) | ||
return | array | The options alias names valid for the action where the keys is alias name for option and value is option name. |
---|
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 |
---|
Parse the command line migration fields.
protected array parseFields ( ) | ||
return | array | Parse result with following fields:
|
---|
Removes existing migration from the history.
protected void removeMigrationHistory ( $version ) | ||
$version | string | Migration version name. |
Truncates the database.
This method should be overwritten in subclasses to implement the task of clearing the database.
protected void truncateDatabase ( ) | ||
throws | yii\base\NotSupportedException | if not overridden |
---|