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.
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>.
20 namespace Doctrine\DBAL\Platforms;
22 use Doctrine\DBAL\DBALException;
23 use Doctrine\DBAL\Schema\Index;
24 use Doctrine\DBAL\Schema\TableDiff;
26 class DB2Platform extends AbstractPlatform
31 public function getBlobTypeDeclarationSQL(array $field)
33 throw DBALException::notSupported(__METHOD__);
39 public function initializeDoctrineTypeMappings()
41 $this->doctrineTypeMapping = array(
42 'smallint' => 'smallint',
44 'integer' => 'integer',
47 'varchar' => 'string',
48 'character' => 'string',
50 'decimal' => 'decimal',
53 'timestamp' => 'datetime',
60 protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
62 return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(255)')
63 : ($length ? 'VARCHAR(' . $length . ')' : 'VARCHAR(255)');
69 public function getClobTypeDeclarationSQL(array $field)
71 // todo clob(n) with $field['length'];
78 public function getName()
86 public function getBooleanTypeDeclarationSQL(array $columnDef)
94 public function getIntegerTypeDeclarationSQL(array $columnDef)
96 return 'INTEGER' . $this->_getCommonIntegerTypeDeclarationSQL($columnDef);
102 public function getBigIntTypeDeclarationSQL(array $columnDef)
104 return 'BIGINT' . $this->_getCommonIntegerTypeDeclarationSQL($columnDef);
110 public function getSmallIntTypeDeclarationSQL(array $columnDef)
112 return 'SMALLINT' . $this->_getCommonIntegerTypeDeclarationSQL($columnDef);
118 protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
121 if ( ! empty($columnDef['autoincrement'])) {
122 $autoinc = ' GENERATED BY DEFAULT AS IDENTITY';
131 public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration)
133 if (isset($fieldDeclaration['version']) && $fieldDeclaration['version'] == true) {
134 return "TIMESTAMP(0) WITH DEFAULT";
137 return 'TIMESTAMP(0)';
143 public function getDateTypeDeclarationSQL(array $fieldDeclaration)
151 public function getTimeTypeDeclarationSQL(array $fieldDeclaration)
156 public function getListDatabasesSQL()
158 throw DBALException::notSupported(__METHOD__);
161 public function getListSequencesSQL($database)
163 throw DBALException::notSupported(__METHOD__);
166 public function getListTableConstraintsSQL($table)
168 throw DBALException::notSupported(__METHOD__);
172 * This code fragment is originally from the Zend_Db_Adapter_Db2 class.
174 * @license New BSD License
175 * @param string $table
176 * @param string $database
179 public function getListTableColumnsSQL($table, $database = null)
181 return "SELECT DISTINCT c.tabschema, c.tabname, c.colname, c.colno,
182 c.typename, c.default, c.nulls, c.length, c.scale,
183 c.identity, tc.type AS tabconsttype, k.colseq
184 FROM syscat.columns c
185 LEFT JOIN (syscat.keycoluse k JOIN syscat.tabconst tc
186 ON (k.tabschema = tc.tabschema
187 AND k.tabname = tc.tabname
189 ON (c.tabschema = k.tabschema
190 AND c.tabname = k.tabname
191 AND c.colname = k.colname)
192 WHERE UPPER(c.tabname) = UPPER('" . $table . "') ORDER BY c.colno";
195 public function getListTablesSQL()
197 return "SELECT NAME FROM SYSIBM.SYSTABLES WHERE TYPE = 'T'";
200 public function getListUsersSQL()
202 throw DBALException::notSupported(__METHOD__);
208 public function getListViewsSQL($database)
210 return "SELECT NAME, TEXT FROM SYSIBM.SYSVIEWS";
216 public function getListTableIndexesSQL($table, $currentDatabase = null)
218 return "SELECT NAME, COLNAMES, UNIQUERULE FROM SYSIBM.SYSINDEXES WHERE TBNAME = UPPER('" . $table . "')";
221 public function getListTableForeignKeysSQL($table)
223 return "SELECT TBNAME, RELNAME, REFTBNAME, DELETERULE, UPDATERULE, FKCOLNAMES, PKCOLNAMES ".
224 "FROM SYSIBM.SYSRELS WHERE TBNAME = UPPER('".$table."')";
227 public function getCreateViewSQL($name, $sql)
229 return "CREATE VIEW ".$name." AS ".$sql;
232 public function getDropViewSQL($name)
234 return "DROP VIEW ".$name;
240 public function getDropSequenceSQL($sequence)
242 throw DBALException::notSupported(__METHOD__);
245 public function getSequenceNextValSQL($sequenceName)
247 throw DBALException::notSupported(__METHOD__);
253 public function getCreateDatabaseSQL($database)
255 return "CREATE DATABASE ".$database;
261 public function getDropDatabaseSQL($database)
263 return "DROP DATABASE ".$database.";";
269 public function supportsCreateDropDatabase()
277 public function supportsReleaseSavepoints()
285 public function getCurrentDateSQL()
287 return 'VALUES CURRENT DATE';
293 public function getCurrentTimeSQL()
295 return 'VALUES CURRENT TIME';
301 public function getCurrentTimestampSQL()
303 return "VALUES CURRENT TIMESTAMP";
309 public function getIndexDeclarationSQL($name, Index $index)
311 return $this->getUniqueConstraintDeclarationSQL($name, $index);
317 protected function _getCreateTableSQL($tableName, array $columns, array $options = array())
320 if (isset($options['indexes'])) {
321 $indexes = $options['indexes'];
323 $options['indexes'] = array();
325 $sqls = parent::_getCreateTableSQL($tableName, $columns, $options);
327 foreach ($indexes as $definition) {
328 $sqls[] = $this->getCreateIndexSQL($definition, $tableName);
336 public function getAlterTableSQL(TableDiff $diff)
339 $columnSql = array();
341 $queryParts = array();
342 foreach ($diff->addedColumns as $column) {
343 if ($this->onSchemaAlterTableAddColumn($column, $diff, $columnSql)) {
347 $queryParts[] = 'ADD COLUMN ' . $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
350 foreach ($diff->removedColumns as $column) {
351 if ($this->onSchemaAlterTableRemoveColumn($column, $diff, $columnSql)) {
355 $queryParts[] = 'DROP COLUMN ' . $column->getQuotedName($this);
358 foreach ($diff->changedColumns as $columnDiff) {
359 if ($this->onSchemaAlterTableChangeColumn($columnDiff, $diff, $columnSql)) {
363 /* @var $columnDiff \Doctrine\DBAL\Schema\ColumnDiff */
364 $column = $columnDiff->column;
365 $queryParts[] = 'ALTER ' . ($columnDiff->oldColumnName) . ' '
366 . $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
369 foreach ($diff->renamedColumns as $oldColumnName => $column) {
370 if ($this->onSchemaAlterTableRenameColumn($oldColumnName, $column, $diff, $columnSql)) {
374 $queryParts[] = 'RENAME ' . $oldColumnName . ' TO ' . $column->getQuotedName($this);
379 if ( ! $this->onSchemaAlterTable($diff, $tableSql)) {
380 if (count($queryParts) > 0) {
381 $sql[] = 'ALTER TABLE ' . $diff->name . ' ' . implode(" ", $queryParts);
384 $sql = array_merge($sql, $this->_getAlterTableIndexForeignKeySQL($diff));
386 if ($diff->newName !== false) {
387 $sql[] = 'RENAME TABLE TO ' . $diff->newName;
391 return array_merge($sql, $tableSql, $columnSql);
397 public function getDefaultValueDeclarationSQL($field)
399 if (isset($field['notnull']) && $field['notnull'] && !isset($field['default'])) {
400 if (in_array((string)$field['type'], array("Integer", "BigInteger", "SmallInteger"))) {
401 $field['default'] = 0;
402 } else if((string)$field['type'] == "DateTime") {
403 $field['default'] = "00-00-00 00:00:00";
404 } else if ((string)$field['type'] == "Date") {
405 $field['default'] = "00-00-00";
406 } else if((string)$field['type'] == "Time") {
407 $field['default'] = "00:00:00";
409 $field['default'] = '';
413 unset($field['default']); // @todo this needs fixing
414 if (isset($field['version']) && $field['version']) {
415 if ((string)$field['type'] != "DateTime") {
416 $field['default'] = "1";
420 return parent::getDefaultValueDeclarationSQL($field);
426 public function getEmptyIdentityInsertSQL($tableName, $identifierColumnName)
428 return 'INSERT INTO ' . $tableName . ' (' . $identifierColumnName . ') VALUES (DEFAULT)';
431 public function getCreateTemporaryTableSnippetSQL()
433 return "DECLARE GLOBAL TEMPORARY TABLE";
439 public function getTemporaryTableName($tableName)
441 return "SESSION." . $tableName;
447 protected function doModifyLimitQuery($query, $limit, $offset = null)
449 if ($limit === null && $offset === null) {
453 $limit = (int)$limit;
454 $offset = (int)(($offset)?:0);
456 // Todo OVER() needs ORDER BY data!
457 $sql = 'SELECT db22.* FROM (SELECT ROW_NUMBER() OVER() AS DC_ROWNUM, db21.* '.
458 'FROM (' . $query . ') db21) db22 WHERE db22.DC_ROWNUM BETWEEN ' . ($offset+1) .' AND ' . ($offset+$limit);
466 public function getLocateExpression($str, $substr, $startPos = false)
468 if ($startPos == false) {
469 return 'LOCATE(' . $substr . ', ' . $str . ')';
472 return 'LOCATE(' . $substr . ', ' . $str . ', '.$startPos.')';
478 public function getSubstringExpression($value, $from, $length = null)
480 if ($length === null) {
481 return 'SUBSTR(' . $value . ', ' . $from . ')';
484 return 'SUBSTR(' . $value . ', ' . $from . ', ' . $length . ')';
490 public function supportsIdentityColumns()
498 public function prefersIdentityColumns()
506 * DB2 returns all column names in SQL result sets in uppercase.
508 public function getSQLResultCasing($column)
510 return strtoupper($column);
513 public function getForUpdateSQL()
515 return ' WITH RR USE AND KEEP UPDATE LOCKS';
521 public function getDummySelectSQL()
523 return 'SELECT 1 FROM sysibm.sysdummy1';
529 * DB2 supports savepoints, but they work semantically different than on other vendor platforms.
531 * TODO: We have to investigate how to get DB2 up and running with savepoints.
533 public function supportsSavepoints()
541 protected function getReservedKeywordsClass()
543 return 'Doctrine\DBAL\Platforms\Keywords\DB2Keywords';