laravel / 10 / api / 10.x / illuminate / database / schema / schemastate.html

SchemaState

abstract class SchemaState (View source)

Properties

protected Connection $connection

The connection instance.

protected Filesystem $files

The filesystem instance.

protected string $migrationTable

The name of the application's migration table.

protected callable $processFactory

The process factory callback.

protected callable $output

The output callable instance.

Methods

void __construct(Connection $connection, Filesystem $files = null, callable $processFactory = null)

Create a new dumper instance.

void dump(Connection $connection, string $path)

Dump the database's schema into a file.

void load(string $path)

Load the given schema file into the database.

Process makeProcess(mixed ...$arguments)

Create a new process instance.

$this withMigrationTable(string $table)

Specify the name of the application's migration table.

$this handleOutputUsing(callable $output)

Specify the callback that should be used to handle process output.

Details

void __construct(Connection $connection, Filesystem $files = null, callable $processFactory = null)

Create a new dumper instance.

Parameters

Connection $connection
Filesystem $files
callable $processFactory

Return Value

void

abstract void dump(Connection $connection, string $path)

Dump the database's schema into a file.

Parameters

Connection $connection
string $path

Return Value

void

abstract void load(string $path)

Load the given schema file into the database.

Parameters

string $path

Return Value

void

Process makeProcess(mixed ...$arguments)

Create a new process instance.

Parameters

mixed ...$arguments

Return Value

Process

$this withMigrationTable(string $table)

Specify the name of the application's migration table.

Parameters

string $table

Return Value

$this

$this handleOutputUsing(callable $output)

Specify the callback that should be used to handle process output.

Parameters

callable $output

Return Value

$this

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