Мигратор

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

Свойства

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

Методы

void

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

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

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 __construct(Интерфейс репозитория миграций $repository, Интерфейс разрешения подключения $resolver, Файловая система $files)

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

Параметры

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

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

void

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

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

Параметры

array\|string	$paths
array	$options

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

array

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

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

Parameters

array	$files
array	$ran

Return Value

array

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

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

Parameters

array	$migrations
array	$options

Return Value

void

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

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

Parameters

string	$file
int	$batch
bool	$pretend

Return Value

void

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

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

Parameters

array\|string	$paths
array	$options

Return Value

array

protected array getMigrationsForRollback(array $options)

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

Parameters

array

$options

Return Value

array

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

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

Parameters

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

Return Value

array

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

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

Parameters

array\|string	$paths
bool	$pretend

Return Value

array

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

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

Parameters

array	$migrations
array	$paths
bool	$pretend

Return Value

array

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

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

Parameters

string	$file
object	$migration
bool	$pretend

Return Value

void

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

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

Parameters

object	$migration
string	$method

Return Value

void

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

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

Parameters

object	$migration
string	$method

Return Value

void

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

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

Parameters

object	$migration
string	$method

Return Value

array

object resolve(string $file)

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

Parameters

string

$file

Return Value

object

array getMigrationFiles(string|array $paths)

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

Parameters

string|array

$paths

Return Value

array

void requireFiles(array $files)

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

Parameters

array

$files

Return Value

void

string getMigrationName(string $path)

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

Parameters

string

$path

Return Value

string

void path(string $path)

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

Parameters

string

$path

Return Value

void

array paths()

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

Return Value

array

string getConnection()

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

Return Value

string

void setConnection(string $name)

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

Parameters

string

$name

Return Value

void

Connection resolveConnection(string $connection)

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

Parameters

string

$connection

Return Value

Connection

protected Grammar getSchemaGrammar(Connection $connection)

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

Параметры

Connection

$connection

Значение возврата

Grammar

MigrationRepositoryInterface getRepository()

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

Значение возврата

MigrationRepositoryInterface

bool repositoryExists()

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

Значение возврата

bool

Filesystem getFilesystem()

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

Значение возврата

Filesystem

$this setOutput(OutputStyle $output)

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

Параметры

OutputStyle

$output

Значение возврата

$this

protected void note(string $message)

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

Параметры

string

$message

Значение возврата

void

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