1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439:
<?php
namespace Inlm\SchemaGenerator\Dumpers;
use CzProject\SqlGenerator;
use CzProject\SqlSchema;
use Inlm\SchemaGenerator\Database;
use Inlm\SchemaGenerator\Diffs;
use Inlm\SchemaGenerator\IDumper;
use Inlm\SchemaGenerator\SchemaGenerator;
abstract class AbstractSqlDumper implements IDumper
{
protected $sqlDocument;
protected $description;
protected $databaseType;
protected $header;
protected $positionChanges = FALSE;
protected $started = FALSE;
protected $_tableAlter = array(
'table' => NULL,
'statement' => NULL,
);
public function setHeader(array $header = NULL)
{
$this->header = $header;
return $this;
}
public function enablePositionChanges($positionChanges = TRUE)
{
$this->positionChanges = $positionChanges;
return $this;
}
public function start($databaseType, $description = NULL)
{
if ($this->started) {
throw new \Inlm\SchemaGenerator\InvalidStateException('Dumper is already started.');
}
$this->sqlDocument = new SqlGenerator\SqlDocument;
$this->description = $description;
$this->databaseType = $databaseType;
$this->started = TRUE;
}
public function createTable(Diffs\CreatedTable $table)
{
$this->checkIfStarted();
$definition = $table->getDefinition();
$createTable = $this->sqlDocument->createTable($definition->getName());
$createTable->setComment($definition->getComment());
foreach ($definition->getOptions() as $option => $value) {
$createTable->setOption($option, $value);
}
foreach ($definition->getColumns() as $column) {
$createTable->addColumn(
$column->getName(),
$column->getType(),
$column->getParameters(),
$column->getOptions()
)
->setNullable($column->isNullable())
->setAutoIncrement($column->isAutoIncrement())
->setDefaultValue($column->getDefaultValue())
->setComment($column->getComment());
}
foreach ($definition->getIndexes() as $index) {
$tableIndex = $createTable->addIndex($index->getName(), $index->getType());
foreach ($index->getColumns() as $indexColumn) {
$tableIndex->addColumn(
$indexColumn->getName(),
$indexColumn->getOrder(),
$indexColumn->getLength()
);
}
}
foreach ($definition->getForeignKeys() as $foreignKey) {
$createTable->addForeignKey(
$foreignKey->getName(),
$foreignKey->getColumns(),
$foreignKey->getTargetTable(),
$foreignKey->getTargetColumns()
)
->setOnUpdateAction($foreignKey->getOnUpdateAction())
->setOnDeleteAction($foreignKey->getOnDeleteAction());
}
}
public function removeTable(Diffs\RemovedTable $table)
{
$this->checkIfStarted();
$this->sqlDocument->dropTable($table->getTableName());
}
public function createTableColumn(Diffs\CreatedTableColumn $column)
{
$this->checkIfStarted();
$definition = $column->getDefinition();
$createdColumn = $this->getTableAlter($column->getTableName())
->addColumn(
$definition->getName(),
$definition->getType(),
$definition->getParameters(),
$definition->getOptions()
)
->setNullable($definition->isNullable())
->setAutoIncrement($definition->isAutoIncrement())
->setDefaultValue($definition->getDefaultValue())
->setComment($definition->getComment());
if ($this->positionChanges) {
if ($column->getAfterColumn() === NULL) {
$createdColumn->moveToFirstPosition();
} else {
$createdColumn->moveAfterColumn($column->getAfterColumn());
}
}
}
public function updateTableColumn(Diffs\UpdatedTableColumn $column)
{
$this->checkIfStarted();
if (!$this->positionChanges && $column->hasOnlyPositionChange()) {
return;
}
$definition = $column->getDefinition();
$updatedColumn = $this->getTableAlter($column->getTableName())
->modifyColumn(
$definition->getName(),
$definition->getType(),
$definition->getParameters(),
$definition->getOptions()
)
->setNullable($definition->isNullable())
->setAutoIncrement($definition->isAutoIncrement())
->setDefaultValue($definition->getDefaultValue())
->setComment($definition->getComment());
if ($this->positionChanges) {
if ($column->getAfterColumn() === NULL) {
$updatedColumn->moveToFirstPosition();
} else {
$updatedColumn->moveAfterColumn($column->getAfterColumn());
}
}
}
public function removeTableColumn(Diffs\RemovedTableColumn $column)
{
$this->checkIfStarted();
$this->getTableAlter($column->getTableName())
->dropColumn($column->getColumnName());
}
public function createTableIndex(Diffs\CreatedTableIndex $index)
{
$this->checkIfStarted();
$alter = $this->getTableAlter($index->getTableName());
$this->addIndex($alter, $index->getDefinition());
}
public function updateTableIndex(Diffs\UpdatedTableIndex $index)
{
$this->checkIfStarted();
$alter = $this->getTableAlter($index->getTableName());
$alter->dropIndex($index->getIndexName());
$this->addIndex($alter, $index->getDefinition());
}
public function removeTableIndex(Diffs\RemovedTableIndex $index)
{
$this->checkIfStarted();
$this->getTableAlter($index->getTableName())
->dropIndex($index->getIndexName());
}
public function createForeignKey(Diffs\CreatedForeignKey $foreignKey)
{
$this->checkIfStarted();
$alter = $this->getTableAlter($foreignKey->getTableName());
$this->addForeignKey($alter, $foreignKey->getDefinition());
}
public function updateForeignKey(Diffs\UpdatedForeignKey $foreignKey)
{
$this->checkIfStarted();
$alter = $this->getTableAlter($foreignKey->getTableName());
$alter->dropForeignKey($foreignKey->getForeignKeyName());
$this->addForeignKey($alter, $foreignKey->getDefinition());
}
public function removeForeignKey(Diffs\RemovedForeignKey $foreignKey)
{
$this->checkIfStarted();
$this->getTableAlter($foreignKey->getTableName())
->dropForeignKey($foreignKey->getForeignKeyName());
}
public function addTableOption(Diffs\AddedTableOption $option)
{
$this->checkIfStarted();
$this->getTableAlter($option->getTableName())
->setOption($option->getOption(), $option->getValue());
}
public function updateTableOption(Diffs\UpdatedTableOption $option)
{
$this->checkIfStarted();
$this->getTableAlter($option->getTableName())
->setOption($option->getOption(), $option->getValue());
}
public function removeTableOption(Diffs\RemovedTableOption $option)
{
throw new \Inlm\SchemaGenerator\UnsupportedException('Removing of table options is not supported.');
}
public function updateTableComment(Diffs\UpdatedTableComment $comment)
{
$this->checkIfStarted();
$this->getTableAlter($comment->getTableName())
->setComment($comment->getComment());
}
protected function checkIfStarted()
{
if (!$this->started) {
throw new \Inlm\SchemaGenerator\InvalidStateException('Dumper is not started, call $dumper->start().');
}
}
protected function stop()
{
$this->started = FALSE;
$this->description = NULL;
}
protected function addIndex(SqlGenerator\Statements\AlterTable $alter, SqlSchema\Index $definition)
{
$index = $alter->addIndex($definition->getName(), $definition->getType());
foreach ($definition->getColumns() as $column) {
$index->addColumn($column->getName(), $column->getOrder(), $column->getLength());
}
}
protected function addForeignKey(SqlGenerator\Statements\AlterTable $alter, SqlSchema\ForeignKey $definition)
{
$foreignKey = $alter->addForeignKey(
$definition->getName(),
$definition->getColumns(),
$definition->getTargetTable(),
$definition->getTargetColumns()
);
$foreignKey->setOnUpdateAction($definition->getOnUpdateAction());
$foreignKey->setOnDeleteAction($definition->getOnDeleteAction());
}
protected function getTableAlter($tableName)
{
if ($this->_tableAlter['table'] !== $tableName) {
$this->_tableAlter['table'] = $tableName;
$this->_tableAlter['statement'] = $this->sqlDocument->alterTable($tableName);
}
return $this->_tableAlter['statement'];
}
protected function getHeader()
{
if ($this->header !== NULL) {
return $this->header;
}
if ($this->databaseType === Database::MYSQL) {
return array(
'SET foreign_key_checks = 1;',
'SET time_zone = "SYSTEM";',
'SET sql_mode = "TRADITIONAL";',
);
}
return array();
}
protected function getHeaderBlock()
{
$header = implode("\n", $this->getHeader());
return $header !== '' ? ($header . "\n\n") : '';
}
protected function prepareDriver($driver)
{
if ($driver === Database::MYSQL) {
return new SqlGenerator\Drivers\MysqlDriver;
}
throw new \Inlm\SchemaGenerator\InvalidArgumentException('Driver is not supported.');
}
}