Абстрактный класс yii\console\controllers\BaseMigrateController

public string $defaultAction = 'up'

[
    'app\migrations',
    'some\extension\migrations',
]

public array $migrationNamespaces = []

public string|array $migrationPath = ['@app/migrations']

public string $templateFile = null

actionCreate() public method

Создаёт новую миграцию.

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

yii migrate/create create_user_table

Для генерации миграции с пространством имён, вы должны указать пространство имён перед именем миграции. Обратите внимание, что обратная косая черта (\) обычно считается специальным символом в оболочке, поэтому вам необходимо правильно экранировать её, чтобы избежать ошибок оболочки или неправильного поведения. Например:

yii migrate/create 'app\\migrations\\createUserTable'

В случае, если $migrationPath не задан и пространство имён не предоставлено, будет использоваться первая запись из $migrationNamespaces.

public void actionCreate ( $name )
$name	string	Имя новой миграции. Оно должно содержать только буквы, цифры, символы подчеркивания и/или обратные косые черты. Примечание: если имя миграции имеет специальный формат, например create_xxx или drop_xxx, то сгенерированный файл миграции будет содержать дополнительный код, в этом случае для создания/удаления таблиц.
throws	yii\console\Exception	если аргумент name некорректен.

actionDown() public method

Откатывает приложение, откатывая старые миграции.

Например,

yii migrate/down     # revert the last migration
yii migrate/down 3   # revert the last 3 migrations
yii migrate/down all # revert all migrations

public integer actionDown ( $limit = 1 )
$limit	integer|string	Количество миграций для отката. По умолчанию 1, что означает откат последней применённой миграции. При значении "all", все миграции будут откатаны.
return	integer	Статус выполнения действия. 0 означает нормальное выполнение, другие значения означают аномалии.
throws	yii\console\Exception	если указанное число шагов меньше 1.

actionHistory() public method

Отображает историю миграций.

Эта команда покажет список миграций, которые были применены до сих пор. Например,

yii migrate/history     # showing the last 10 migrations
yii migrate/history 5   # showing the last 5 migrations
yii migrate/history all # showing the whole history

public void actionHistory ( $limit = 10 )
$limit	integer|string	Максимальное количество отображаемых миграций. Если значение "all", будет отображена вся история миграций.
throws	yii\console\Exception	если передано некорректное значение limit.

actionMark() public method

Изменяет историю миграций до указанной версии.

Реальных миграций не будет выполнено.

yii migrate/mark 101129_185401                        # using timestamp
yii migrate/mark m101129_185401_create_user_table     # using full name
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name

public integer actionMark ( $version )
$version	string	Версия, до которой должна быть помечена история миграций. Это может быть либо метка времени, либо полное имя миграции.
return	integer	Код выхода в консоли
throws	yii\console\Exception	если аргумент version некорректен или версия не найдена.

actionNew() public method

Отображает не применённые новые миграции.

Эта команда покажет новые миграции, которые ещё не были применены. Например,

yii migrate/new     # showing the first 10 new migrations
yii migrate/new 5   # showing the first 5 new migrations
yii migrate/new all # showing all new migrations

public void actionNew ( $limit = 10 )
$limit	integer|string	Максимальное количество новых миграций для отображения. Если это all, будут отображены все доступные новые миграции.
throws	yii\console\Exception	если передано некорректное значение limit.

actionRedo() public method

Повторяет последние несколько миграций.

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

yii migrate/redo     # redo the last applied migration
yii migrate/redo 3   # redo the last 3 applied migrations
yii migrate/redo all # redo all migrations

public integer actionRedo ( $limit = 1 )
$limit	integer|string	Количество миграций для повторного применения. По умолчанию 1, что означает повторное применение последней применённой миграции. При значении "all", все миграции будут повторены.
return	integer	Статус выполнения действия. 0 означает нормальное выполнение, другие значения означают аномалии.
throws	yii\console\Exception	если указанное число шагов меньше 1.

actionTo() public method

Обновляет или откатывает до указанной версии.

Также может отменить версии до определённого момента в прошлом, указав метку времени UNIX или строку, распознаваемую функцией strtotime(). Это означает, что все версии, применённые после указанного момента времени, будут отменены.

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

