MigrateController

Type

Class

Namespace

craft\console\controllers

Inherits

craft\console\controllers\MigrateController » yii\console\controllers\BaseMigrateController (opens new window) » yii\console\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)

Uses traits

craft\console\ControllerTrait, craft\console\controllers\BackupTrait

Since

3.0.0

Manages Craft and plugin 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 controller provides support for tracking the migration history, updating migrations, and creating new migration skeleton files. The migration history is stored in a database table named migrations. The table will be automatically created the first time this controller is executed, if it does not exist. Below are some common usages of this command:

# creates a new migration named 'create_user_table' for a plugin with the handle pluginHandle.
craft migrate/create create_user_table --plugin=pluginHandle
# applies ALL new migrations for a plugin with the handle pluginHandle
craft migrate up --plugin=pluginHandle

View source (opens new window)

Public Properties

Property	Description
action (opens new window)	yii\base\Action (opens new window), null (opens new window) – The action that is currently being executed.
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
color (opens new window)	boolean (opens new window), null (opens new window) – Whether to enable ANSI color in the output.
compact (opens new window)	boolean (opens new window) – Indicates whether the console output should be compacted.
defaultAction (opens new window)	string (opens new window) – The default command action.
help (opens new window)	boolean (opens new window) – Whether to display help information about current command.
helpSummary (opens new window)	string (opens new window) – The one-line short summary describing this controller.
id (opens new window)	string (opens new window) – The ID of this controller.
interactive (opens new window)	boolean (opens new window) – Whether to run the command interactively.
isolated	– Whether the command should ensure it is only being run once at a time.
layout (opens new window)	string (opens new window), null (opens new window), false (opens new window) – The name of the layout to be applied to this controller's views.
migrationNamespaces (opens new window)	array (opens new window) – List of namespaces containing the migration classes.
migrationPath (opens new window)	string (opens new window), array (opens new window), null (opens new window) – The directory containing the migration classes.
migrator	craft\db\MigrationManager
module (opens new window)	yii\base\Module (opens new window) – The module that this controller belongs to.
modules (opens new window)	yii\base\Module (opens new window) – All ancestor modules that this controller is located within.
newFileMode (opens new window)	integer (opens new window), null (opens new window) – The permission to be set for newly generated migration files.
newFileOwnership (opens new window)	string (opens new window), integer (opens new window), null (opens new window) – The user and/or group ownership to be set for newly generated migration files.
noBackup	boolean (opens new window) – Skip backing up the database.
noContent	boolean (opens new window) – Exclude pending content migrations.
passedOptionValues (opens new window)	array (opens new window) – The properties corresponding to the passed options.
passedOptions (opens new window)	array (opens new window) – The names of the options passed during execution.
plugin	string (opens new window), craft\base\PluginInterface, null (opens new window) – The handle of the plugin to use during migration operations, or the plugin itself.
request (opens new window)	yii\base\Request (opens new window), array (opens new window), string (opens new window) – The request.
response (opens new window)	yii\base\Response (opens new window), array (opens new window), string (opens new window) – The response.
route (opens new window)	string (opens new window) – The route (module ID, controller ID and action ID) of the current request.
silentExitOnException (opens new window)	boolean (opens new window), null (opens new window) – If true - script finish with ExitCode::OK in case of exception.
templateFile (opens new window)	string (opens new window) – The template file for generating new migrations.
track	string (opens new window), null (opens new window) – The migration track to work with (e.g. craft, content, plugin:commerce, etc.
type	string (opens new window), null (opens new window) – DEPRECATED.
uniqueId (opens new window)	string (opens new window) – The controller ID that is prefixed with the module ID (if any).
view (opens new window)	yii\base\View (opens new window), yii\web\View (opens new window) – The view object that can be used to render views or view files.
viewPath (opens new window)	string (opens new window) – The directory containing the view files for this controller.

migrator

Type

craft\db\MigrationManager

Default value

null

Access

Read-only

View source (opens new window)

noBackup

Type

boolean (opens new window)

Default value

false

Since

3.4.3

Skip backing up the database.

View source (opens new window)

noContent

Type

boolean (opens new window)

Default value

false

Exclude pending content migrations.

View source (opens new window)

plugin

Type

string (opens new window), craft\base\PluginInterface, null (opens new window)

Default value

null

The handle of the plugin to use during migration operations, or the plugin itself.

View source (opens new window)

track

Type

string (opens new window), null (opens new window)

Default value

\craft\db\MigrationManager::TRACK_CONTENT

Since

3.5.0

The migration track to work with (e.g. craft, content, plugin:commerce, etc.)

Defaults to content, or automatically set to the plugin’s track when --plugin is passed.

View source (opens new window)

type

DEPRECATED

Deprecated in 3.5.0. Use track instead.

Type

string (opens new window), null (opens new window)

Default value

null

DEPRECATED. Use --track instead.

View source (opens new window)

Protected Properties

Property	Description
backupPath	string (opens new window), null (opens new window) – The path to the database backup

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
actionAll()	Runs all pending Craft, plugin, and content migrations.
actionCreate()	Creates a new migration.
actionDown() (opens new window)	Downgrades the application by reverting old migrations.
actionFresh()	Not supported.
actionHistory() (opens new window)	Displays the migration history.
actionMark() (opens new window)	Modifies the migration history to the specified version.
actionNew() (opens new window)	Displays the un-applied new migrations.
actionRedo() (opens new window)	Redoes the last few migrations.
actionTo() (opens new window)	Upgrades or downgrades till the specified version.
actionUp()	Upgrades Craft by applying new migrations.
actions() (opens new window)	Declares external actions for the controller.
afterAction() (opens new window)	This method is invoked right after an action is executed.
ansiFormat() (opens new window)	Formats a string with ANSI codes.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the 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 (opens new window).
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
bindActionParams() (opens new window)	Binds the parameters to the action.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
confirm() (opens new window)	Asks user to confirm by typing y or n.
createAction() (opens new window)	Creates an action based on the given action ID.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
failure()	Outputs a failure message to the console.
findLayoutFile() (opens new window)	Finds the applicable layout file.
getActionArgsHelp() (opens new window)	Returns the help information for the anonymous arguments for the action.
getActionHelp() (opens new window)	Returns the detailed help information for the specified action.
getActionHelpSummary() (opens new window)	Returns a one-line short summary describing the specified action.
getActionOptionsHelp() (opens new window)	Returns the help information for the options for the action.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getHelp() (opens new window)	Returns help information for this controller.
getHelpSummary() (opens new window)	Returns one-line short summary describing this controller.
getMigrator()	Returns a migration manager.
getModules() (opens new window)	Returns all ancestor modules of this controller.
getOptionValues() (opens new window)	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.
getPassedOptionValues() (opens new window)	Returns the properties corresponding to the passed options.
getPassedOptions() (opens new window)	Returns the names of valid options passed during execution.
getRoute() (opens new window)	Returns the route of the current request.
getUniqueId() (opens new window)	Returns the unique ID of the controller.
getView() (opens new window)	Returns the view object that can be used to render views or view files.
getViewPath() (opens new window)	Returns the directory containing view files for this controller.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
isColorEnabled() (opens new window)	Returns a value indicating whether ANSI color is enabled.
markdownToAnsi()	Converts Markdown to be better readable in console environments by applying some ANSI format.
note()	Outputs a note to the console.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
optionAliases()	Returns option alias names.
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.
prompt() (opens new window)	Prompts the user for input and validates it.
render() (opens new window)	Renders a view and applies layout if available.
renderContent() (opens new window)	Renders a static string by applying a layout.
renderFile() (opens new window)	Renders a view file.
renderPartial() (opens new window)	Renders a view without applying layout.
run() (opens new window)	Runs a request specified in terms of a route.
runAction()	Runs an action within this controller with the specified action ID and parameters.
select() (opens new window)	Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.
setView() (opens new window)	Sets the view object to be used by this controller.
setViewPath() (opens new window)	Sets the directory that contains the view files.
stderr() (opens new window)	Prints a string to STDERR.
stdout()	Prints a string to STDOUT.
success()	Outputs a success message to the console.
tip()	Outputs a tip to the console.
trigger() (opens new window)	Triggers an event.
warning()	Outputs a warning to the console.

actionAll()

Runs all pending Craft, plugin, and content migrations.

View source (opens new window)

Returns

integer (opens new window)

Throws

• craft\errors\MigrateException

actionCreate()

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.

craft migrate/create create_news_section

By default, the migration is created in the project’s migrations/ folder (as a “content migration”).
Use --plugin=<plugin-handle> to create a new plugin migration.
Use --type=app to create a new Craft CMS app migration.

View source (opens new window)

Arguments

• $name (string (opens new window)) – The name of the new migration. This should only contain letters, digits, and underscores.

Returns

integer (opens new window)

Throws

• yii\console\Exception (opens new window)
  if the name argument is invalid.

actionFresh()

Not supported.

View source (opens new window)

actionUp()

Upgrades Craft by applying new migrations.

Example:

php craft migrate     # apply all new migrations
php craft migrate 3   # apply the first 3 new migrations

View source (opens new window)

Arguments

• $limit (integer (opens new window)) – The number of new migrations to be applied. If 0, every new migration will be applied.

Returns

integer (opens new window) – The status of the action execution. 0 means normal, other values mean abnormal.

beforeAction()

This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the migrationPath (opens new window).

View source (opens new window)

Arguments

• $action (yii\base\Action (opens new window)) – The action to be executed.

Returns

boolean (opens new window) – Whether the action should continue to be executed.

Throws

• yii\base\InvalidConfigException (opens new window)
  if directory specified in migrationPath doesn't exist and action isn't "create".

getMigrator()

Returns a migration manager.

View source (opens new window)

Arguments

• $track (string (opens new window), null (opens new window))

Returns

craft\db\MigrationManager

Throws

• craft\errors\InvalidPluginException
• yii\base\InvalidConfigException (opens new window)

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

optionAliases()

Returns option alias names.

Child classes may override this method to specify alias options.

View source (opens new window)

Returns

array (opens new window) – The options alias names valid for the action where the keys is alias name for option and value is option name.

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.

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.

View source (opens new window)

Arguments

• $actionID (string (opens new window)) – The action ID of the current request

Returns

string (opens new window)[] – The names of the options valid for the action

stdout()

Prints a string to STDOUT.

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console (opens new window).

Example:

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

View source (opens new window)

Arguments

• $string (string (opens new window)) – The string to print

Returns

integer (opens new window), boolean (opens new window) – Number of bytes printed or false on error

Protected Methods

Method	Description
addMigrationHistory()	Adds new migration entry to the history.
backup()	Attempts to backup the database.
bindInjectedParams() (opens new window)	Fills parameters based on types and names in action method signature.
checkRootUser()	Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that.
checkTty()	Sets yii\console\Controller::$interactive (opens new window) to false if this isn’t a TTY shell.
createAttributeValidator()	Creates a function for the validator option of Controller::prompt.
createMigration()	Creates a new migration instance.
generateMigrationSourceCode() (opens new window)	Generates new migration source PHP code.
getActionMethodReflection() (opens new window)
getMigrationHistory()	Returns the migration history.
getMigrationNameLimit() (opens new window)	Return the maximum name length for a migration.
getNewMigrations()	Returns the migrations that are not applied.
includeMigrationFile() (opens new window)	Includes the migration file for a given migration class name.
migrateDown() (opens new window)	Downgrades with the specified migration class.
migrateToTime() (opens new window)	Migrates to the specified apply time in the past.
migrateToVersion() (opens new window)	Migrates to the certain version.
migrateUp() (opens new window)	Upgrades with the specified migration class.
outputCommand()
parseDocCommentDetail() (opens new window)	Returns full description from the docblock.
parseDocCommentSummary() (opens new window)	Returns the first line of docblock.
parseDocCommentTags() (opens new window)	Parses the comment block into tags.
removeMigrationHistory()	Removes existing migration from the history.
truncateDatabase()	Truncates the database.

addMigrationHistory()

Adds new migration entry to the history.

View source (opens new window)

Arguments

• $version (string (opens new window)) – Migration version name.

createMigration()

Creates a new migration instance.

View source (opens new window)

Arguments

• $class (string (opens new window)) – The migration class name

Returns

yii\db\MigrationInterface (opens new window) – The migration instance

getMigrationHistory()

Returns the migration history.

View source (opens new window)

Arguments

• $limit (integer (opens new window), null (opens new window)) – The maximum number of records in the history to be returned. null for "no limit".

Returns

array (opens new window) – The migration history

getNewMigrations()

Returns the migrations that are not applied.

View source (opens new window)

Returns

array (opens new window) – List of new migrations

removeMigrationHistory()

Removes existing migration from the history.

View source (opens new window)

Arguments

• $version (string (opens new window)) – Migration version name.

truncateDatabase()

Truncates the database.

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

View source (opens new window)

Throws

• yii\base\NotSupportedException (opens new window)
  if not overridden

Constants

Constant	Description
BASE_MIGRATION	The name of the dummy migration that marks the beginning of the whole migration history.
EXIT_CODE_ERROR
EXIT_CODE_NORMAL

Events

EVENT_REGISTER_MIGRATOR

Type

craft\events\RegisterMigratorEvent

Since

3.5.0

The event that is triggered when resolving an unknown migration track.

use craft\console\controllers\MigrateController;
use craft\db\MigrationManager;
use craft\events\RegisterMigratorEvent;
use yii\base\Event;

Event::on(
    MigrateController::class,
    MigrateController::EVENT_REGISTER_MIGRATOR,
    function(RegisterMigratorEvent $event) {
        if ($event->track === 'myCustomTrack') {
            $event->migrator = Craft::createObject([
                'class' => MigrationManager::class,
                'track' => 'myCustomTrack',
                'migrationNamespace' => 'my\migration\namespace',
                'migrationPath' => '/path/to/migrations',
            ]);
            $event->handled = true;
        }
    }
);