interface SchemaSynchronizer (View source)

The synchronizer knows how to synchronize a schema with the configured database.

Methods

string[]
getCreateSchema(Schema $createSchema)

Gets the SQL statements that can be executed to create the schema.

string[]
getUpdateSchema(Schema $toSchema, $noDrops = false)

Gets the SQL Statements to update given schema with the underlying db.

string[]
getDropSchema(Schema $dropSchema)

Gets the SQL Statements to drop the given schema from underlying db.

string[]
getDropAllSchema()

Gets the SQL statements to drop all schema assets from underlying db.

void
createSchema(Schema $createSchema)

Creates the Schema.

void
updateSchema(Schema $toSchema, $noDrops = false)

Updates the Schema to new schema version.

void
dropSchema(Schema $dropSchema)

Drops the given database schema from the underlying db.

void
dropAllSchema()

Drops all assets from the underlying db.

Details

string[] getCreateSchema(Schema $createSchema)

Gets the SQL statements that can be executed to create the schema.

Parameters

Schema $createSchema

Return Value

string[]

string[] getUpdateSchema(Schema $toSchema, $noDrops = false)

Gets the SQL Statements to update given schema with the underlying db.

Parameters

Schema $toSchema
$noDrops

Return Value

string[]

string[] getDropSchema(Schema $dropSchema)

Gets the SQL Statements to drop the given schema from underlying db.

Parameters

Schema $dropSchema

Return Value

string[]

string[] getDropAllSchema()

Gets the SQL statements to drop all schema assets from underlying db.

Return Value

string[]

void createSchema(Schema $createSchema)

Creates the Schema.

Parameters

Schema $createSchema

Return Value

void

void updateSchema(Schema $toSchema, $noDrops = false)

Updates the Schema to new schema version.

Parameters

Schema $toSchema
$noDrops

Return Value

void

void dropSchema(Schema $dropSchema)

Drops the given database schema from the underlying db.

Parameters

Schema $dropSchema

Return Value

void

void dropAllSchema()

Drops all assets from the underlying db.

Return Value

void