vendor/doctrine/dbal/lib/Doctrine/DBAL/Schema/SQLServerSchemaManager.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.phpdoctrine.org>.
  18  */
  19
  20 namespace Doctrine\DBAL\Schema;
  21
  22 use Doctrine\DBAL\Events;
  23 use Doctrine\DBAL\Event\SchemaIndexDefinitionEventArgs;
  24 use Doctrine\DBAL\Driver\SQLSrv\SQLSrvException;
  25
  26 /**
  27  * SQL Server Schema Manager
  28  *
  29  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  30  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  31  * @author      Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
  32  * @author      Juozas Kaziukenas <juozas@juokaz.com>
  33  * @since       2.0
  34  */
  35 class SQLServerSchemaManager extends AbstractSchemaManager
  36 {
  37     /**
  38      * @override
  39      */
  40     protected function _getPortableTableColumnDefinition($tableColumn)
  41     {
  42         $dbType = strtolower($tableColumn['TYPE_NAME']);
  43
  44         $autoincrement = false;
  45         if (stripos($dbType, 'identity')) {
  46             $dbType = trim(str_ireplace('identity', '', $dbType));
  47             $autoincrement = true;
  48         }
  49
  50         $type = array();
  51         $unsigned = $fixed = null;
  52
  53         if (!isset($tableColumn['name'])) {
  54             $tableColumn['name'] = '';
  55         }
  56
  57         $default = $tableColumn['COLUMN_DEF'];
  58
  59         while ($default != ($default2 = preg_replace("/^\((.*)\)$/", '$1', $default))) {
  60             $default = trim($default2, "'");
  61         }
  62
  63         $length = (int) $tableColumn['LENGTH'];
  64
  65         $type = $this->_platform->getDoctrineTypeMapping($dbType);
  66         switch ($type) {
  67             case 'char':
  68                 if ($tableColumn['LENGTH'] == '1') {
  69                     $type = 'boolean';
  70                     if (preg_match('/^(is|has)/', $tableColumn['name'])) {
  71                         $type = array_reverse($type);
  72                     }
  73                 }
  74                 $fixed = true;
  75                 break;
  76             case 'text':
  77                 $fixed = false;
  78                 break;
  79         }
  80         switch ($dbType) {
  81             case 'nchar':
  82             case 'nvarchar':
  83             case 'ntext':
  84                 // Unicode data requires 2 bytes per character
  85                 $length = $length / 2;
  86                 break;
  87         }
  88
  89         $options = array(
  90             'length' => ($length == 0 || !in_array($type, array('text', 'string'))) ? null : $length,
  91             'unsigned' => (bool) $unsigned,
  92             'fixed' => (bool) $fixed,
  93             'default' => $default !== 'NULL' ? $default : null,
  94             'notnull' => (bool) ($tableColumn['IS_NULLABLE'] != 'YES'),
  95             'scale' => $tableColumn['SCALE'],
  96             'precision' => $tableColumn['PRECISION'],
  97             'autoincrement' => $autoincrement,
  98         );
  99
 100         return new Column($tableColumn['COLUMN_NAME'], \Doctrine\DBAL\Types\Type::getType($type), $options);
 101     }
 102
 103     /**
 104      * @override
 105      */
 106     protected function _getPortableTableIndexesList($tableIndexRows, $tableName=null)
 107     {
 108         // TODO: Remove code duplication with AbstractSchemaManager;
 109         $result = array();
 110         foreach ($tableIndexRows as $tableIndex) {
 111             $indexName = $keyName = $tableIndex['index_name'];
 112             if (strpos($tableIndex['index_description'], 'primary key') !== false) {
 113                 $keyName = 'primary';
 114             }
 115             $keyName = strtolower($keyName);
 116
 117             $flags = array();
 118             if (strpos($tableIndex['index_description'], 'clustered') !== false) {
 119                 $flags[] = 'clustered';
 120             } else if (strpos($tableIndex['index_description'], 'nonclustered') !== false) {
 121                 $flags[] = 'nonclustered';
 122             }
 123
 124             $result[$keyName] = array(
 125                 'name' => $indexName,
 126                 'columns' => explode(', ', $tableIndex['index_keys']),
 127                 'unique' => strpos($tableIndex['index_description'], 'unique') !== false,
 128                 'primary' => strpos($tableIndex['index_description'], 'primary key') !== false,
 129                 'flags' => $flags,
 130             );
 131         }
 132
 133         $eventManager = $this->_platform->getEventManager();
 134
 135         $indexes = array();
 136         foreach ($result as $indexKey => $data) {
 137             $index = null;
 138             $defaultPrevented = false;
 139
 140             if (null !== $eventManager && $eventManager->hasListeners(Events::onSchemaIndexDefinition)) {
 141                 $eventArgs = new SchemaIndexDefinitionEventArgs($data, $tableName, $this->_conn);
 142                 $eventManager->dispatchEvent(Events::onSchemaIndexDefinition, $eventArgs);
 143
 144                 $defaultPrevented = $eventArgs->isDefaultPrevented();
 145                 $index = $eventArgs->getIndex();
 146             }
 147
 148             if ( ! $defaultPrevented) {
 149                 $index = new Index($data['name'], $data['columns'], $data['unique'], $data['primary']);
 150             }
 151
 152             if ($index) {
 153                 $indexes[$indexKey] = $index;
 154             }
 155         }
 156
 157         return $indexes;
 158     }
 159
 160     /**
 161      * @override
 162      */
 163     public function _getPortableTableForeignKeyDefinition($tableForeignKey)
 164     {
 165         return new ForeignKeyConstraint(
 166                 (array) $tableForeignKey['ColumnName'],
 167                 $tableForeignKey['ReferenceTableName'],
 168                 (array) $tableForeignKey['ReferenceColumnName'],
 169                 $tableForeignKey['ForeignKey'],
 170                 array(
 171                     'onUpdate' => str_replace('_', ' ', $tableForeignKey['update_referential_action_desc']),
 172                     'onDelete' => str_replace('_', ' ', $tableForeignKey['delete_referential_action_desc']),
 173                 )
 174         );
 175     }
 176
 177     /**
 178      * @override
 179      */
 180     protected function _getPortableTableDefinition($table)
 181     {
 182         return $table['name'];
 183     }
 184
 185     /**
 186      * @override
 187      */
 188     protected function _getPortableDatabaseDefinition($database)
 189     {
 190         return $database['name'];
 191     }
 192
 193     /**
 194      * @override
 195      */
 196     protected function _getPortableViewDefinition($view)
 197     {
 198         // @todo
 199         return new View($view['name'], null);
 200     }
 201
 202     /**
 203      * List the indexes for a given table returning an array of Index instances.
 204      *
 205      * Keys of the portable indexes list are all lower-cased.
 206      *
 207      * @param string $table The name of the table
 208      * @return Index[] $tableIndexes
 209      */
 210     public function listTableIndexes($table)
 211     {
 212         $sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());
 213
 214         try {
 215             $tableIndexes = $this->_conn->fetchAll($sql);
 216         } catch(\PDOException $e) {
 217             if ($e->getCode() == "IMSSP") {
 218                 return array();
 219             } else {
 220                 throw $e;
 221             }
 222         } catch(SQLSrvException $e) {
 223             if (strpos($e->getMessage(), 'SQLSTATE [01000, 15472]') === 0) {
 224                 return array();
 225             } else {
 226                 throw $e;
 227             }
 228         }
 229
 230         return $this->_getPortableTableIndexesList($tableIndexes, $table);
 231     }
 232
 233     /**
 234      * @override
 235      */
 236     public function alterTable(TableDiff $tableDiff)
 237     {
 238         if(count($tableDiff->removedColumns) > 0) {
 239             foreach($tableDiff->removedColumns as $col){
 240                 $columnConstraintSql = $this->getColumnConstraintSQL($tableDiff->name, $col->getName());
 241                 foreach ($this->_conn->fetchAll($columnConstraintSql) as $constraint) {
 242                     $this->_conn->exec("ALTER TABLE $tableDiff->name DROP CONSTRAINT " . $constraint['Name']);
 243                 }
 244             }
 245         }
 246
 247         return parent::alterTable($tableDiff);
 248     }
 249
 250     /**
 251      * This function retrieves the constraints for a given column.
 252      */
 253     private function getColumnConstraintSQL($table, $column)
 254     {
 255         return "SELECT SysObjects.[Name]
 256             FROM SysObjects INNER JOIN (SELECT [Name],[ID] FROM SysObjects WHERE XType = 'U') AS Tab
 257             ON Tab.[ID] = Sysobjects.[Parent_Obj]
 258             INNER JOIN sys.default_constraints DefCons ON DefCons.[object_id] = Sysobjects.[ID]
 259             INNER JOIN SysColumns Col ON Col.[ColID] = DefCons.[parent_column_id] AND Col.[ID] = Tab.[ID]
 260             WHERE Col.[Name] = " . $this->_conn->quote($column) ." AND Tab.[Name] = " . $this->_conn->quote($table) . "
 261             ORDER BY Col.[Name]";
 262     }
 263 }