Spec-Zone.ru › Laravel 5.8

Мигратор

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

Свойства

защищённый Dispatcher $events Экземпляр диспетчера событий.
защищённый MigrationRepositoryInterface $repository Реализация репозитория миграций.
защищённый Filesystem $files Экземпляр файловой системы.
защищённый ConnectionResolverInterface $resolver Экземпляр решателя подключений.
защищённый string $connection Имя подключения по умолчанию.
защищённый массив $paths Пути ко всем файлам миграций.
защищённый OutputStyle $output Реализация интерфейса вывода.

Методы

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

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

массив run(массив|строка $paths = [], массив $options = [])

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

массив pendingMigrations(массив $files, массив $ran)

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

void runPending(массив $migrations, массив $options = [])

Запустить массив миграций.

void runUp(строка $file, целое $batch, логическое $pretend)

Запустить миграцию "up".

массив rollback(массив|строка $paths = [], массив $options = [])

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

массив getMigrationsForRollback(массив $options)

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

массив rollbackMigrations(массив $migrations, массив|строка $paths, массив $options)

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

массив reset(массив|строка $paths = [], логическое $pretend = false)

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

массив resetMigrations(массив $migrations, массив $paths, логическое $pretend = false)

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

void runDown(строка $file, объект $migration, логическое $pretend)

Запустить миграцию "down".

void runMigration(объект $migration, строка $method)

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

void pretendToRun(объект $migration, строка $method)

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

массив getQueries(объект $migration, строка $method)

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

объект resolve(строка $file)

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

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

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

void requireFiles(массив $files)

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

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

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

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

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

массив paths()

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

строка getConnection()

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

void setConnection(строка $name)

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

Connection resolveConnection(строка $connection)

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

Grammar getSchemaGrammar(Connection $connection)

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

MigrationRepositoryInterface getRepository()

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

логическое repositoryExists()

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

Filesystem getFilesystem()

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

$this setOutput(OutputStyle $output)

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

void note(строка $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)

Запустить миграцию "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

массив paths()

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

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

массив

строка getConnection()

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

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

строка

пусто setConnection(строка $name)

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

Параметры

строка $name

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

пусто

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

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

Параметры

строка $connection

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

Подключение

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

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

Параметры

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

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

Грамматика

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

Стиль вывода $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/5.8/Illuminate/Database/Migrations/Migrator.html

Spec-Zone.ru

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