Class yii\mongodb\console\controllers\MigrateController
Inheritance | yii\mongodb\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-mongodb/blob/master/console/controllers/MigrateController.php |
Manages application MongoDB migrations.
This is an analog of yii\console\controllers\MigrateController for MongoDB.
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 MongoDB collection named as $migrationCollection. This collection will be automatically created the first time this command is executed, if it does not exist.
In order to enable this command you should adjust the configuration of your console application:
return [
// ...
'controllerMap' => [
'mongodb-migrate' => 'yii\mongodb\console\controllers\MigrateController'
],
];
Below are some common usages of this command:
# creates a new migration named 'create_user_collection'
yii mongodb-migrate/create create_user_collection
# applies ALL new migrations
yii mongodb-migrate
# reverts the last applied migration
yii mongodb-migrate/down
Since 2.1.2, in case of usage Yii version >= 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' => [
'mongodb-migrate' => [
'class' => 'yii\mongodb\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|null | The action that is currently being executed. | yii\base\Controller |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
$color | boolean|null | Whether to enable ANSI color in the output. | yii\console\Controller |
$compact | boolean | Indicates whether the console output should be compacted. | yii\console\controllers\BaseMigrateController |
$db | yii\mongodb\Connection|string | The DB connection object or the application component ID of the DB connection. | yii\mongodb\console\controllers\MigrateController |
$defaultAction | string | The default command action. | yii\console\controllers\BaseMigrateController |
$help | boolean | Whether to display help information about current command. | yii\console\Controller |
$helpSummary | string | This property is read-only. | 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 |
$migrationCollection | string|array | The name of the collection for keeping applied migration information. | yii\mongodb\console\controllers\MigrateController |
$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 |
$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. This property is read-only. | yii\base\Controller |
$passedOptionValues | array | The properties corresponding to the passed options. This property is read-only. | yii\console\Controller |
$passedOptions | array | The names of the options passed during execution. This property is read-only. | yii\console\Controller |
$request | yii\console\Request | yii\console\Controller | |
$response | yii\console\Response | yii\console\Controller | |
$route | string | The route (module ID, controller ID and action ID) of the current request. This property is read-only. | yii\base\Controller |
$silentExitOnException | boolean|null | If true - script finish with ExitCode::OK in case of exception. |
yii\console\Controller |
$templateFile | string | The template file for generating new migrations. | yii\mongodb\console\controllers\MigrateController |
$uniqueId | string | The controller ID that is prefixed with the module ID (if any). This property is read-only. | yii\base\Controller |
$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 |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__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 an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
actionCreate() | Creates a new migration. | yii\console\controllers\BaseMigrateController |
actionDown() | Downgrades the application by reverting old migrations. | yii\console\controllers\BaseMigrateController |
actionFresh() | Drops all tables and related constraints. 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\mongodb\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\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
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\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
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. | yii\console\Controller |
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\mongodb\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\ExitCode::UNSPECIFIED_ERROR instead. | yii\console\Controller |
EXIT_CODE_NORMAL | 0 | Deprecated since 2.0.13. Use yii\console\ExitCode::OK instead. | yii\console\Controller |
Property Details
The DB connection object or the application component ID of the DB connection.
The name of the collection 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.
Method Details
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. |
---|---|---|
throws | yii\console\Exception | if db component isn't configured |
Creates a new migration instance.
protected yii\mongodb\Migration createMigration ( $class ) | ||
$class | string | The migration class name |
return | yii\mongodb\Migration | The migration instance |
---|
Ensures migration history contains at least base migration entry.
protected void ensureBaseMigrationHistory ( ) |
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 |
---|
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 |
---|
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 |
---|