Мигратор

класс Мигратор (Просмотреть исходный код)

Свойства

protected Диспечер событий	$events	Экземпляр диспечера событий.
protected Интерфейс репозитория миграций	$repository	Реализация репозитория миграций.
protected Файловая система	$files	Экземпляр файловой системы.
protected Интерфейс разрешения подключения	$resolver	Экземпляр разрешителя подключения.
protected string	$connection	Имя подключения по умолчанию.
protected array	$paths	Пути ко всем файлам миграций.
protected Стиль вывода	$output	Реализация интерфейса вывода.

Методы

void

__construct(Интерфейс репозитория миграций $repository, Интерфейс разрешения подключения $resolver, Файловая система $files, Диспечер событий $dispatcher = null)

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

array

run(array|string $paths = [], array $options = [])

Выполнить ожидающие миграции по заданному пути.

array

pendingMigrations(array $files, array $ran)

Получить файлы миграций, которые еще не были выполнены.

void

runPending(array $migrations, array $options = [])

Выполнить массив миграций.

void

runUp(string $file, int $batch, bool $pretend)

Выполнить миграцию "up".

array

rollback(array|string $paths = [], array $options = [])

Откатить последнюю операцию миграции.

array

getMigrationsForRollback(array $options)

Получить миграции для операции отката.

array

rollbackMigrations(array $migrations, array|string $paths, array $options)

Откатить заданные миграции.

array

reset(array|string $paths = [], bool $pretend = false)

Откатывает все примененные миграции.

array

resetMigrations(array $migrations, array $paths, bool $pretend = false)

Сбросить заданные миграции.

void

runDown(string $file, object $migration, bool $pretend)

Выполнить миграцию "down".

void

runMigration(object $migration, string $method)

Выполнить миграцию внутри транзакции, если база данных её поддерживает.

void

pretendToRun(object $migration, string $method)

Выполнить миграции в режиме "представления".

array

getQueries(object $migration, string $method)

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

object

resolve(string $file)

Разрешить экземпляр миграции из файла.

array

getMigrationFiles(string|array $paths)

Получить все файлы миграций в заданном пути.

void

requireFiles(array $files)

Подключить все файлы миграций в заданном пути.

string

getMigrationName(string $path)

Получить имя миграции.

void

path(string $path)

Зарегистрировать пользовательский путь к миграциям.

array

paths()

Получить все пользовательские пути к миграциям.

string

getConnection()

Получить имя подключения по умолчанию.

void

setConnection(string $name)

Установить имя подключения по умолчанию.

Подключение

resolveConnection(string $connection)

Разрешить экземпляр подключения к базе данных.

Грамматика

getSchemaGrammar(Подключение $connection)

Получить грамматику схемы из подключения миграции.

Интерфейс репозитория миграций

getRepository()

Получить экземпляр репозитория миграций.

bool

repositoryExists()

Определить, существует ли репозиторий миграций.

Файловая система

getFilesystem()

Получить экземпляр файловой системы.

$this

setOutput(Стиль вывода $output)

Установить реализацию вывода, которая должна использоваться консолью.

void

note(string $message)

Записать примечание в вывод консоли.

void

fireMigrationEvent(Событие миграции $event)

Вызвать данное событие для миграции.

Подробное описание

void __construct(Интерфейс репозитория миграций $repository, Интерфейс разрешения подключения $resolver, Файловая система $files, Диспечер событий $dispatcher = null)

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

Параметры

Интерфейс репозитория миграций	$repository
Интерфейс разрешения подключения	$resolver
Файловая система	$files
Диспечер событий	$dispatcher

Возвращаемое значение

void

