Мигратор

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

Свойства

protected Dispatcher	$events	Экземпляр диспетчера событий.
protected MigrationRepositoryInterface	$repository	Реализация репозитория миграций.
protected Filesystem	$files	Экземпляр файловой системы.
protected ConnectionResolverInterface	$resolver	Экземпляр решателя подключения.
protected string	$connection	Имя подключения по умолчанию.
protected array	$paths	Пути ко всем файлам миграций.
static protected Migration\|null>	$requiredPathCache	Пути, которые уже были подгружены.
protected OutputInterface	$output	Реализация интерфейса вывода.

Методы

void

__construct(MigrationRepositoryInterface $repository, ConnectionResolverInterface $resolver, Filesystem $files, Dispatcher $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)

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

void

runMethod(Connection $connection, object $migration, string $method)

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

object

resolve(string $file)

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

object

resolvePath(string $path)

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

string

getMigrationClass(string $migrationName)

Сгенерировать имя класса миграции на основе имени файла миграции.

array

getMigrationFiles(string|array $paths)

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

void

requireFiles(array $files)

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

string

getMigrationName(string $path)

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

void

path(string $path)

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

array

paths()

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

string

getConnection()

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

mixed

usingConnection(string $name, callable $callback)

Выполнить заданный обратный вызов, используя заданное подключение в качестве подключения по умолчанию.

void

setConnection(string $name)

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

Connection

resolveConnection(string $connection)

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

Grammar

getSchemaGrammar(Connection $connection)

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

MigrationRepositoryInterface

getRepository()

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

bool

repositoryExists()

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

bool

hasRunAnyMigrations()

Определить, были ли выполнены какие-либо миграции.

void

deleteRepository()

Удалить хранилище данных миграций.

Filesystem

getFilesystem()

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

$this

setOutput(OutputInterface $output)

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

void

write(string $component, array<int,string>|string ...$arguments)

Вывести в консольный вывод.

void

fireMigrationEvent(MigrationEvent $event)

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

Подробности

void __construct(MigrationRepositoryInterface $repository, ConnectionResolverInterface $resolver, Filesystem $files, Dispatcher $dispatcher = null)

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

Parameters

MigrationRepositoryInterface	$repository
ConnectionResolverInterface	$resolver
Filesystem	$files
Dispatcher	$dispatcher

Return Value

void

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

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

Parameters

array\|string	$paths
array	$options

Return Value

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

protected void runMethod(Connection $connection, object $migration, string $method)

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

Parameters

Connection	$connection
object	$migration
string	$method

Return Value

void

object resolve(string $file)

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

Parameters

string

$file

Return Value

object

protected object resolvePath(string $path)

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

Parameters

string

$path

Return Value

object

protected string getMigrationClass(string $migrationName)

Сгенерировать имя класса миграции на основе имени файла миграции.

Parameters

string

$migrationName

Return Value

string

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)

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

Параметры

string

$path

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

void

array paths()

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

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

array

string getConnection()

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

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

string

mixed usingConnection(string $name, callable $callback)

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

Параметры

string	$name
callable	$callback

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

mixed

void setConnection(string $name)

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

Параметры

string

$name

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

void

Connection resolveConnection(string $connection)

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

Параметры

string

$connection

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

Connection

protected Grammar getSchemaGrammar(Connection $connection)

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

Параметры

Connection

$connection

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

Grammar

MigrationRepositoryInterface getRepository()

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

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

MigrationRepositoryInterface

bool repositoryExists()

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

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

bool

bool hasRunAnyMigrations()

Определить, были ли выполнены какие-либо миграции.

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

bool

void deleteRepository()

Удалить хранилище данных миграций.

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

void

Filesystem getFilesystem()

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

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

Filesystem

$this setOutput(OutputInterface $output)

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

Параметры

OutputInterface

$output

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

$this

protected void write(string $component, array<int,string>|string ...$arguments)

Записать в вывод консоли.

Параметры

string	$component
array<int,string>\|string	...$arguments

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

void

void fireMigrationEvent(MigrationEvent $event)

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

Параметры

MigrationEvent

$event

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

void

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