SQLServerSchemaManager::_getPortableSequenceDefinition() - Code Metrics - Inspection of "Improve handling of schemas in SQL Server >= 2008" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3020)

by Michael

created 2018-03-29 19:47 UTC

_getPortableSequenceDefinition() A

↳ Parent: SQLServerSchemaManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	1
crap	2

<?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\Schema;

use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Driver\DriverException;
use Doctrine\DBAL\Types\Type;

/**
 * SQL Server Schema Manager.
 *
 * @license http://www.opensource.org/licenses/mit-license.php MIT
 * @author  Konsta Vesterinen <[email protected]>
 * @author  Lukas Smith <[email protected]> (PEAR MDB2 library)
 * @author  Juozas Kaziukenas <[email protected]>
 * @author  Steve Müller <[email protected]>
 * @since   2.0
 */
class SQLServerSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    public function dropDatabase($database)
    {
        try {
            parent::dropDatabase($database);
        } catch (DBALException $exception) {
            $exception = $exception->getPrevious();

            if (! $exception instanceof DriverException) {
                throw $exception;
            }

            // If we have a error code 3702, the drop database operation failed
            // because of active connections on the database.
            // To force dropping the database, we first have to close all active connections
            // on that database and issue the drop database operation again.
            if ($exception->getErrorCode() !== 3702) {
                throw $exception;
            }

            $this->closeActiveDatabaseConnections($database);

            parent::dropDatabase($database);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableSequenceDefinition($sequence)
    {
        return new Sequence($sequence['name'], $sequence['increment'], $sequence['start_value']);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableColumnDefinition($tableColumn)
    {
        $dbType = strtok($tableColumn['type'], '(), ');
        $fixed = null;
        $length = (int) $tableColumn['length'];
        $default = $tableColumn['default'];

        if (!isset($tableColumn['name'])) {
            $tableColumn['name'] = '';
        }

        while ($default != ($default2 = preg_replace("/^\((.*)\)$/", '$1', $default))) {
            $default = trim($default2, "'");

            if ($default == 'getdate()') {
                $default = $this->_platform->getCurrentTimestampSQL();
            }
        }

        switch ($dbType) {
            case 'nchar':
            case 'nvarchar':
            case 'ntext':
                // Unicode data requires 2 bytes per character
                $length = $length / 2;
                break;
            case 'varchar':
                // TEXT type is returned as VARCHAR(MAX) with a length of -1
                if ($length == -1) {
                    $dbType = 'text';
                }
                break;
        }

        if ('char' === $dbType || 'nchar' === $dbType || 'binary' === $dbType) {
            $fixed = true;
        }

        $type                   = $this->_platform->getDoctrineTypeMapping($dbType);
        $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);

        $options = [
            'length'        => ($length == 0 || !in_array($type, ['text', 'string'])) ? null : $length,
            'unsigned'      => false,
            'fixed'         => (bool) $fixed,
            'default'       => $default !== 'NULL' ? $default : null,
            'notnull'       => (bool) $tableColumn['notnull'],
            'scale'         => $tableColumn['scale'],
            'precision'     => $tableColumn['precision'],
            'autoincrement' => (bool) $tableColumn['autoincrement'],
            'comment'       => $tableColumn['comment'] !== '' ? $tableColumn['comment'] : null,
        ];

        $column = new Column($tableColumn['name'], Type::getType($type), $options);

        if (isset($tableColumn['collation']) && $tableColumn['collation'] !== 'NULL') {
            $column->setPlatformOption('collation', $tableColumn['collation']);
        }

        return $column;
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeysList($tableForeignKeys)
    {
        $foreignKeys = [];

        foreach ($tableForeignKeys as $tableForeignKey) {
            if ( ! isset($foreignKeys[$tableForeignKey['ForeignKey']])) {
                $foreignKeys[$tableForeignKey['ForeignKey']] = [
                    'local_columns' => [$tableForeignKey['ColumnName']],
                    'foreign_table' => $tableForeignKey['ReferenceTableName'],
                    'foreign_columns' => [$tableForeignKey['ReferenceColumnName']],
                    'name' => $tableForeignKey['ForeignKey'],
                    'options' => [
                        'onUpdate' => str_replace('_', ' ', $tableForeignKey['update_referential_action_desc']),
                        'onDelete' => str_replace('_', ' ', $tableForeignKey['delete_referential_action_desc'])
                    ]
                ];
            } else {
                $foreignKeys[$tableForeignKey['ForeignKey']]['local_columns'][] = $tableForeignKey['ColumnName'];
                $foreignKeys[$tableForeignKey['ForeignKey']]['foreign_columns'][] = $tableForeignKey['ReferenceColumnName'];
            }
        }

        return parent::_getPortableTableForeignKeysList($foreignKeys);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableIndexesList($tableIndexRows, $tableName=null)
    {
        foreach ($tableIndexRows as &$tableIndex) {
            $tableIndex['non_unique'] = (boolean) $tableIndex['non_unique'];
            $tableIndex['primary'] = (boolean) $tableIndex['primary'];
            $tableIndex['flags'] = $tableIndex['flags'] ? [$tableIndex['flags']] : null;
        }

        return parent::_getPortableTableIndexesList($tableIndexRows, $tableName);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeyDefinition($tableForeignKey)
    {
        return new ForeignKeyConstraint(
            $tableForeignKey['local_columns'],
            $tableForeignKey['foreign_table'],
            $tableForeignKey['foreign_columns'],
            $tableForeignKey['name'],
            $tableForeignKey['options']
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableDefinition($table)
    {
        if (isset($table['schema_name']) && $table['schema_name'] !== 'dbo') {
            return $table['schema_name'] . '.' . $table['name'];
        }

        return $table['name'];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableDatabaseDefinition($database)
    {
        return $database['name'];
    }

    /**
     * {@inheritdoc}
     */
    protected function getPortableNamespaceDefinition(array $namespace)
    {
        return $namespace['name'];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableViewDefinition($view)
    {
        // @todo
        return new View($view['name'], null);
    }

    /**
     * {@inheritdoc}
     */
    public function listTableIndexes($table)
    {
        $sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());

        try {
            $tableIndexes = $this->_conn->fetchAll($sql);
        } catch (\PDOException $e) {
            if ($e->getCode() == "IMSSP") {
                return [];
            } else {
                throw $e;
            }
        } catch (DBALException $e) {
            if (strpos($e->getMessage(), 'SQLSTATE [01000, 15472]') === 0) {
                return [];
            } else {
                throw $e;
            }
        }

        return $this->_getPortableTableIndexesList($tableIndexes, $table);
    }

    /**
     * {@inheritdoc}
     */
    public function alterTable(TableDiff $tableDiff)
    {
        if (count($tableDiff->removedColumns) > 0) {
            foreach ($tableDiff->removedColumns as $col) {
                $columnConstraintSql = $this->getColumnConstraintSQL($tableDiff->name, $col->getName());
                foreach ($this->_conn->fetchAll($columnConstraintSql) as $constraint) {
                    $this->_conn->exec("ALTER TABLE $tableDiff->name DROP CONSTRAINT " . $constraint['Name']);
                }
            }
        }

        parent::alterTable($tableDiff);
    }

    /**
     * Returns the SQL to retrieve the constraints for a given column.
     *
     * @param string $table
     * @param string $column
     *
     * @return string
     */
    private function getColumnConstraintSQL($table, $column)
    {
        return "SELECT SysObjects.[Name]
            FROM SysObjects INNER JOIN (SELECT [Name],[ID] FROM SysObjects WHERE XType = 'U') AS Tab
            ON Tab.[ID] = Sysobjects.[Parent_Obj]
            INNER JOIN sys.default_constraints DefCons ON DefCons.[object_id] = Sysobjects.[ID]
            INNER JOIN SysColumns Col ON Col.[ColID] = DefCons.[parent_column_id] AND Col.[ID] = Tab.[ID]
            WHERE Col.[Name] = " . $this->_conn->quote($column) ." AND Tab.[Name] = " . $this->_conn->quote($table) . "
            ORDER BY Col.[Name]";
    }

    /**
     * Closes currently active connections on the given database.
     *
     * This is useful to force DROP DATABASE operations which could fail because of active connections.
     *
     * @param string $database The name of the database to close currently active connections for.
     *
     * @return void
     */
    private function closeActiveDatabaseConnections($database)
    {
        $database = new Identifier($database);

        $this->_execSql(
            sprintf(
                'ALTER DATABASE %s SET SINGLE_USER WITH ROLLBACK IMMEDIATE',
                $database->getQuotedName($this->_platform)
            )
        );
    }
}


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.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\DBAL\Schema;
21
22		use Doctrine\DBAL\DBALException;
23		use Doctrine\DBAL\Driver\DriverException;
24		use Doctrine\DBAL\Types\Type;
25
26		/**
27		* SQL Server Schema Manager.
28		*
29		* @license http://www.opensource.org/licenses/mit-license.php MIT
30		* @author Konsta Vesterinen <[email protected]>
31		* @author Lukas Smith <[email protected]> (PEAR MDB2 library)
32		* @author Juozas Kaziukenas <[email protected]>
33		* @author Steve Müller <[email protected]>
34		* @since 2.0
35		*/
36		class SQLServerSchemaManager extends AbstractSchemaManager
37		{
38		/**
39		* {@inheritdoc}
40		*/
41		public function dropDatabase($database)
42		{
43		try {
44		parent::dropDatabase($database);
45		} catch (DBALException $exception) {
46		$exception = $exception->getPrevious();
47
48		if (! $exception instanceof DriverException) {
49		throw $exception;
50		}
51
52		// If we have a error code 3702, the drop database operation failed
53		// because of active connections on the database.
54		// To force dropping the database, we first have to close all active connections
55		// on that database and issue the drop database operation again.
56		if ($exception->getErrorCode() !== 3702) {
57		throw $exception;
58		}
59
60		$this->closeActiveDatabaseConnections($database);
61
62		parent::dropDatabase($database);
63		}
64		}
65
66		/**
67		* {@inheritdoc}
68		*/
69		protected function _getPortableSequenceDefinition($sequence)
70		{
71		return new Sequence($sequence['name'], $sequence['increment'], $sequence['start_value']);
72		}
73
74		/**
75		* {@inheritdoc}
76		*/
77	1	protected function _getPortableTableColumnDefinition($tableColumn)
78		{
79	1	$dbType = strtok($tableColumn['type'], '(), ');
80	1	$fixed = null;
81	1	$length = (int) $tableColumn['length'];
82	1	$default = $tableColumn['default'];
83
84	1	if (!isset($tableColumn['name'])) {
85	1	$tableColumn['name'] = '';
86		}
87
88	1	while ($default != ($default2 = preg_replace("/^\((.*)\)$/", '$1', $default))) {
89		$default = trim($default2, "'");
90
91		if ($default == 'getdate()') {
92		$default = $this->_platform->getCurrentTimestampSQL();
93		}
94		}
95
96		switch ($dbType) {
97	1	case 'nchar':
98	1	case 'nvarchar':
99	1	case 'ntext':
100		// Unicode data requires 2 bytes per character
101		$length = $length / 2;
102		break;
103	1	case 'varchar':
104		// TEXT type is returned as VARCHAR(MAX) with a length of -1
105		if ($length == -1) {
106		$dbType = 'text';
107		}
108		break;
109		}
110
111	1	if ('char' === $dbType \|\| 'nchar' === $dbType \|\| 'binary' === $dbType) {
112		$fixed = true;
113		}
114
115	1	$type = $this->_platform->getDoctrineTypeMapping($dbType);
116	1	$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
117	1	$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
118
119		$options = [
120	1	'length' => ($length == 0 \|\| !in_array($type, ['text', 'string'])) ? null : $length,
121		'unsigned' => false,
122	1	'fixed' => (bool) $fixed,
123	1	'default' => $default !== 'NULL' ? $default : null,
124	1	'notnull' => (bool) $tableColumn['notnull'],
125	1	'scale' => $tableColumn['scale'],
126	1	'precision' => $tableColumn['precision'],
127	1	'autoincrement' => (bool) $tableColumn['autoincrement'],
128	1	'comment' => $tableColumn['comment'] !== '' ? $tableColumn['comment'] : null,
129		];
130
131	1	$column = new Column($tableColumn['name'], Type::getType($type), $options);
132
133	1	if (isset($tableColumn['collation']) && $tableColumn['collation'] !== 'NULL') {
134	1	$column->setPlatformOption('collation', $tableColumn['collation']);
135		}
136
137	1	return $column;
138		}
139
140		/**
141		* {@inheritdoc}
142		*/
143		protected function _getPortableTableForeignKeysList($tableForeignKeys)
144		{
145		$foreignKeys = [];
146
147		foreach ($tableForeignKeys as $tableForeignKey) {
148		if ( ! isset($foreignKeys[$tableForeignKey['ForeignKey']])) {
149		$foreignKeys[$tableForeignKey['ForeignKey']] = [
150		'local_columns' => [$tableForeignKey['ColumnName']],
151		'foreign_table' => $tableForeignKey['ReferenceTableName'],
152		'foreign_columns' => [$tableForeignKey['ReferenceColumnName']],
153		'name' => $tableForeignKey['ForeignKey'],
154		'options' => [
155		'onUpdate' => str_replace('_', ' ', $tableForeignKey['update_referential_action_desc']),
156		'onDelete' => str_replace('_', ' ', $tableForeignKey['delete_referential_action_desc'])
157		]
158		];
159		} else {
160		$foreignKeys[$tableForeignKey['ForeignKey']]['local_columns'][] = $tableForeignKey['ColumnName'];
161		$foreignKeys[$tableForeignKey['ForeignKey']]['foreign_columns'][] = $tableForeignKey['ReferenceColumnName'];
162		}
163		}
164
165		return parent::_getPortableTableForeignKeysList($foreignKeys);
166		}
167
168		/**
169		* {@inheritdoc}
170		*/
171		protected function _getPortableTableIndexesList($tableIndexRows, $tableName=null)
172		{
173		foreach ($tableIndexRows as &$tableIndex) {
174		$tableIndex['non_unique'] = (boolean) $tableIndex['non_unique'];
175		$tableIndex['primary'] = (boolean) $tableIndex['primary'];
176		$tableIndex['flags'] = $tableIndex['flags'] ? [$tableIndex['flags']] : null;
177		}
178
179		return parent::_getPortableTableIndexesList($tableIndexRows, $tableName);
180		}
181
182		/**
183		* {@inheritdoc}
184		*/
185		protected function _getPortableTableForeignKeyDefinition($tableForeignKey)
186		{
187		return new ForeignKeyConstraint(
188		$tableForeignKey['local_columns'],
189		$tableForeignKey['foreign_table'],
190		$tableForeignKey['foreign_columns'],
191		$tableForeignKey['name'],
192		$tableForeignKey['options']
193		);
194		}
195
196		/**
197		* {@inheritdoc}
198		*/
199		protected function _getPortableTableDefinition($table)
200		{
201		if (isset($table['schema_name']) && $table['schema_name'] !== 'dbo') {
202		return $table['schema_name'] . '.' . $table['name'];
203		}
204
205		return $table['name'];
206		}
207
208		/**
209		* {@inheritdoc}
210		*/
211		protected function _getPortableDatabaseDefinition($database)
212		{
213		return $database['name'];
214		}
215
216		/**
217		* {@inheritdoc}
218		*/
219		protected function getPortableNamespaceDefinition(array $namespace)
220		{
221		return $namespace['name'];
222		}
223
224		/**
225		* {@inheritdoc}
226		*/
227		protected function _getPortableViewDefinition($view)
228		{
229		// @todo
230		return new View($view['name'], null);
231		}
232
233		/**
234		* {@inheritdoc}
235		*/
236		public function listTableIndexes($table)
237		{
238		$sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());
239
240		try {
241		$tableIndexes = $this->_conn->fetchAll($sql);
242		} catch (\PDOException $e) {
243		if ($e->getCode() == "IMSSP") {
244		return [];
245		} else {
246		throw $e;
247		}
248		} catch (DBALException $e) {
249		if (strpos($e->getMessage(), 'SQLSTATE [01000, 15472]') === 0) {
250		return [];
251		} else {
252		throw $e;
253		}
254		}
255
256		return $this->_getPortableTableIndexesList($tableIndexes, $table);
257		}
258
259		/**
260		* {@inheritdoc}
261		*/
262		public function alterTable(TableDiff $tableDiff)
263		{
264		if (count($tableDiff->removedColumns) > 0) {
265		foreach ($tableDiff->removedColumns as $col) {
266		$columnConstraintSql = $this->getColumnConstraintSQL($tableDiff->name, $col->getName());
267		foreach ($this->_conn->fetchAll($columnConstraintSql) as $constraint) {
268		$this->_conn->exec("ALTER TABLE $tableDiff->name DROP CONSTRAINT " . $constraint['Name']);
269		}
270		}
271		}
272
273		parent::alterTable($tableDiff);
274		}
275
276		/**
277		* Returns the SQL to retrieve the constraints for a given column.
278		*
279		* @param string $table
280		* @param string $column
281		*
282		* @return string
283		*/
284		private function getColumnConstraintSQL($table, $column)
285		{
286		return "SELECT SysObjects.[Name]
287		FROM SysObjects INNER JOIN (SELECT [Name],[ID] FROM SysObjects WHERE XType = 'U') AS Tab
288		ON Tab.[ID] = Sysobjects.[Parent_Obj]
289		INNER JOIN sys.default_constraints DefCons ON DefCons.[object_id] = Sysobjects.[ID]
290		INNER JOIN SysColumns Col ON Col.[ColID] = DefCons.[parent_column_id] AND Col.[ID] = Tab.[ID]
291		WHERE Col.[Name] = " . $this->_conn->quote($column) ." AND Tab.[Name] = " . $this->_conn->quote($table) . "
292		ORDER BY Col.[Name]";
293		}
294
295		/**
296		* Closes currently active connections on the given database.
297		*
298		* This is useful to force DROP DATABASE operations which could fail because of active connections.
299		*
300		* @param string $database The name of the database to close currently active connections for.
301		*
302		* @return void
303		*/
304		private function closeActiveDatabaseConnections($database)
305		{
306		$database = new Identifier($database);
307
308		$this->_execSql(
309		sprintf(
310		'ALTER DATABASE %s SET SINGLE_USER WITH ROLLBACK IMMEDIATE',
311		$database->getQuotedName($this->_platform)
312		)
313		);
314		}
315		}
316

doctrine / dbal

Pull Request — master (#3020)

_getPortableSequenceDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like