Documentation

SchemaSynchronizer
in

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

Tags
author

Benjamin Eberlei kontakt@beberlei.de

Table of Contents

createSchema()  : void
Creates the Schema.
dropAllSchema()  : void
Drops all assets from the underlying db.
dropSchema()  : void
Drops the given database schema from the underlying db.
getCreateSchema()  : array<string|int, mixed>
Gets the SQL statements that can be executed to create the schema.
getDropAllSchema()  : array<string|int, mixed>
Gets the SQL statements to drop all schema assets from underlying db.
getDropSchema()  : array<string|int, mixed>
Gets the SQL Statements to drop the given schema from underlying db.
getUpdateSchema()  : array<string|int, mixed>
Gets the SQL Statements to update given schema with the underlying db.
updateSchema()  : void
Updates the Schema to new schema version.

Methods

createSchema()

Creates the Schema.

public createSchema(Schema $createSchema) : void
Parameters
$createSchema : Schema
Return values
void —

dropAllSchema()

Drops all assets from the underlying db.

public dropAllSchema() : void
Return values
void —

dropSchema()

Drops the given database schema from the underlying db.

public dropSchema(Schema $dropSchema) : void
Parameters
$dropSchema : Schema
Return values
void —

getCreateSchema()

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

public getCreateSchema(Schema $createSchema) : array<string|int, mixed>
Parameters
$createSchema : Schema
Return values
array<string|int, mixed> —

getDropAllSchema()

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

public getDropAllSchema() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getDropSchema()

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

public getDropSchema(Schema $dropSchema) : array<string|int, mixed>
Parameters
$dropSchema : Schema
Return values
array<string|int, mixed> —

getUpdateSchema()

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

public getUpdateSchema(Schema $toSchema[, bool $noDrops = false ]) : array<string|int, mixed>
Parameters
$toSchema : Schema
$noDrops : bool = false
Return values
array<string|int, mixed> —

updateSchema()

Updates the Schema to new schema version.

public updateSchema(Schema $toSchema[, bool $noDrops = false ]) : void
Parameters
$toSchema : Schema
$noDrops : bool = false
Return values
void —

Search results