--- /dev/null
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Platforms;
+
+use Doctrine\DBAL\DBALException,
+ Doctrine\DBAL\Schema\TableDiff,
+ Doctrine\DBAL\Schema\Index,
+ Doctrine\DBAL\Schema\Table;
+
+/**
+ * The MySqlPlatform provides the behavior, features and SQL dialect of the
+ * MySQL database platform. This platform represents a MySQL 5.0 or greater platform that
+ * uses the InnoDB storage engine.
+ *
+ * @since 2.0
+ * @author Roman Borschel <roman@code-factory.org>
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @todo Rename: MySQLPlatform
+ */
+class MySqlPlatform extends AbstractPlatform
+{
+ /**
+ * {@inheritDoc}
+ */
+ public function getIdentifierQuoteCharacter()
+ {
+ return '`';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getRegexpExpression()
+ {
+ return 'RLIKE';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getGuidExpression()
+ {
+ return 'UUID()';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getLocateExpression($str, $substr, $startPos = false)
+ {
+ if ($startPos == false) {
+ return 'LOCATE(' . $substr . ', ' . $str . ')';
+ }
+
+ return 'LOCATE(' . $substr . ', ' . $str . ', '.$startPos.')';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getConcatExpression()
+ {
+ $args = func_get_args();
+ return 'CONCAT(' . join(', ', (array) $args) . ')';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateDiffExpression($date1, $date2)
+ {
+ return 'DATEDIFF(' . $date1 . ', ' . $date2 . ')';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateAddDaysExpression($date, $days)
+ {
+ return 'DATE_ADD(' . $date . ', INTERVAL ' . $days . ' DAY)';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateSubDaysExpression($date, $days)
+ {
+ return 'DATE_SUB(' . $date . ', INTERVAL ' . $days . ' DAY)';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateAddMonthExpression($date, $months)
+ {
+ return 'DATE_ADD(' . $date . ', INTERVAL ' . $months . ' MONTH)';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateSubMonthExpression($date, $months)
+ {
+ return 'DATE_SUB(' . $date . ', INTERVAL ' . $months . ' MONTH)';
+ }
+
+ public function getListDatabasesSQL()
+ {
+ return 'SHOW DATABASES';
+ }
+
+ public function getListTableConstraintsSQL($table)
+ {
+ return 'SHOW INDEX FROM ' . $table;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Two approaches to listing the table indexes. The information_schema is
+ * preferred, because it doesn't cause problems with SQL keywords such as "order" or "table".
+ *
+ * @param string $table
+ * @param string $currentDatabase
+ * @return string
+ */
+ public function getListTableIndexesSQL($table, $currentDatabase = null)
+ {
+ if ($currentDatabase) {
+ return "SELECT TABLE_NAME AS `Table`, NON_UNIQUE AS Non_Unique, INDEX_NAME AS Key_name, ".
+ "SEQ_IN_INDEX AS Seq_in_index, COLUMN_NAME AS Column_Name, COLLATION AS Collation, ".
+ "CARDINALITY AS Cardinality, SUB_PART AS Sub_Part, PACKED AS Packed, " .
+ "NULLABLE AS `Null`, INDEX_TYPE AS Index_Type, COMMENT AS Comment " .
+ "FROM information_schema.STATISTICS WHERE TABLE_NAME = '" . $table . "' AND TABLE_SCHEMA = '" . $currentDatabase . "'";
+ }
+
+ return 'SHOW INDEX FROM ' . $table;
+ }
+
+ public function getListViewsSQL($database)
+ {
+ return "SELECT * FROM information_schema.VIEWS WHERE TABLE_SCHEMA = '".$database."'";
+ }
+
+ public function getListTableForeignKeysSQL($table, $database = null)
+ {
+ $sql = "SELECT DISTINCT k.`CONSTRAINT_NAME`, k.`COLUMN_NAME`, k.`REFERENCED_TABLE_NAME`, ".
+ "k.`REFERENCED_COLUMN_NAME` /*!50116 , c.update_rule, c.delete_rule */ ".
+ "FROM information_schema.key_column_usage k /*!50116 ".
+ "INNER JOIN information_schema.referential_constraints c ON ".
+ " c.constraint_name = k.constraint_name AND ".
+ " c.table_name = '$table' */ WHERE k.table_name = '$table'";
+
+ if ($database) {
+ $sql .= " AND k.table_schema = '$database' /*!50116 AND c.constraint_schema = '$database' */";
+ }
+
+ $sql .= " AND k.`REFERENCED_COLUMN_NAME` is not NULL";
+
+ return $sql;
+ }
+
+ public function getCreateViewSQL($name, $sql)
+ {
+ return 'CREATE VIEW ' . $name . ' AS ' . $sql;
+ }
+
+ public function getDropViewSQL($name)
+ {
+ return 'DROP VIEW '. $name;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
+ {
+ return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(255)')
+ : ($length ? 'VARCHAR(' . $length . ')' : 'VARCHAR(255)');
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getClobTypeDeclarationSQL(array $field)
+ {
+ if ( ! empty($field['length']) && is_numeric($field['length'])) {
+ $length = $field['length'];
+ if ($length <= 255) {
+ return 'TINYTEXT';
+ }
+
+ if ($length <= 65532) {
+ return 'TEXT';
+ }
+
+ if ($length <= 16777215) {
+ return 'MEDIUMTEXT';
+ }
+ }
+
+ return 'LONGTEXT';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration)
+ {
+ if (isset($fieldDeclaration['version']) && $fieldDeclaration['version'] == true) {
+ return 'TIMESTAMP';
+ }
+
+ return 'DATETIME';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDateTypeDeclarationSQL(array $fieldDeclaration)
+ {
+ return 'DATE';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getTimeTypeDeclarationSQL(array $fieldDeclaration)
+ {
+ return 'TIME';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getBooleanTypeDeclarationSQL(array $field)
+ {
+ return 'TINYINT(1)';
+ }
+
+ /**
+ * Obtain DBMS specific SQL code portion needed to set the COLLATION
+ * of a field declaration to be used in statements like CREATE TABLE.
+ *
+ * @param string $collation name of the collation
+ *
+ * @return string DBMS specific SQL code portion needed to set the COLLATION
+ * of a field declaration.
+ */
+ public function getCollationFieldDeclaration($collation)
+ {
+ return 'COLLATE ' . $collation;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * MySql prefers "autoincrement" identity columns since sequences can only
+ * be emulated with a table.
+ */
+ public function prefersIdentityColumns()
+ {
+ return true;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * MySql supports this through AUTO_INCREMENT columns.
+ */
+ public function supportsIdentityColumns()
+ {
+ return true;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function supportsInlineColumnComments()
+ {
+ return true;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getShowDatabasesSQL()
+ {
+ return 'SHOW DATABASES';
+ }
+
+ public function getListTablesSQL()
+ {
+ return "SHOW FULL TABLES WHERE Table_type = 'BASE TABLE'";
+ }
+
+ public function getListTableColumnsSQL($table, $database = null)
+ {
+ if ($database) {
+ return "SELECT COLUMN_NAME AS Field, COLUMN_TYPE AS Type, IS_NULLABLE AS `Null`, ".
+ "COLUMN_KEY AS `Key`, COLUMN_DEFAULT AS `Default`, EXTRA AS Extra, COLUMN_COMMENT AS Comment, " .
+ "CHARACTER_SET_NAME AS CharacterSet, COLLATION_NAME AS CollactionName ".
+ "FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = '" . $database . "' AND TABLE_NAME = '" . $table . "'";
+ }
+
+ return 'DESCRIBE ' . $table;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getCreateDatabaseSQL($name)
+ {
+ return 'CREATE DATABASE ' . $name;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDropDatabaseSQL($name)
+ {
+ return 'DROP DATABASE ' . $name;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function _getCreateTableSQL($tableName, array $columns, array $options = array())
+ {
+ $queryFields = $this->getColumnDeclarationListSQL($columns);
+
+ if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) {
+ foreach ($options['uniqueConstraints'] as $index => $definition) {
+ $queryFields .= ', ' . $this->getUniqueConstraintDeclarationSQL($index, $definition);
+ }
+ }
+
+ // add all indexes
+ if (isset($options['indexes']) && ! empty($options['indexes'])) {
+ foreach($options['indexes'] as $index => $definition) {
+ $queryFields .= ', ' . $this->getIndexDeclarationSQL($index, $definition);
+ }
+ }
+
+ // attach all primary keys
+ if (isset($options['primary']) && ! empty($options['primary'])) {
+ $keyColumns = array_unique(array_values($options['primary']));
+ $queryFields .= ', PRIMARY KEY(' . implode(', ', $keyColumns) . ')';
+ }
+
+ $query = 'CREATE ';
+ if (!empty($options['temporary'])) {
+ $query .= 'TEMPORARY ';
+ }
+ $query .= 'TABLE ' . $tableName . ' (' . $queryFields . ') ';
+
+ if (isset($options['comment'])) {
+ $query .= 'COMMENT = ' . $options['comment'] . ' ';
+ }
+
+ if ( ! isset($options['charset'])) {
+ $options['charset'] = 'utf8';
+ }
+
+ if ( ! isset($options['collate'])) {
+ $options['collate'] = 'utf8_unicode_ci';
+ }
+
+ $query .= 'DEFAULT CHARACTER SET ' . $options['charset'];
+ $query .= ' COLLATE ' . $options['collate'];
+
+ if ( ! isset($options['engine'])) {
+ $options['engine'] = 'InnoDB';
+ }
+ $query .= ' ENGINE = ' . $options['engine'];
+
+ $sql[] = $query;
+
+ if (isset($options['foreignKeys'])) {
+ foreach ((array) $options['foreignKeys'] as $definition) {
+ $sql[] = $this->getCreateForeignKeySQL($definition, $tableName);
+ }
+ }
+
+ return $sql;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getAlterTableSQL(TableDiff $diff)
+ {
+ $columnSql = array();
+ $queryParts = array();
+ if ($diff->newName !== false) {
+ $queryParts[] = 'RENAME TO ' . $diff->newName;
+ }
+
+ foreach ($diff->addedColumns as $column) {
+ if ($this->onSchemaAlterTableAddColumn($column, $diff, $columnSql)) {
+ continue;
+ }
+
+ $columnArray = $column->toArray();
+ $columnArray['comment'] = $this->getColumnComment($column);
+ $queryParts[] = 'ADD ' . $this->getColumnDeclarationSQL($column->getQuotedName($this), $columnArray);
+ }
+
+ foreach ($diff->removedColumns as $column) {
+ if ($this->onSchemaAlterTableRemoveColumn($column, $diff, $columnSql)) {
+ continue;
+ }
+
+ $queryParts[] = 'DROP ' . $column->getQuotedName($this);
+ }
+
+ foreach ($diff->changedColumns as $columnDiff) {
+ if ($this->onSchemaAlterTableChangeColumn($columnDiff, $diff, $columnSql)) {
+ continue;
+ }
+
+ /* @var $columnDiff \Doctrine\DBAL\Schema\ColumnDiff */
+ $column = $columnDiff->column;
+ $columnArray = $column->toArray();
+ $columnArray['comment'] = $this->getColumnComment($column);
+ $queryParts[] = 'CHANGE ' . ($columnDiff->oldColumnName) . ' '
+ . $this->getColumnDeclarationSQL($column->getQuotedName($this), $columnArray);
+ }
+
+ foreach ($diff->renamedColumns as $oldColumnName => $column) {
+ if ($this->onSchemaAlterTableRenameColumn($oldColumnName, $column, $diff, $columnSql)) {
+ continue;
+ }
+
+ $columnArray = $column->toArray();
+ $columnArray['comment'] = $this->getColumnComment($column);
+ $queryParts[] = 'CHANGE ' . $oldColumnName . ' '
+ . $this->getColumnDeclarationSQL($column->getQuotedName($this), $columnArray);
+ }
+
+ $sql = array();
+ $tableSql = array();
+
+ if ( ! $this->onSchemaAlterTable($diff, $tableSql)) {
+ if (count($queryParts) > 0) {
+ $sql[] = 'ALTER TABLE ' . $diff->name . ' ' . implode(", ", $queryParts);
+ }
+ $sql = array_merge(
+ $this->getPreAlterTableIndexForeignKeySQL($diff),
+ $sql,
+ $this->getPostAlterTableIndexForeignKeySQL($diff)
+ );
+ }
+
+ return array_merge($sql, $tableSql, $columnSql);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff)
+ {
+ $sql = array();
+ $table = $diff->name;
+
+ foreach ($diff->removedIndexes as $remKey => $remIndex) {
+
+ foreach ($diff->addedIndexes as $addKey => $addIndex) {
+ if ($remIndex->getColumns() == $addIndex->getColumns()) {
+
+ $columns = $addIndex->getColumns();
+ $type = '';
+ if ($addIndex->isUnique()) {
+ $type = 'UNIQUE ';
+ }
+
+ $query = 'ALTER TABLE ' . $table . ' DROP INDEX ' . $remIndex->getName() . ', ';
+ $query .= 'ADD ' . $type . 'INDEX ' . $addIndex->getName();
+ $query .= ' (' . $this->getIndexFieldDeclarationListSQL($columns) . ')';
+
+ $sql[] = $query;
+
+ unset($diff->removedIndexes[$remKey]);
+ unset($diff->addedIndexes[$addKey]);
+
+ break;
+ }
+ }
+ }
+
+ $sql = array_merge($sql, parent::getPreAlterTableIndexForeignKeySQL($diff));
+
+ return $sql;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function getCreateIndexSQLFlags(Index $index)
+ {
+ $type = '';
+ if ($index->isUnique()) {
+ $type .= 'UNIQUE ';
+ } else if ($index->hasFlag('fulltext')) {
+ $type .= 'FULLTEXT ';
+ }
+
+ return $type;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getIntegerTypeDeclarationSQL(array $field)
+ {
+ return 'INT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getBigIntTypeDeclarationSQL(array $field)
+ {
+ return 'BIGINT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getSmallIntTypeDeclarationSQL(array $field)
+ {
+ return 'SMALLINT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
+ {
+ $autoinc = '';
+ if ( ! empty($columnDef['autoincrement'])) {
+ $autoinc = ' AUTO_INCREMENT';
+ }
+ $unsigned = (isset($columnDef['unsigned']) && $columnDef['unsigned']) ? ' UNSIGNED' : '';
+
+ return $unsigned . $autoinc;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getAdvancedForeignKeyOptionsSQL(\Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey)
+ {
+ $query = '';
+ if ($foreignKey->hasOption('match')) {
+ $query .= ' MATCH ' . $foreignKey->getOption('match');
+ }
+ $query .= parent::getAdvancedForeignKeyOptionsSQL($foreignKey);
+ return $query;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDropIndexSQL($index, $table=null)
+ {
+ if ($index instanceof Index) {
+ $indexName = $index->getQuotedName($this);
+ } else if(is_string($index)) {
+ $indexName = $index;
+ } else {
+ throw new \InvalidArgumentException('MysqlPlatform::getDropIndexSQL() expects $index parameter to be string or \Doctrine\DBAL\Schema\Index.');
+ }
+
+ if ($table instanceof Table) {
+ $table = $table->getQuotedName($this);
+ } else if(!is_string($table)) {
+ throw new \InvalidArgumentException('MysqlPlatform::getDropIndexSQL() expects $table parameter to be string or \Doctrine\DBAL\Schema\Table.');
+ }
+
+ if ($index instanceof Index && $index->isPrimary()) {
+ // mysql primary keys are always named "PRIMARY",
+ // so we cannot use them in statements because of them being keyword.
+ return $this->getDropPrimaryKeySQL($table);
+ }
+
+ return 'DROP INDEX ' . $indexName . ' ON ' . $table;
+ }
+
+ /**
+ * @param string $table
+ *
+ * @return string
+ */
+ protected function getDropPrimaryKeySQL($table)
+ {
+ return 'ALTER TABLE ' . $table . ' DROP PRIMARY KEY';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getSetTransactionIsolationSQL($level)
+ {
+ return 'SET SESSION TRANSACTION ISOLATION LEVEL ' . $this->_getTransactionIsolationLevelSQL($level);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getName()
+ {
+ return 'mysql';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getReadLockSQL()
+ {
+ return 'LOCK IN SHARE MODE';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function initializeDoctrineTypeMappings()
+ {
+ $this->doctrineTypeMapping = array(
+ 'tinyint' => 'boolean',
+ 'smallint' => 'smallint',
+ 'mediumint' => 'integer',
+ 'int' => 'integer',
+ 'integer' => 'integer',
+ 'bigint' => 'bigint',
+ 'tinytext' => 'text',
+ 'mediumtext' => 'text',
+ 'longtext' => 'text',
+ 'text' => 'text',
+ 'varchar' => 'string',
+ 'string' => 'string',
+ 'char' => 'string',
+ 'date' => 'date',
+ 'datetime' => 'datetime',
+ 'timestamp' => 'datetime',
+ 'time' => 'time',
+ 'float' => 'float',
+ 'double' => 'float',
+ 'real' => 'float',
+ 'decimal' => 'decimal',
+ 'numeric' => 'decimal',
+ 'year' => 'date',
+ 'longblob' => 'blob',
+ 'blob' => 'blob',
+ 'mediumblob' => 'blob',
+ 'tinyblob' => 'blob',
+ 'binary' => 'blob',
+ 'varbinary' => 'blob',
+ 'set' => 'simple_array',
+ );
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getVarcharMaxLength()
+ {
+ return 65535;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected function getReservedKeywordsClass()
+ {
+ return 'Doctrine\DBAL\Platforms\Keywords\MySQLKeywords';
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * MySQL commits a transaction implicitly when DROP TABLE is executed, however not
+ * if DROP TEMPORARY TABLE is executed.
+ */
+ public function getDropTemporaryTableSQL($table)
+ {
+ if ($table instanceof Table) {
+ $table = $table->getQuotedName($this);
+ } else if(!is_string($table)) {
+ throw new \InvalidArgumentException('getDropTableSQL() expects $table parameter to be string or \Doctrine\DBAL\Schema\Table.');
+ }
+
+ return 'DROP TEMPORARY TABLE ' . $table;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getBlobTypeDeclarationSQL(array $field)
+ {
+ return 'LONGBLOB';
+ }
+}