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

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

Миграция представляет собой набор постоянных изменений в среде приложения, которые используются разными разработчиками. Например, в приложении, работающем с базой данных, миграция может относиться к набору изменений в базе данных, таких как создание новой таблицы или добавление нового столбца в таблицу.

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

История миграций хранится в таблице базы данных с именем $migrationTable. Таблица будет автоматически создана при первом выполнении этой команды, если она не существует. Вы также можете создать её вручную следующим образом:

CREATE TABLE migration (
    version varchar(180) PRIMARY KEY,
    apply_time integer
)

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

# 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

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

return [
    'controllerMap' => [
        'migrate' => [
            'class' => 'yii\console\controllers\MigrateController',
            'migrationNamespaces' => [
                'app\migrations',
                'some\extension\migrations',
            ],
            //'migrationPath' => null, // allows to disable not namespaced migration completely
        ],
    ],
];

Публичные свойства

Публичные методы

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

События

Постоянные значения

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

$db общедоступное свойство

Объект подключения к БД или идентификатор компонента приложения для подключения к БД, используемого при применении миграций. Начиная с версии 2.0.3, это также может быть массив конфигурации для создания объекта.

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

$fields общедоступное свойство (доступно начиная с версии 2.0.7)

Строки определения столбцов, используемые для создания кода миграции.

Формат каждого определения: COLUMN_NAME:COLUMN_TYPE:COLUMN_DECORATOR. Разделитель: ,. Например, --fields="name:string(12):notNull:unique" создает строковый столбец размером 12, который не допускает NULL и содержит уникальные значения.

Примечание: первичный ключ добавляется автоматически и по умолчанию называется id. Если необходимо использовать другое имя, можно явно указать его, как в --fields="id_key:primaryKey,name:string(12):notNull:unique"

public array $fields = []

$generatorTemplateFiles общедоступное свойство (доступно начиная с версии 2.0.7)

Набор путей шаблонов для автоматического генерирования кода миграции.

Ключ — тип шаблона, значение — путь или псевдоним. Поддерживаемые типы:

• create_table: шаблон для создания таблицы
• drop_table: шаблон для удаления таблицы
• add_column: шаблон для добавления нового столбца
• drop_column: шаблон для удаления столбца
• create_junction: шаблон для создания таблицы связи

public array $generatorTemplateFiles = ['create_table' => '@yii/views/createTableMigration.php', 'drop_table' => '@yii/views/dropTableMigration.php', 'add_column' => '@yii/views/addColumnMigration.php', 'drop_column' => '@yii/views/dropColumnMigration.php', 'create_junction' => '@yii/views/createTableMigration.php']

$migrationTable общедоступное свойство

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

public string $migrationTable = '{{%migration}}'

$templateFile общедоступное свойство

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

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

$useTablePrefix общедоступное свойство (доступно начиная с версии 2.0.8)

Указывает, должны ли имена сгенерированных таблиц учитывать настройку tablePrefix подключения к БД. Например, если имя таблицы post, генератор вернёт {{%post}}.

public boolean $useTablePrefix = false

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