yii migrate/to 101129_185401                          # using timestamp
yii migrate/to m101129_185401_create_user_table       # using full name
yii migrate/to 1392853618                             # using UNIX timestamp
yii migrate/to "2014-02-15 13:00:50"                  # using strtotime() parseable string
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name

public void actionTo ( $version )
$version	string	Имя версии или значение времени в прошлом, до которого должно быть обновлено приложение. Это может быть метка времени, полное имя миграции, метка времени UNIX или распознаваемая строка даты и времени.
throws	yii\console\Exception	если аргумент version некорректен.

actionUp() public method

Обновляет приложение, применяя новые миграции.

Например,

yii migrate     # apply all new migrations
yii migrate 3   # apply the first 3 new migrations

public integer actionUp ( $limit = 0 )
$limit	integer	Количество новых миграций для применения. Если 0, это означает применение всех доступных новых миграций.
return	integer	Статус выполнения действия. 0 означает нормальное выполнение, другие значения означают аномалии.

addMigrationHistory() protected abstract method

Добавляет новую запись миграции в историю.

protected abstract void addMigrationHistory ( $version )
$version	string	Имя версии миграции.

beforeAction() public method

Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). Он проверяет существование $migrationPath.

public boolean beforeAction ( $action )
$action	yii\base\Action	Действие, которое должно быть выполнено.
return	boolean	Выполняется ли действие.
throws	yii\base\InvalidConfigException	если указанная в migrationPath директория не существует и действие не "create".

createMigration() protected method

Создаёт новый экземпляр миграции.

protected yii\db\MigrationInterface createMigration ( $class )
$class	string	Имя класса миграции
return	yii\db\MigrationInterface	Экземпляр миграции

generateMigrationSourceCode() protected method (available since version 2.0.8)

Генерирует новый PHP-код миграции.

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

protected string generateMigrationSourceCode ( $params )
$params	array	Параметры генерации, обычно присутствуют следующие: name: строка базового имени миграции className: строка имени класса миграции
return	string	Сгенерированный PHP-код.

getMigrationHistory() protected abstract method

Возвращает историю миграций.

protected abstract array getMigrationHistory ( $limit )
$limit	integer	Максимальное количество записей в истории, которые нужно вернуть. null для "без ограничения".
return	array	История миграций

getNewMigrations() protected method

Возвращает миграции, которые не были применены.

protected array getNewMigrations ( )
return	array	Список новых миграций

includeMigrationFile() protected method (доступно начиная с версии 2.0.12)

Включает файл миграции для данного имени класса миграции.

Эта функция ничего не сделает для миграций с именованными пространствами, которые загружаются автоматически загрузчиком. Она включит файл миграции, выполнив поиск в $migrationPath для классов без пространства имён.

protected void includeMigrationFile ( $class )
$class	string	Имя класса миграции.

migrateDown() protected method

Выполняет откат миграций с указанным классом миграции.

protected boolean migrateDown ( $class )
$class	string	Имя класса миграции
return	boolean	Успешно ли выполнена миграция

migrateToTime() protected method

Переносит миграции до указанного времени в прошлом.

protected void migrateToTime ( $time )
$time	integer	Значение временной метки Unix.

migrateToVersion() protected method

Переносит миграции до определённой версии.

protected integer migrateToVersion ( $version )
$version	string	Имя в полном формате.
return	integer	Код выхода CLI
throws	yii\console\Exception	если указанная версия не найдена.

migrateUp() protected method

Применяет миграции с указанным классом миграции.

protected boolean migrateUp ( $class )
$class	string	Имя класса миграции
return	boolean	Успешно ли выполнена миграция

options() public method

Возвращает имена допустимых опций для действия (id). Опция требует наличия открытого члена переменной с именем, совпадающим с именем опции.

Подклассы могут переопределить этот метод для указания возможных опций.

Обратите внимание, что значения, установленные через опции, недоступны до вызова beforeAction().

public string[] options ( $actionID )
$actionID	string	Идентификатор действия текущего запроса
return	string[]	Имена опций, допустимых для действия

removeMigrationHistory() protected abstract method

Удаляет существующую миграцию из истории.

protected abstract void removeMigrationHistory ( $version )
$version	string	Имя версии миграции.