Migrator

class Migrator (View source)

Properties

protected MigrationRepositoryInterface $repository The migration repository implementation.
protected Filesystem $files The filesystem instance.
protected ConnectionResolverInterface $resolver The connection resolver instance.
protected string $connection The name of the default connection.
protected array $notes The notes for the current operation.

Methods

void __construct(MigrationRepositoryInterface $repository, ConnectionResolverInterface $resolver, Filesystem $files)

Create a new migrator instance.
void run(string $path, bool $pretend = false)

Run the outstanding migrations at a given path.
void runMigrationList(array $migrations, bool $pretend = false)

Run an array of migrations.
void runUp(string $file, int $batch, bool $pretend)

Run "up" a migration instance.
int rollback(bool $pretend = false)

Rollback the last migration operation.
int reset(bool $pretend = false)

Rolls all of the currently applied migrations back.
void runDown(object $migration, bool $pretend)

Run "down" a migration instance.
array getMigrationFiles(string $path)

Get all of the migration files in a given path.
void requireFiles(string $path, array $files)

Require in all the migration files in a given path.
void pretendToRun(object $migration, string $method)

Pretend to run the migrations.
array getQueries(object $migration, string $method)

Get all of the queries that would be run for a migration.
object resolve(string $file)

Resolve a migration instance from a file.
void note(string $message)

Raise a note event for the migrator.
array getNotes()

Get the notes for the last operation.
Connection resolveConnection(string $connection)

Resolve the database connection instance.
void setConnection(string $name)

Set the default connection name.
MigrationRepositoryInterface getRepository()

Get the migration repository instance.
bool repositoryExists()

Determine if the migration repository exists.
Filesystem getFilesystem()

Get the file system instance.

Details

void __construct(MigrationRepositoryInterface $repository, ConnectionResolverInterface $resolver, Filesystem $files)

Create a new migrator instance.

Parameters

MigrationRepositoryInterface $repository
ConnectionResolverInterface $resolver
Filesystem $files

Return Value

void

void run(string $path, bool $pretend = false)

Run the outstanding migrations at a given path.

Parameters

string $path
bool $pretend

Return Value

void

void runMigrationList(array $migrations, bool $pretend = false)

Run an array of migrations.

Parameters

array $migrations
bool $pretend

Return Value

void

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

Run "up" a migration instance.

Parameters

string $file
int $batch
bool $pretend

Return Value

void

int rollback(bool $pretend = false)

Rollback the last migration operation.

Parameters

bool $pretend

Return Value

int

int reset(bool $pretend = false)

Rolls all of the currently applied migrations back.

Parameters

bool $pretend

Return Value

int

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

Run "down" a migration instance.

Parameters

object $migration
bool $pretend

Return Value

void

array getMigrationFiles(string $path)

Get all of the migration files in a given path.

Parameters

string $path

Return Value

array

void requireFiles(string $path, array $files)

Require in all the migration files in a given path.

Parameters

string $path
array $files

Return Value

void

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

Pretend to run the migrations.

Parameters

object $migration
string $method

Return Value

void

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

Get all of the queries that would be run for a migration.

Parameters

object $migration
string $method

Return Value

array

object resolve(string $file)

Resolve a migration instance from a file.

Parameters

string $file

Return Value

object

protected void note(string $message)

Raise a note event for the migrator.

Parameters

string $message

Return Value

void

array getNotes()

Get the notes for the last operation.

Return Value

array

Connection resolveConnection(string $connection)

Resolve the database connection instance.

Parameters

string $connection

Return Value

Connection

void setConnection(string $name)

Set the default connection name.

Parameters

string $name

Return Value

void

MigrationRepositoryInterface getRepository()

Get the migration repository instance.

Return Value

MigrationRepositoryInterface

bool repositoryExists()

Determine if the migration repository exists.

Return Value

bool

Filesystem getFilesystem()

Get the file system instance.

Return Value

Filesystem

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