Class yii\mongodb\console\controllers\MigrateController

All Classes | Properties | Methods

Inheritance	yii\mongodb\console\controllers\MigrateController » yii\console\controllers\BaseMigrateController
Available since extension's 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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$db	yii\mongodb\Connection\|string	The DB connection object or the application component ID of the DB connection.	yii\mongodb\console\controllers\MigrateController
$migrationCollection	string\|array	The name of the collection for keeping applied migration information.	yii\mongodb\console\controllers\MigrateController
$templateFile			yii\mongodb\console\controllers\MigrateController

Public Methods

Hide inherited methods

Method	Description	Defined By
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
options()		yii\mongodb\console\controllers\MigrateController

Protected Methods

Hide inherited methods

Method	Description	Defined By
addMigrationHistory()		yii\mongodb\console\controllers\MigrateController
createMigration()	Creates a new migration instance.	yii\mongodb\console\controllers\MigrateController
ensureBaseMigrationHistory()	Ensures migration history contains at least base migration entry.	yii\mongodb\console\controllers\MigrateController
getMigrationHistory()		yii\mongodb\console\controllers\MigrateController
removeMigrationHistory()		yii\mongodb\console\controllers\MigrateController

Property Details

Hide inherited properties

$db public property

The DB connection object or the application component ID of the DB connection.

public yii\mongodb\Connection|string $db = 'mongodb'

$migrationCollection public property

The name of the collection for keeping applied migration information.

public string|array $migrationCollection = 'migration'

$templateFile public property

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

Method Details

Hide inherited methods

addMigrationHistory() protected method

protected void addMigrationHistory ( $version )
$version

Source code

                protected function addMigrationHistory($version)
{
    $this->db->getCollection($this->migrationCollection)->insert([
        'version' => $version,
        'apply_time' => time(),
    ]);
}

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\console\Exception	if db component isn't configured

Source code

                public function beforeAction($action)
{
    if (parent::beforeAction($action)) {
        if ($action->id !== 'create') {
            if (is_string($this->db)) {
                $this->db = Yii::$app->get($this->db);
            }
            if (!$this->db instanceof Connection) {
                throw new Exception("The 'db' option must refer to the application component ID of a MongoDB connection.");
            }
        }
        return true;
    } else {
        return false;
    }
}

createMigration() protected method

Creates a new migration instance.

protected yii\mongodb\Migration createMigration ( $class )
$class	string	The migration class name
return	yii\mongodb\Migration	The migration instance

Source code

                protected function createMigration($class)
{
    $file = $this->migrationPath . DIRECTORY_SEPARATOR . $class . '.php';
    require_once($file);
    return new $class(['db' => $this->db]);
}

ensureBaseMigrationHistory() protected method

Ensures migration history contains at least base migration entry.

protected void ensureBaseMigrationHistory ( )

Source code

                protected function ensureBaseMigrationHistory()
{
    if (!$this->baseMigrationEnsured) {
        $query = new Query;
        $row = $query->select(['version'])
            ->from($this->migrationCollection)
            ->andWhere(['version' => self::BASE_MIGRATION])
            ->limit(1)
            ->one($this->db);
        if (empty($row)) {
            $this->addMigrationHistory(self::BASE_MIGRATION);
        }
        $this->baseMigrationEnsured = true;
    }
}

getMigrationHistory() protected method

protected void getMigrationHistory ( $limit )
$limit

Source code

                protected function getMigrationHistory($limit)
{
    $this->ensureBaseMigrationHistory();
    $query = new Query;
    $rows = $query->select(['version', 'apply_time'])
        ->from($this->migrationCollection)
        ->orderBy(['apply_time' => SORT_DESC, 'version' => SORT_DESC])
        ->limit($limit)
        ->all($this->db);
    $history = ArrayHelper::map($rows, 'version', 'apply_time');
    unset($history[self::BASE_MIGRATION]);
    return $history;
}

options() public method

public void options ( $actionID )
$actionID

Source code

                public function options($actionID)
{
    return array_merge(
        parent::options($actionID),
        ['migrationCollection', 'db'] // global for all actions
    );
}

removeMigrationHistory() protected method

protected void removeMigrationHistory ( $version )
$version

Source code

                protected function removeMigrationHistory($version)
{
    $this->db->getCollection($this->migrationCollection)->remove([
        'version' => $version,
    ]);
}