. */ namespace Doctrine\DBAL\Platforms; use Doctrine\Common\DoctrineException; /** * The MsSqlPlatform provides the behavior, features and SQL dialect of the * MySQL database platform. * * @since 2.0 * @author Roman Borschel * @author Jonathan H. Wage */ class MsSqlPlatform extends AbstractPlatform { /** * the constructor */ public function __construct() { parent::__construct(); } /** * Adds an adapter-specific LIMIT clause to the SELECT statement. * [ borrowed from Zend Framework ] * * @param string $query * @param mixed $limit * @param mixed $offset * @link http://lists.bestpractical.com/pipermail/rt-devel/2005-June/007339.html * @return string * @override */ public function writeLimitClause($query, $limit = false, $offset = false) { if ($limit > 0) { $count = intval($limit); $offset = intval($offset); if ($offset < 0) { throw \Doctrine\Common\DoctrineException::updateMe("LIMIT argument offset=$offset is not valid"); } $orderby = stristr($query, 'ORDER BY'); if ($orderby !== false) { $sort = (stripos($orderby, 'desc') !== false) ? 'desc' : 'asc'; $order = str_ireplace('ORDER BY', '', $orderby); $order = trim(preg_replace('/ASC|DESC/i', '', $order)); } $query = preg_replace('/^SELECT\s/i', 'SELECT TOP ' . ($count+$offset) . ' ', $query); $query = 'SELECT * FROM (SELECT TOP ' . $count . ' * FROM (' . $query . ') AS inner_tbl'; if ($orderby !== false) { $query .= ' ORDER BY ' . $order . ' '; $query .= (stripos($sort, 'asc') !== false) ? 'DESC' : 'ASC'; } $query .= ') AS outer_tbl'; if ($orderby !== false) { $query .= ' ORDER BY ' . $order . ' ' . $sort; } return $query; } return $query; } public function getAlterTableSql($name, array $changes, $check = false) { foreach ($changes as $changeName => $change) { switch ($changeName) { case 'add': case 'remove': case 'change': case 'rename': case 'name': break; default: throw \Doctrine\Common\DoctrineException::updateMe('alterTable: change type "' . $changeName . '" not yet supported'); } } $query = ''; if ( ! empty($changes['name'])) { $change_name = $this->quoteIdentifier($changes['name']); $query .= 'RENAME TO ' . $change_name; } if ( ! empty($changes['add']) && is_array($changes['add'])) { foreach ($changes['add'] as $fieldName => $field) { if ($query) { $query .= ', '; } $query .= 'ADD ' . $this->getColumnDeclarationSql($fieldName, $field); } } if ( ! empty($changes['remove']) && is_array($changes['remove'])) { foreach ($changes['remove'] as $fieldName => $field) { if ($query) { $query .= ', '; } $field_name = $this->quoteIdentifier($fieldName, true); $query .= 'DROP COLUMN ' . $fieldName; } } $rename = array(); if ( ! empty($changes['rename']) && is_array($changes['rename'])) { foreach ($changes['rename'] as $fieldName => $field) { $rename[$field['name']] = $fieldName; } } if ( ! empty($changes['change']) && is_array($changes['change'])) { foreach ($changes['change'] as $fieldName => $field) { if ($query) { $query.= ', '; } if (isset($rename[$fieldName])) { $oldFieldName = $rename[$fieldName]; unset($rename[$fieldName]); } else { $oldFieldName = $fieldName; } $oldFieldName = $this->quoteIdentifier($oldFieldName, true); $query .= 'CHANGE ' . $oldFieldName . ' ' . $this->getColumnDeclarationSql($fieldName, $field['definition']); } } if ( ! empty($rename) && is_array($rename)) { foreach ($rename as $renameName => $renamedField) { if ($query) { $query.= ', '; } $field = $changes['rename'][$renamedField]; $renamedField = $this->quoteIdentifier($renamedField, true); $query .= 'CHANGE ' . $renamedField . ' ' . $this->getColumnDeclarationSql($field['name'], $field['definition']); } } if ( ! $query) { return false; } $name = $this->quoteIdentifier($name, true); return 'ALTER TABLE ' . $name . ' ' . $query; } /** * Gets the character used for identifier quoting. * * @return string * @override */ public function getIdentifierQuoteCharacter() { return '`'; } /** * Returns the regular expression operator. * * @return string * @override */ public function getRegexpExpression() { return 'RLIKE'; } /** * return string to call a function to get random value inside an SQL statement * * @return string to generate float between 0 and 1 */ public function getRandomExpression() { return 'RAND()'; } /** * Return string to call a variable with the current timestamp inside an SQL statement * There are three special variables for current date and time: * - CURRENT_TIMESTAMP (date and time, TIMESTAMP type) * - CURRENT_DATE (date, DATE type) * - CURRENT_TIME (time, TIME type) * * @return string to call a variable with the current timestamp * @override */ public function getNowExpression($type = 'timestamp') { switch ($type) { case 'time': case 'date': case 'timestamp': default: return 'GETDATE()'; } } /** * return string to call a function to get a substring inside an SQL statement * * @return string to call a function to get a substring * @override */ public function getSubstringExpression($value, $position, $length = null) { if ( ! is_null($length)) { return 'SUBSTRING(' . $value . ', ' . $position . ', ' . $length . ')'; } return 'SUBSTRING(' . $value . ', ' . $position . ', LEN(' . $value . ') - ' . $position . ' + 1)'; } /** * Returns string to concatenate two or more string parameters * * @param string $arg1 * @param string $arg2 * @param string $values... * @return string to concatenate two strings * @override */ public function getConcatExpression() { $args = func_get_args(); return '(' . implode(' + ', $args) . ')'; } /** * Returns global unique identifier * * @return string to get global unique identifier * @override */ public function getGuidExpression() { return 'NEWID()'; } /** * Whether the platform prefers identity columns for ID generation. * MsSql prefers "autoincrement" identity columns since sequences can only * be emulated with a table. * * @return boolean * @override */ public function prefersIdentityColumns() { return true; } /** * Whether the platform supports identity columns. * MsSql supports this through AUTO_INCREMENT columns. * * @return boolean * @override */ public function supportsIdentityColumns() { return true; } /** * Whether the platform supports savepoints. MsSql does not. * * @return boolean * @override */ public function supportsSavepoints() { return false; } public function getShowDatabasesSql() { return 'SHOW DATABASES'; } public function getListTablesSql() { return 'SHOW TABLES'; } /** * create a new database * * @param string $name name of the database that should be created * @return string * @override */ public function getCreateDatabaseSql($name) { return 'CREATE DATABASE ' . $this->quoteIdentifier($name); } /** * drop an existing database * * @param string $name name of the database that should be dropped * @return string * @override */ public function getDropDatabaseSql($name) { return 'DROP DATABASE ' . $this->quoteIdentifier($name); } public function getSetTransactionIsolationSql($level) { return 'SET TRANSACTION ISOLATION LEVEL ' . $this->_getTransactionIsolationLevelSql($level); } public function getIntegerTypeDeclarationSql(array $field) { return 'INT' . $this->_getCommonIntegerTypeDeclarationSql($field); } /** @override */ public function getBigIntTypeDeclarationSql(array $field) { return 'BIGINT' . $this->_getCommonIntegerTypeDeclarationSql($field); } /** @override */ public function getSmallIntTypeDeclarationSql(array $field) { return 'SMALLINT' . $this->_getCommonIntegerTypeDeclarationSql($field); } public function getVarcharTypeDeclarationSql(array $field) { if ( ! isset($field['length'])) { if (array_key_exists('default', $field)) { $field['length'] = $this->getVarcharMaxLength(); } else { $field['length'] = false; } } $length = ($field['length'] <= $this->getVarcharMaxLength()) ? $field['length'] : false; $fixed = (isset($field['fixed'])) ? $field['fixed'] : false; return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(255)') : ($length ? 'VARCHAR(' . $length . ')' : 'TEXT'); } /** @override */ protected function _getCommonIntegerTypeDeclarationSql(array $columnDef) { $autoinc = ''; if ( ! empty($columnDef['autoincrement'])) { $autoinc = ' AUTO_INCREMENT'; } $unsigned = (isset($columnDef['unsigned']) && $columnDef['unsigned']) ? ' UNSIGNED' : ''; return $unsigned . $autoinc; } /** * Obtain DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration to be used in statements like CREATE TABLE. * * @param string $charset name of the charset * @return string DBMS specific SQL code portion needed to set the CHARACTER SET * of a field declaration. */ public function getCharsetFieldDeclaration($charset) { return 'CHARACTER SET ' . $charset; } /** * @override */ public function getDateTimeTypeDeclarationSql(array $fieldDeclaration) { return 'CHAR(' . strlen('YYYY-MM-DD HH:MM:SS') . ')'; } /** * Get the platform name for this instance * * @return string */ public function getName() { return 'mssql'; } }