END_OF_DOCUMENT_MARKER ```

array run(array|string $paths = [], array $options = [])

Запустить ожидающие миграции по заданному пути.

Параметры

array\|string	$paths
array	$options

Возвращаемое значение

array

protected array pendingMigrations(array $files, array $ran)

Получить файлы миграций, которые ещё не были выполнены.

Параметры

array	$files
array	$ran

Возвращаемое значение

array

void runPending(array $migrations, array $options = [])

Выполнить массив миграций.

Параметры

array	$migrations
array	$options

Возвращаемое значение

void

protected void runUp(string $file, int $batch, bool $pretend)

Выполнить миграцию "up".

Параметры

string	$file
int	$batch
bool	$pretend

Возвращаемое значение

void

array rollback(array|string $paths = [], array $options = [])

Откатить последнюю операцию миграции.

Параметры

array\|string	$paths
array	$options

Возвращаемое значение

array

protected array getMigrationsForRollback(array $options)

Получить миграции для операции отката.

Параметры

array

$options

Возвращаемое значение

array

protected array rollbackMigrations(array $migrations, array|string $paths, array $options)

Откатить заданные миграции.

Параметры

array	$migrations
array\|string	$paths
array	$options

Возвращаемое значение

array

array reset(array|string $paths = [], bool $pretend = false)

Откатить все примененные миграции.

Параметры

array\|string	$paths
bool	$pretend

Возвращаемое значение

array

protected array resetMigrations(array $migrations, array $paths, bool $pretend = false)

Сбросить заданные миграции.

Параметры

array	$migrations
array	$paths
bool	$pretend

Возвращаемое значение

array

protected void runDown(string $file, object $migration, bool $pretend)

Выполнить миграцию "down".

Параметры

string	$file
object	$migration
bool	$pretend

Возвращаемое значение

void

protected void runMigration(object $migration, string $method)

Выполнить миграцию в рамках транзакции, если база данных это поддерживает.

Параметры

object	$migration
string	$method

Возвращаемое значение

void

protected void pretendToRun(object $migration, string $method)

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

Параметры

object	$migration
string	$method

Возвращаемое значение

void

protected array getQueries(object $migration, string $method)

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

Параметры

object	$migration
string	$method

Возвращаемое значение

array

object resolve(string $file)

Разрешить экземпляр миграции из файла.

Параметры

string

$file

Возвращаемое значение

object

array getMigrationFiles(string|array $paths)

Получить все файлы миграций в заданном пути.

Параметры

string|array

$paths

Возвращаемое значение

array

void requireFiles(array $files)

Включить все файлы миграций в заданном пути.

Параметры

array

$files

Возвращаемое значение

void

string getMigrationName(string $path)

Получить имя миграции.

Параметры

string

$path

Возвращаемое значение

string

void path(string $path)

Зарегистрировать пользовательский путь миграций.

Параметры

string

$path

Возвращаемое значение

void

array paths()

Получить все пользовательские пути миграций.

Возвращаемое значение

array

string getConnection()

Получить имя подключения по умолчанию.

Возвращаемое значение

string

void setConnection(string $name)

Установить имя подключения по умолчанию.

Параметры

string

$name

Возвращаемое значение

void

Подключение resolveConnection(строка $connection)

Разрешить подключение к базе данных.

Параметры

строка

$connection

Возвращаемое значение

Подключение

protected Грамматика getSchemaGrammar(Подключение $connection)

Получить грамматику схемы из подключения миграции.

Параметры

Подключение

$connection

Возвращаемое значение

Грамматика

Интерфейс репозитория миграций getRepository()

Получить экземпляр репозитория миграций.

Возвращаемое значение

Интерфейс репозитория миграций

bool repositoryExists()

Определить, существует ли репозиторий миграций.

Возвращаемое значение

bool

Система файлов getFilesystem()

Получить экземпляр системы файлов.

Возвращаемое значение

Система файлов

$this setOutput(Стиль вывода $output)

Установить реализацию вывода, которая должна использоваться консолью.

Параметры

Стиль вывода

$output

Возвращаемое значение

$this

protected void note(строка $message)

Записать примечание в вывод консоли.

Параметры

строка

$message

Возвращаемое значение

void

void fireMigrationEvent(Событие миграции $event)

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

Параметры

Событие миграции

$event

Возвращаемое значение

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Database/Migrations/Migrator.html