1. class
  2. Hypervel
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. PostgresSchemaState

PostgresSchemaState

class PostgresSchemaState extends SchemaState

Traits

GuardsProcessOutput

Properties

protected Connection $connection

The connection instance.

 from  SchemaState
protected Filesystem $files

The filesystem instance.

 from  SchemaState
protected string|null $migrationTable

The name of the application's migration table.

 from  SchemaState
protected Closure $processFactory

The process factory callback.

 from  SchemaState
protected mixed $output

The output callable instance.

 from  SchemaState

Methods

Closure|null
guardProcessOutput(Process $process, callable|null $output)

Stop the process if its output callback fails.

from  GuardsProcessOutput
__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.

array
baseVariables(array $config)

Get the base variables for a dump / load command.

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.

SchemaState
withMigrationTable(string|null $table)

Specify the name of the application's migration table.

from  SchemaState
SchemaState
handleOutputUsing(callable $output)

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

from  SchemaState
string
baseDumpCommand()

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

Details

in GuardsProcessOutput at line 17
protected Closure|null guardProcessOutput(Process $process, callable|null $output)

Stop the process if its output callback fails.

Parameters

Process $process
callable|null $output

Return Value

Closure|null

in SchemaState at line 45
__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 17
void dump(Connection $connection, string $path)

Dump the database's schema into a file.

Parameters

Connection $connection
string $path

Return Value

void

at line 40
void load(string $path)

Load the given schema file into the database.

Parameters

string $path

Return Value

void

at line 88
protected array baseVariables(array $config)

Get the base variables for a dump / load command.

Parameters

array $config

Return Value

array

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

Create a new process instance.

Parameters

mixed ...$arguments

Return Value

Process

in SchemaState at line 88
bool hasMigrationTable()

Determine if the current connection has a migration table.

Return Value

bool

at line 67
protected string getMigrationTable()

Get the name of the application's migration table.

Return Value

string

in SchemaState at line 108
SchemaState withMigrationTable(string|null $table)

Specify the name of the application's migration table.

Parameters

string|null $table

Return Value

SchemaState

in SchemaState at line 120
SchemaState handleOutputUsing(callable $output)

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

Parameters

callable $output

Return Value

SchemaState

at line 80
protected string baseDumpCommand()

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

Return Value

string