Класс yii\mongodb\console\controllers\MigrateController

Управляет миграциями приложения MongoDB.

Это аналог yii\console\controllers\MigrateController для MongoDB.

Эта команда предоставляет поддержку отслеживания истории миграций, обновления или загрузки с миграциями и создания новых шаблонов миграций.

История миграций хранится в коллекции MongoDB с именем $migrationCollection. Эта коллекция будет автоматически создана в первый раз при выполнении этой команды, если она не существует.

Для включения этой команды необходимо настроить конфигурацию вашего консольного приложения:

return [
    // ...
    'controllerMap' => [
        'mongodb-migrate' => 'yii\mongodb\console\controllers\MigrateController'
    ],
];

Ниже приведены некоторые распространенные примеры использования этой команды:

# 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

Начиная с версии 2.1.2, в случае использования Yii версии >= 2.0.10, вы можете использовать миграции с именованными пространствами имен. Для активации этой функции необходимо настроить свойство $migrationNamespaces контроллера в конфигурации приложения:

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
        ],
    ],
];

Общедоступные свойства

Общедоступные методы

Защищенные методы

События

Константы

Подробное описание свойств

$db открытое свойство

Объект подключения к базе данных или идентификатор компонента приложения для подключения к базе данных.

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

$migrationCollection открытое свойство

Имя коллекции для хранения информации о примененных миграциях.

public string|array $migrationCollection = 'migration'

$templateFile открытое свойство

Шаблонный файл для генерации новых миграций. Это может быть псевдоним пути (например, "@app/migrations/template.php") или путь к файлу.

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

Подробное описание методов