W3cubDocs

/Laravel 11

MariaDbSchemaState

class MariaDbSchemaState extends MySqlSchemaState (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

void __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.

 from MySqlSchemaState
void load(string $path)

Load the given schema file into the database.

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

 from MySqlSchemaState
void appendMigrationData(string $path)

Append the migration data to the schema dump.

 from MySqlSchemaState
string baseDumpCommand()

Get the base dump command arguments for MariaDB as a string.
string connectionString()

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

 from MySqlSchemaState
array baseVariables(array $config)

Get the base variables for a dump / load command.

 from MySqlSchemaState
Process executeDumpProcess(Process $process, callable $output, array $variables)

Execute the given dump process.

 from MySqlSchemaState

Details

void __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

Return Value

void

void dump(Connection $connection, string $path)

Dump the database's schema into a file.

Parameters

Connection $connection
string $path

Return Value

void

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

bool hasMigrationTable()

Determine if the current connection has a migration table.

Return Value

bool

protected string getMigrationTable()

Get the name of the application's migration table.

Return Value

string

$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

protected void removeAutoIncrementingState(string $path)

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

Parameters

string $path

Return Value

void

protected void appendMigrationData(string $path)

Append the migration data to the schema dump.

Parameters

string $path

Return Value

void

protected string baseDumpCommand()

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

Return Value

string

protected string connectionString()

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

Return Value

string

protected array baseVariables(array $config)

Get the base variables for a dump / load command.

Parameters

array $config

Return Value

array

protected Process executeDumpProcess(Process $process, callable $output, array $variables)

Execute the given dump process.

Parameters

Process $process
callable $output
array $variables

Return Value

Process

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