4 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
16 * This software consists of voluntary contributions made by many individuals
17 * and is licensed under the MIT license. For more information, see
18 * <http://www.doctrine-project.org>.
21 namespace Doctrine\DBAL\Platforms;
23 use Doctrine\DBAL\Schema\TableDiff;
24 use Doctrine\DBAL\DBALException;
25 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
26 use Doctrine\DBAL\Schema\Index;
27 use Doctrine\DBAL\Schema\Table;
30 * The SQLServerPlatform provides the behavior, features and SQL dialect of the
31 * Microsoft SQL Server database platform.
34 * @author Roman Borschel <roman@code-factory.org>
35 * @author Jonathan H. Wage <jonwage@gmail.com>
36 * @author Benjamin Eberlei <kontakt@beberlei.de>
38 class SQLServerPlatform extends AbstractPlatform
43 public function getDateDiffExpression($date1, $date2)
45 return 'DATEDIFF(day, ' . $date2 . ',' . $date1 . ')';
51 public function getDateAddDaysExpression($date, $days)
53 return 'DATEADD(day, ' . $days . ', ' . $date . ')';
59 public function getDateSubDaysExpression($date, $days)
61 return 'DATEADD(day, -1 * ' . $days . ', ' . $date . ')';
67 public function getDateAddMonthExpression($date, $months)
69 return 'DATEADD(month, ' . $months . ', ' . $date . ')';
75 public function getDateSubMonthExpression($date, $months)
77 return 'DATEADD(month, -1 * ' . $months . ', ' . $date . ')';
83 * MsSql prefers "autoincrement" identity columns since sequences can only
84 * be emulated with a table.
86 public function prefersIdentityColumns()
94 * MsSql supports this through AUTO_INCREMENT columns.
96 public function supportsIdentityColumns()
104 public function supportsReleaseSavepoints()
112 public function getCreateDatabaseSQL($name)
114 return 'CREATE DATABASE ' . $name;
120 public function getDropDatabaseSQL($name)
122 return 'DROP DATABASE ' . $name;
128 public function supportsCreateDropDatabase()
136 public function getDropForeignKeySQL($foreignKey, $table)
138 if ($foreignKey instanceof ForeignKeyConstraint) {
139 $foreignKey = $foreignKey->getQuotedName($this);
142 if ($table instanceof Table) {
143 $table = $table->getQuotedName($this);
146 return 'ALTER TABLE ' . $table . ' DROP CONSTRAINT ' . $foreignKey;
152 public function getDropIndexSQL($index, $table = null)
154 if ($index instanceof Index) {
155 $index = $index->getQuotedName($this);
156 } else if (!is_string($index)) {
157 throw new \InvalidArgumentException('AbstractPlatform::getDropIndexSQL() expects $index parameter to be string or \Doctrine\DBAL\Schema\Index.');
160 if (!isset($table)) {
161 return 'DROP INDEX ' . $index;
164 if ($table instanceof Table) {
165 $table = $table->getQuotedName($this);
168 return "IF EXISTS (SELECT * FROM sysobjects WHERE name = '$index')
169 ALTER TABLE " . $table . " DROP CONSTRAINT " . $index . "
171 DROP INDEX " . $index . " ON " . $table;
177 protected function _getCreateTableSQL($tableName, array $columns, array $options = array())
179 // @todo does other code breaks because of this?
180 // force primary keys to be not null
181 foreach ($columns as &$column) {
182 if (isset($column['primary']) && $column['primary']) {
183 $column['notnull'] = true;
187 $columnListSql = $this->getColumnDeclarationListSQL($columns);
189 if (isset($options['uniqueConstraints']) && !empty($options['uniqueConstraints'])) {
190 foreach ($options['uniqueConstraints'] as $name => $definition) {
191 $columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($name, $definition);
195 if (isset($options['primary']) && !empty($options['primary'])) {
197 if (isset($options['primary_index']) && $options['primary_index']->hasFlag('nonclustered')) {
198 $flags = ' NONCLUSTERED';
200 $columnListSql .= ', PRIMARY KEY' . $flags . ' (' . implode(', ', array_unique(array_values($options['primary']))) . ')';
203 $query = 'CREATE TABLE ' . $tableName . ' (' . $columnListSql;
205 $check = $this->getCheckDeclarationSQL($columns);
206 if (!empty($check)) {
207 $query .= ', ' . $check;
213 if (isset($options['indexes']) && !empty($options['indexes'])) {
214 foreach ($options['indexes'] as $index) {
215 $sql[] = $this->getCreateIndexSQL($index, $tableName);
219 if (isset($options['foreignKeys'])) {
220 foreach ((array) $options['foreignKeys'] as $definition) {
221 $sql[] = $this->getCreateForeignKeySQL($definition, $tableName);
231 public function getCreatePrimaryKeySQL(Index $index, $table)
234 if ($index->hasFlag('nonclustered')) {
235 $flags = ' NONCLUSTERED';
237 return 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY' . $flags . ' (' . $this->getIndexFieldDeclarationListSQL($index->getColumns()) . ')';
243 public function getUniqueConstraintDeclarationSQL($name, Index $index)
245 $constraint = parent::getUniqueConstraintDeclarationSQL($name, $index);
247 $constraint = $this->_appendUniqueConstraintDefinition($constraint, $index);
255 public function getCreateIndexSQL(Index $index, $table)
257 $constraint = parent::getCreateIndexSQL($index, $table);
259 if ($index->isUnique()) {
260 $constraint = $this->_appendUniqueConstraintDefinition($constraint, $index);
269 protected function getCreateIndexSQLFlags(Index $index)
272 if ($index->isUnique()) {
276 if ($index->hasFlag('clustered')) {
277 $type .= 'CLUSTERED ';
278 } else if ($index->hasFlag('nonclustered')) {
279 $type .= 'NONCLUSTERED ';
286 * Extend unique key constraint with required filters
289 * @param Index $index
293 private function _appendUniqueConstraintDefinition($sql, Index $index)
296 foreach ($index->getColumns() as $field => $definition) {
297 if (!is_array($definition)) {
298 $field = $definition;
301 $fields[] = $field . ' IS NOT NULL';
304 return $sql . ' WHERE ' . implode(' AND ', $fields);
310 public function getAlterTableSQL(TableDiff $diff)
312 $queryParts = array();
314 $columnSql = array();
316 foreach ($diff->addedColumns as $column) {
317 if ($this->onSchemaAlterTableAddColumn($column, $diff, $columnSql)) {
321 $queryParts[] = 'ADD ' . $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
324 foreach ($diff->removedColumns as $column) {
325 if ($this->onSchemaAlterTableRemoveColumn($column, $diff, $columnSql)) {
329 $queryParts[] = 'DROP COLUMN ' . $column->getQuotedName($this);
332 foreach ($diff->changedColumns as $columnDiff) {
333 if ($this->onSchemaAlterTableChangeColumn($columnDiff, $diff, $columnSql)) {
337 /* @var $columnDiff \Doctrine\DBAL\Schema\ColumnDiff */
338 $column = $columnDiff->column;
339 $queryParts[] = 'ALTER COLUMN ' .
340 $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
343 foreach ($diff->renamedColumns as $oldColumnName => $column) {
344 if ($this->onSchemaAlterTableRenameColumn($oldColumnName, $column, $diff, $columnSql)) {
348 $sql[] = "sp_RENAME '". $diff->name. ".". $oldColumnName . "' , '".$column->getQuotedName($this)."', 'COLUMN'";
349 $queryParts[] = 'ALTER COLUMN ' .
350 $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
355 if ($this->onSchemaAlterTable($diff, $tableSql)) {
356 return array_merge($tableSql, $columnSql);
359 foreach ($queryParts as $query) {
360 $sql[] = 'ALTER TABLE ' . $diff->name . ' ' . $query;
363 $sql = array_merge($sql, $this->_getAlterTableIndexForeignKeySQL($diff));
365 if ($diff->newName !== false) {
366 $sql[] = "sp_RENAME '" . $diff->name . "', '" . $diff->newName . "'";
369 return array_merge($sql, $tableSql, $columnSql);
375 public function getEmptyIdentityInsertSQL($quotedTableName, $quotedIdentifierColumnName)
377 return 'INSERT INTO ' . $quotedTableName . ' DEFAULT VALUES';
383 public function getShowDatabasesSQL()
385 return 'SHOW DATABASES';
391 public function getListTablesSQL()
393 // "sysdiagrams" table must be ignored as it's internal SQL Server table for Database Diagrams
394 return "SELECT name FROM sysobjects WHERE type = 'U' AND name != 'sysdiagrams' ORDER BY name";
400 public function getListTableColumnsSQL($table, $database = null)
402 return "exec sp_columns @table_name = '" . $table . "'";
408 public function getListTableForeignKeysSQL($table, $database = null)
410 return "SELECT f.name AS ForeignKey,
411 SCHEMA_NAME (f.SCHEMA_ID) AS SchemaName,
412 OBJECT_NAME (f.parent_object_id) AS TableName,
413 COL_NAME (fc.parent_object_id,fc.parent_column_id) AS ColumnName,
414 SCHEMA_NAME (o.SCHEMA_ID) ReferenceSchemaName,
415 OBJECT_NAME (f.referenced_object_id) AS ReferenceTableName,
416 COL_NAME(fc.referenced_object_id,fc.referenced_column_id) AS ReferenceColumnName,
417 f.delete_referential_action_desc,
418 f.update_referential_action_desc
419 FROM sys.foreign_keys AS f
420 INNER JOIN sys.foreign_key_columns AS fc
421 INNER JOIN sys.objects AS o ON o.OBJECT_ID = fc.referenced_object_id
422 ON f.OBJECT_ID = fc.constraint_object_id
423 WHERE OBJECT_NAME (f.parent_object_id) = '" . $table . "'";
429 public function getListTableIndexesSQL($table, $currentDatabase = null)
431 return "exec sp_helpindex '" . $table . "'";
437 public function getCreateViewSQL($name, $sql)
439 return 'CREATE VIEW ' . $name . ' AS ' . $sql;
445 public function getListViewsSQL($database)
447 return "SELECT name FROM sysobjects WHERE type = 'V' ORDER BY name";
453 public function getDropViewSQL($name)
455 return 'DROP VIEW ' . $name;
461 public function getRegexpExpression()
469 public function getGuidExpression()
477 public function getLocateExpression($str, $substr, $startPos = false)
479 if ($startPos == false) {
480 return 'CHARINDEX(' . $substr . ', ' . $str . ')';
483 return 'CHARINDEX(' . $substr . ', ' . $str . ', ' . $startPos . ')';
489 public function getModExpression($expression1, $expression2)
491 return $expression1 . ' % ' . $expression2;
497 public function getTrimExpression($str, $pos = self::TRIM_UNSPECIFIED, $char = false)
501 case self::TRIM_LEADING:
505 case self::TRIM_TRAILING:
510 return 'LTRIM(RTRIM(' . $str . '))';
513 return $trimFn . '(' . $str . ')';
516 /** Original query used to get those expressions
517 declare @c varchar(100) = 'xxxBarxxx', @trim_char char(1) = 'x';
518 declare @pat varchar(10) = '%[^' + @trim_char + ']%';
520 , @trim_char as trim_char
521 , stuff(@c, 1, patindex(@pat, @c) - 1, null) as trim_leading
522 , reverse(stuff(reverse(@c), 1, patindex(@pat, reverse(@c)) - 1, null)) as trim_trailing
523 , reverse(stuff(reverse(stuff(@c, 1, patindex(@pat, @c) - 1, null)), 1, patindex(@pat, reverse(stuff(@c, 1, patindex(@pat, @c) - 1, null))) - 1, null)) as trim_both;
525 $pattern = "'%[^' + $char + ']%'";
527 if ($pos == self::TRIM_LEADING) {
528 return 'stuff(' . $str . ', 1, patindex(' . $pattern . ', ' . $str . ') - 1, null)';
531 if ($pos == self::TRIM_TRAILING) {
532 return 'reverse(stuff(reverse(' . $str . '), 1, patindex(' . $pattern . ', reverse(' . $str . ')) - 1, null))';
535 return 'reverse(stuff(reverse(stuff(' . $str . ', 1, patindex(' . $pattern . ', ' . $str . ') - 1, null)), 1, patindex(' . $pattern . ', reverse(stuff(' . $str . ', 1, patindex(' . $pattern . ', ' . $str . ') - 1, null))) - 1, null))';
541 public function getConcatExpression()
543 $args = func_get_args();
545 return '(' . implode(' + ', $args) . ')';
548 public function getListDatabasesSQL()
550 return 'SELECT * FROM SYS.DATABASES';
556 public function getSubstringExpression($value, $from, $length = null)
558 if (!is_null($length)) {
559 return 'SUBSTRING(' . $value . ', ' . $from . ', ' . $length . ')';
562 return 'SUBSTRING(' . $value . ', ' . $from . ', LEN(' . $value . ') - ' . $from . ' + 1)';
568 public function getLengthExpression($column)
570 return 'LEN(' . $column . ')';
576 public function getSetTransactionIsolationSQL($level)
578 return 'SET TRANSACTION ISOLATION LEVEL ' . $this->_getTransactionIsolationLevelSQL($level);
584 public function getIntegerTypeDeclarationSQL(array $field)
586 return 'INT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
592 public function getBigIntTypeDeclarationSQL(array $field)
594 return 'BIGINT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
600 public function getSmallIntTypeDeclarationSQL(array $field)
602 return 'SMALLINT' . $this->_getCommonIntegerTypeDeclarationSQL($field);
608 public function getGuidTypeDeclarationSQL(array $field)
610 return 'UNIQUEIDENTIFIER';
616 protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
618 return $fixed ? ($length ? 'NCHAR(' . $length . ')' : 'CHAR(255)') : ($length ? 'NVARCHAR(' . $length . ')' : 'NVARCHAR(255)');
624 public function getClobTypeDeclarationSQL(array $field)
632 protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
635 if (!empty($columnDef['autoincrement'])) {
636 $autoinc = ' IDENTITY';
638 $unsigned = (isset($columnDef['unsigned']) && $columnDef['unsigned']) ? ' UNSIGNED' : '';
640 return $unsigned . $autoinc;
646 public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration)
654 public function getDateTypeDeclarationSQL(array $fieldDeclaration)
662 public function getTimeTypeDeclarationSQL(array $fieldDeclaration)
670 public function getBooleanTypeDeclarationSQL(array $field)
678 * @link http://lists.bestpractical.com/pipermail/rt-devel/2005-June/007339.html
680 protected function doModifyLimitQuery($query, $limit, $offset = null)
684 $query = preg_replace('/^(SELECT\s(DISTINCT\s)?)/i', '\1TOP ' . $limit . ' ', $query);
686 $orderby = stristr($query, 'ORDER BY');
689 $over = 'ORDER BY (SELECT 0)';
691 $over = preg_replace('/\"[^,]*\".\"([^,]*)\"/i', '"inner_tbl"."$1"', $orderby);
694 // Remove ORDER BY clause from $query
695 $query = preg_replace('/\s+ORDER BY(.*)/', '', $query);
696 $query = preg_replace('/^SELECT\s/', '', $query);
698 $start = $offset + 1;
699 $end = $offset + $limit;
701 $query = "SELECT * FROM (SELECT ROW_NUMBER() OVER ($over) AS doctrine_rownum, $query) AS doctrine_tbl WHERE doctrine_rownum BETWEEN $start AND $end";
711 public function supportsLimitOffset()
719 public function convertBooleans($item)
721 if (is_array($item)) {
722 foreach ($item as $key => $value) {
723 if (is_bool($value) || is_numeric($item)) {
724 $item[$key] = ($value) ? 1 : 0;
727 } else if (is_bool($item) || is_numeric($item)) {
728 $item = ($item) ? 1 : 0;
737 public function getCreateTemporaryTableSnippetSQL()
739 return "CREATE TABLE";
745 public function getTemporaryTableName($tableName)
747 return '#' . $tableName;
753 public function getDateTimeFormatString()
755 return 'Y-m-d H:i:s.000';
761 public function getDateFormatString()
763 return 'Y-m-d H:i:s.000';
769 public function getTimeFormatString()
771 return 'Y-m-d H:i:s.000';
777 public function getDateTimeTzFormatString()
779 return $this->getDateTimeFormatString();
785 public function getName()
793 protected function initializeDoctrineTypeMappings()
795 $this->doctrineTypeMapping = array(
796 'bigint' => 'bigint',
797 'numeric' => 'decimal',
799 'smallint' => 'smallint',
800 'decimal' => 'decimal',
801 'smallmoney' => 'integer',
803 'tinyint' => 'smallint',
804 'money' => 'integer',
808 'double precision' => 'float',
809 'datetimeoffset' => 'datetimetz',
810 'smalldatetime' => 'datetime',
811 'datetime' => 'datetime',
813 'varchar' => 'string',
816 'nvarchar' => 'string',
819 'varbinary' => 'blob',
821 'uniqueidentifier' => 'guid',
828 public function createSavePoint($savepoint)
830 return 'SAVE TRANSACTION ' . $savepoint;
836 public function releaseSavePoint($savepoint)
844 public function rollbackSavePoint($savepoint)
846 return 'ROLLBACK TRANSACTION ' . $savepoint;
852 public function appendLockHint($fromClause, $lockMode)
855 if ($lockMode == \Doctrine\DBAL\LockMode::PESSIMISTIC_READ) {
856 return $fromClause . ' WITH (tablockx)';
859 if ($lockMode == \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE) {
860 return $fromClause . ' WITH (tablockx)';
869 public function getForUpdateSQL()
877 protected function getReservedKeywordsClass()
879 return 'Doctrine\DBAL\Platforms\Keywords\MsSQLKeywords';
885 public function quoteSingleIdentifier($str)
887 return "[" . str_replace("]", "][", $str) . "]";
893 public function getTruncateTableSQL($tableName, $cascade = false)
895 return 'TRUNCATE TABLE '.$tableName;
901 public function getBlobTypeDeclarationSQL(array $field)
903 return 'VARBINARY(MAX)';