1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. MySqlSchemaState

MySqlSchemaState

class MySqlSchemaState extends SchemaState (View source)

Properties

protected Connection $connection

The connection instance.

 from  SchemaState
protected Filesystem $files

The filesystem instance.

 from  SchemaState
protected string $migrationTable

The name of the application's migration table.

 from  SchemaState
protected callable $processFactory

The process factory callback.

 from  SchemaState
protected callable $output

The output callable instance.

 from  SchemaState

Methods

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

Create a new dumper instance.

from  SchemaState
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.

from  SchemaState
bool
hasMigrationTable()

Determine if the current connection has a migration table.

from  SchemaState
string
getMigrationTable()

Get the name of the application's migration table.

from  SchemaState
$this
withMigrationTable(string $table)

Specify the name of the application's migration table.

from  SchemaState
$this
handleOutputUsing(callable $output)

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

from  SchemaState
void
removeAutoIncrementingState(string $path)

Remove the auto-incrementing state from the given schema dump.

void
appendMigrationData(string $path)

Append the migration data to the schema dump.

string
baseDumpCommand()

Get the base dump command arguments for MySQL as a string.

string
connectionString()

Generate a basic connection string (--socket, --host, --port, --user, --password) for the database.

array
baseVariables(array $config)

Get the base variables for a dump / load command.

Process
executeDumpProcess(Process $process, callable $output, array $variables, int $depth = 0)

Execute the given dump process.

Details

in SchemaState at line 53
__construct(Connection $connection, Filesystem|null $files = null, callable|null $processFactory = null)

Create a new dumper instance.

Parameters

Connection $connection
Filesystem|null $files
callable|null $processFactory

at line 19
void dump(Connection $connection, string $path)

Dump the database's schema into a file.

Parameters

Connection $connection
string $path

Return Value

void

at line 72
void load(string $path)

Load the given schema file into the database.

Parameters

string $path

Return Value

void

in SchemaState at line 91
Process makeProcess(mixed ...$arguments)

Create a new process instance.

Parameters

mixed ...$arguments

Return Value

Process

in SchemaState at line 101
bool hasMigrationTable()

Determine if the current connection has a migration table.

Return Value

bool

in SchemaState at line 111
protected string getMigrationTable()

Get the name of the application's migration table.

Return Value

string

in SchemaState at line 122
$this withMigrationTable(string $table)

Specify the name of the application's migration table.

Parameters

string $table

Return Value

$this

in SchemaState at line 135
$this handleOutputUsing(callable $output)

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

Parameters

callable $output

Return Value

$this

at line 40
protected void removeAutoIncrementingState(string $path)

Remove the auto-incrementing state from the given schema dump.

Parameters

string $path

Return Value

void

at line 55
protected void appendMigrationData(string $path)

Append the migration data to the schema dump.

Parameters

string $path

Return Value

void

at line 88
protected string baseDumpCommand()

Get the base dump command arguments for MySQL as a string.

Return Value

string

at line 104
protected string connectionString()

Generate a basic connection string (--socket, --host, --port, --user, --password) for the database.

Return Value

string

at line 127
protected array baseVariables(array $config)

Get the base variables for a dump / load command.

Parameters

array $config

Return Value

array

at line 151
protected Process executeDumpProcess(Process $process, callable $output, array $variables, int $depth = 0)

Execute the given dump process.

Parameters

Process $process
callable $output
array $variables
int $depth

Return Value

Process