| <?php |
| /** |
| * File containing the ezcDbSchemaMysqlWriter class. |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @package DatabaseSchema |
| * @version //autogentag// |
| * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| */ |
| |
| /** |
| * Handler for storing database schemas and applying differences that uses MySQL as backend. |
| * |
| * @package DatabaseSchema |
| * @version //autogentag// |
| */ |
| class ezcDbSchemaMysqlWriter extends ezcDbSchemaCommonSqlWriter implements ezcDbSchemaDbWriter, ezcDbSchemaDiffDbWriter |
| { |
| /** |
| * Contains a type map from DbSchema types to MySQL native types. |
| * |
| * @var array |
| */ |
| private $typeMap = array( |
| 'integer' => 'bigint', |
| 'boolean' => 'boolean', |
| 'float' => 'double', |
| 'decimal' => 'numeric', |
| 'date' => 'date', |
| 'timestamp' => 'timestamp', |
| 'text' => 'varchar', |
| 'blob' => 'longblob', |
| 'clob' => 'longtext' |
| ); |
| |
| /** |
| * Returns what type of schema writer this class implements. |
| * |
| * This method always returns ezcDbSchema::DATABASE |
| * |
| * @return int |
| */ |
| public function getWriterType() |
| { |
| return ezcDbSchema::DATABASE; |
| } |
| |
| /** |
| * Returns what type of schema difference writer this class implements. |
| * |
| * This method always returns ezcDbSchema::DATABASE |
| * |
| * @return int |
| */ |
| public function getDiffWriterType() |
| { |
| return ezcDbSchema::DATABASE; |
| } |
| |
| /** |
| * Applies the differences defined in $dbSchemaDiff to the database referenced by $db. |
| * |
| * This method uses {@link convertDiffToDDL} to create SQL for the |
| * differences and then executes the returned SQL statements on the |
| * database handler $db. |
| * |
| * @todo check for failed transaction |
| * |
| * @param ezcDbHandler $db |
| * @param ezcDbSchemaDiff $dbSchemaDiff |
| */ |
| public function applyDiffToDb( ezcDbHandler $db, ezcDbSchemaDiff $dbSchemaDiff ) |
| { |
| $db->beginTransaction(); |
| foreach ( $this->convertDiffToDDL( $dbSchemaDiff ) as $query ) |
| { |
| $db->exec( $query ); |
| } |
| $db->commit(); |
| } |
| |
| /** |
| * Returns the differences definition in $dbSchema as database specific SQL DDL queries. |
| * |
| * @param ezcDbSchemaDiff $dbSchemaDiff |
| * |
| * @return array(string) |
| */ |
| public function convertDiffToDDL( ezcDbSchemaDiff $dbSchemaDiff ) |
| { |
| $this->diffSchema = $dbSchemaDiff; |
| |
| // reset queries |
| $this->queries = array(); |
| $this->context = array(); |
| |
| $this->generateDiffSchemaAsSql(); |
| return $this->queries; |
| } |
| |
| /** |
| * Adds a "drop table" query for the table $tableName to the internal list of queries. |
| * |
| * @param string $tableName |
| */ |
| protected function generateDropTableSql( $tableName ) |
| { |
| $this->queries[] = "DROP TABLE IF EXISTS `$tableName`"; |
| } |
| |
| /** |
| * Converts the generic field type contained in $fieldDefinition to a database specific field definition. |
| * |
| * @param ezcDbSchemaField $fieldDefinition |
| * @return string |
| */ |
| protected function convertFromGenericType( ezcDbSchemaField $fieldDefinition ) |
| { |
| $typeAddition = ''; |
| if ( in_array( $fieldDefinition->type, array( 'decimal', 'text' ) ) ) |
| { |
| if ( $fieldDefinition->length !== false && $fieldDefinition->length !== 0 ) |
| { |
| $typeAddition = "({$fieldDefinition->length})"; |
| } |
| } |
| if ( $fieldDefinition->type == 'text' && !$fieldDefinition->length ) |
| { |
| $typeAddition = "(255)"; |
| } |
| |
| if ( !isset( $this->typeMap[$fieldDefinition->type] ) ) |
| { |
| throw new ezcDbSchemaUnsupportedTypeException( 'MySQL', $fieldDefinition->type ); |
| } |
| $type = $this->typeMap[$fieldDefinition->type]; |
| |
| return "$type$typeAddition"; |
| } |
| |
| /** |
| * Returns a "CREATE TABLE" SQL statement part for the table $tableName. |
| * |
| * @param string $tableName |
| * @return string |
| */ |
| protected function generateCreateTableSqlStatement( $tableName ) |
| { |
| return "CREATE TABLE `{$tableName}`"; |
| } |
| |
| /** |
| * Adds a "create table" query for the table $tableName with definition $tableDefinition to the internal list of queries. |
| * |
| * @param string $tableName |
| * @param ezcDbSchemaTable $tableDefinition |
| */ |
| protected function generateCreateTableSql( $tableName, ezcDbSchemaTable $tableDefinition ) |
| { |
| $this->context['skip_primary'] = false; |
| parent::generateCreateTableSql( $tableName, $tableDefinition ); |
| } |
| |
| /** |
| * Generates queries to upgrade a the table $tableName with the differences in $tableDiff. |
| * |
| * This method generates queries to migrate a table to a new version |
| * with the changes that are stored in the $tableDiff property. It |
| * will call different subfunctions for the different types of changes, and |
| * those functions will add queries to the internal list of queries that is |
| * stored in $this->queries. |
| * |
| * @param string $tableName |
| * @param ezcDbSchemaTableDiff $tableDiff |
| */ |
| protected function generateDiffSchemaTableAsSql( $tableName, ezcDbSchemaTableDiff $tableDiff ) |
| { |
| $this->context['skip_primary'] = false; |
| parent::generateDiffSchemaTableAsSql( $tableName, $tableDiff ); |
| } |
| |
| /** |
| * Adds a "alter table" query to add the field $fieldName to $tableName with the definition $fieldDefinition. |
| * |
| * @param string $tableName |
| * @param string $fieldName |
| * @param ezcDbSchemaField $fieldDefinition |
| */ |
| protected function generateAddFieldSql( $tableName, $fieldName, ezcDbSchemaField $fieldDefinition ) |
| { |
| $this->queries[] = "ALTER TABLE `$tableName` ADD " . $this->generateFieldSql( $fieldName, $fieldDefinition ); |
| } |
| |
| /** |
| * Adds a "alter table" query to change the field $fieldName to $tableName with the definition $fieldDefinition. |
| * |
| * @param string $tableName |
| * @param string $fieldName |
| * @param ezcDbSchemaField $fieldDefinition |
| */ |
| protected function generateChangeFieldSql( $tableName, $fieldName, ezcDbSchemaField $fieldDefinition ) |
| { |
| $this->queries[] = "ALTER TABLE `$tableName` CHANGE `$fieldName` " . $this->generateFieldSql( $fieldName, $fieldDefinition ); |
| } |
| |
| /** |
| * Adds a "alter table" query to drop the field $fieldName from $tableName. |
| * |
| * @param string $tableName |
| * @param string $fieldName |
| */ |
| protected function generateDropFieldSql( $tableName, $fieldName ) |
| { |
| $this->queries[] = "ALTER TABLE `$tableName` DROP `$fieldName`"; |
| } |
| |
| /** |
| * Returns a column definition for $fieldName with definition $fieldDefinition. |
| * |
| * @param string $fieldName |
| * @param ezcDbSchemaField $fieldDefinition |
| * @return string |
| */ |
| protected function generateFieldSql( $fieldName, ezcDbSchemaField $fieldDefinition ) |
| { |
| $sqlDefinition = "`$fieldName` "; |
| |
| $defList = array(); |
| |
| $type = $this->convertFromGenericType( $fieldDefinition ); |
| $defList[] = $type; |
| |
| if ( $fieldDefinition->notNull ) |
| { |
| $defList[] = 'NOT NULL'; |
| } |
| |
| if ( $fieldDefinition->autoIncrement ) |
| { |
| $defList[] = "AUTO_INCREMENT PRIMARY KEY"; |
| $this->context['skip_primary'] = true; |
| } |
| |
| if ( !is_null( $fieldDefinition->default ) && !$fieldDefinition->autoIncrement ) |
| { |
| $default = $this->generateDefault( $fieldDefinition->type, $fieldDefinition->default ); |
| $defList[] = "DEFAULT $default"; |
| } |
| |
| $sqlDefinition .= join( ' ', $defList ); |
| |
| return $sqlDefinition; |
| } |
| |
| /** |
| * Adds a "alter table" query to add the index $indexName to the table $tableName with definition $indexDefinition to the internal list of queries |
| * |
| * @param string $tableName |
| * @param string $indexName |
| * @param ezcDbSchemaIndex $indexDefinition |
| */ |
| protected function generateAddIndexSql( $tableName, $indexName, ezcDbSchemaIndex $indexDefinition ) |
| { |
| $sql = "ALTER TABLE `$tableName` ADD "; |
| |
| if ( $indexDefinition->primary ) |
| { |
| if ( $this->context['skip_primary'] ) |
| { |
| return; |
| } |
| $sql .= 'PRIMARY KEY'; |
| } |
| else if ( $indexDefinition->unique ) |
| { |
| $sql .= "UNIQUE `$indexName`"; |
| } |
| else |
| { |
| $sql .= "INDEX `$indexName`"; |
| } |
| |
| $sql .= " ( "; |
| |
| $indexFieldSql = array(); |
| foreach ( $indexDefinition->indexFields as $indexFieldName => $dummy ) |
| { |
| if ( isset( $this->schema[$tableName] ) && |
| isset( $this->schema[$tableName]->fields[$indexFieldName] ) && |
| isset( $this->schema[$tableName]->fields[$indexFieldName]->type ) && |
| in_array( $this->schema[$tableName]->fields[$indexFieldName]->type, array( 'blob', 'clob' ) ) ) |
| { |
| $indexFieldSql[] = "`{$indexFieldName}`(250)"; |
| } |
| else |
| { |
| $indexFieldSql[] = "`$indexFieldName`"; |
| } |
| } |
| $sql .= join( ', ', $indexFieldSql ) . " )"; |
| |
| $this->queries[] = $sql; |
| } |
| |
| /** |
| * Adds a "alter table" query to remote the index $indexName from the table $tableName to the internal list of queries. |
| * |
| * @param string $tableName |
| * @param string $indexName |
| */ |
| protected function generateDropIndexSql( $tableName, $indexName ) |
| { |
| $this->queries[] = "ALTER TABLE `$tableName` DROP INDEX `$indexName`"; |
| } |
| } |
| ?> |