Spec-Zone.ru › Laravel 8

Мигратор

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

Свойства

protected Dispatcher $events

Экземпляр диспетчера событий.

protected MigrationRepositoryInterface $repository

Реализация репозитория миграций.

protected Filesystem $files

Экземпляр файловой системы.

protected ConnectionResolverInterface $resolver

Экземпляр решателя подключений.

protected string $connection

Имя подключения по умолчанию.

protected array $paths

Пути ко всем файлам миграций.

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 note(string $message)

Вывести заметку в консольный вывод.

void fireMigrationEvent(MigrationEvent $event)

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

Подробности

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

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

Параметры

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

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

void

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)

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

Параметры

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)

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

Параметры

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

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

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

Параметры

Connection $connection
object $migration
string $method

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

void

object resolve(string $file)

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

Параметры

string $file

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

object

protected object resolvePath(string $path)

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

Параметры

string $path

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

object

protected string getMigrationClass(string $migrationName)

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

Параметры

string $migrationName

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

string

массив getMigrationFiles(строка|массив $paths)

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

Параметры

строка|массив $paths

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

массив

пустое значение requireFiles(массив $files)

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

Параметры

массив $files

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

пустое значение

строка getMigrationName(строка $path)

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

Параметры

строка $path

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

строка

пустое значение path(строка $path)

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

Параметры

строка $path

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

пустое значение

массив paths()

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

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

массив

строка getConnection()

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

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

строка

смешанный тип usingConnection(строка $name, вызываемый объект $callback)

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

Параметры

строка $name
вызываемый объект $callback

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

смешанный тип

пустое значение setConnection(строка $name)

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

Параметры

строка $name

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

пустое значение

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

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

Параметры

строка $connection

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

Подключение

защищённый Грамматика getSchemaGrammar(Подключение $connection)

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

Параметры

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

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

Грамматика

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

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

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

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

логическое значение repositoryExists()

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

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

логическое значение

логическое значение hasRunAnyMigrations()

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

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

логическое значение

пустое значение deleteRepository()

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

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

пустое значение

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

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

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

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

$this setOutput(OutputInterface $output)

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

Параметры

OutputInterface $output

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

$this

защищённый пустое значение note(строка $message)

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

Параметры

строка $message

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

пустое значение

пустое значение fireMigrationEvent(Событие миграции $event)

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

Параметры

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

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

пустое значение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API