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\Schema\ForeignKeyConstraint;
23 use Doctrine\DBAL\Schema\Index;
24 use Doctrine\DBAL\Schema\Sequence;
25 use Doctrine\DBAL\Schema\Table;
26 use Doctrine\DBAL\Schema\TableDiff;
27 use Doctrine\DBAL\DBALException;
33 * @author Roman Borschel <roman@code-factory.org>
34 * @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
35 * @author Benjamin Eberlei <kontakt@beberlei.de>
37 class OraclePlatform extends AbstractPlatform
40 * Assertion for Oracle identifiers
42 * @link http://docs.oracle.com/cd/B19306_01/server.102/b14200/sql_elements008.htm
46 * @throws DBALException
48 static public function assertValidIdentifier($identifier)
50 if ( ! preg_match('(^(([a-zA-Z]{1}[a-zA-Z0-9_$#]{0,})|("[^"]+"))$)', $identifier)) {
51 throw new DBALException("Invalid Oracle identifier");
58 public function getSubstringExpression($value, $position, $length = null)
60 if ($length !== null) {
61 return "SUBSTR($value, $position, $length)";
64 return "SUBSTR($value, $position)";
70 public function getNowExpression($type = 'timestamp')
77 return 'TO_CHAR(CURRENT_TIMESTAMP, \'YYYY-MM-DD HH24:MI:SS\')';
84 public function getLocateExpression($str, $substr, $startPos = false)
86 if ($startPos == false) {
87 return 'INSTR('.$str.', '.$substr.')';
90 return 'INSTR('.$str.', '.$substr.', '.$startPos.')';
96 public function getGuidExpression()
104 * Note: Since Oracle timestamp differences are calculated down to the microsecond we have to truncate
105 * them to the difference in days. This is obviously a restriction of the original functionality, but we
106 * need to make this a portable function.
108 public function getDateDiffExpression($date1, $date2)
110 return "TRUNC(TO_NUMBER(SUBSTR((" . $date1 . "-" . $date2 . "), 1, INSTR(" . $date1 . "-" . $date2 .", ' '))))";
116 public function getDateAddDaysExpression($date, $days)
118 return '(' . $date . '+' . $days . ')';
124 public function getDateSubDaysExpression($date, $days)
126 return '(' . $date . '-' . $days . ')';
132 public function getDateAddMonthExpression($date, $months)
134 return "ADD_MONTHS(" . $date . ", " . $months . ")";
140 public function getDateSubMonthExpression($date, $months)
142 return "ADD_MONTHS(" . $date . ", -" . $months . ")";
148 public function getBitAndComparisonExpression($value1, $value2)
150 return 'BITAND('.$value1 . ', ' . $value2 . ')';
156 public function getBitOrComparisonExpression($value1, $value2)
158 return '(' . $value1 . '-' .
159 $this->getBitAndComparisonExpression($value1, $value2)
160 . '+' . $value2 . ')';
166 * Need to specifiy minvalue, since start with is hidden in the system and MINVALUE <= START WITH.
167 * Therefore we can use MINVALUE to be able to get a hint what START WITH was for later introspection
168 * in {@see listSequences()}
170 public function getCreateSequenceSQL(Sequence $sequence)
172 return 'CREATE SEQUENCE ' . $sequence->getQuotedName($this) .
173 ' START WITH ' . $sequence->getInitialValue() .
174 ' MINVALUE ' . $sequence->getInitialValue() .
175 ' INCREMENT BY ' . $sequence->getAllocationSize();
181 public function getAlterSequenceSQL(\Doctrine\DBAL\Schema\Sequence $sequence)
183 return 'ALTER SEQUENCE ' . $sequence->getQuotedName($this) .
184 ' INCREMENT BY ' . $sequence->getAllocationSize();
190 public function getSequenceNextValSQL($sequenceName)
192 return 'SELECT ' . $sequenceName . '.nextval FROM DUAL';
198 public function getSetTransactionIsolationSQL($level)
200 return 'SET TRANSACTION ISOLATION LEVEL ' . $this->_getTransactionIsolationLevelSQL($level);
206 protected function _getTransactionIsolationLevelSQL($level)
209 case \Doctrine\DBAL\Connection::TRANSACTION_READ_UNCOMMITTED:
210 return 'READ UNCOMMITTED';
211 case \Doctrine\DBAL\Connection::TRANSACTION_READ_COMMITTED:
212 return 'READ COMMITTED';
213 case \Doctrine\DBAL\Connection::TRANSACTION_REPEATABLE_READ:
214 case \Doctrine\DBAL\Connection::TRANSACTION_SERIALIZABLE:
215 return 'SERIALIZABLE';
217 return parent::_getTransactionIsolationLevelSQL($level);
224 public function getBooleanTypeDeclarationSQL(array $field)
232 public function getIntegerTypeDeclarationSQL(array $field)
240 public function getBigIntTypeDeclarationSQL(array $field)
248 public function getSmallIntTypeDeclarationSQL(array $field)
256 public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration)
258 return 'TIMESTAMP(0)';
264 public function getDateTimeTzTypeDeclarationSQL(array $fieldDeclaration)
266 return 'TIMESTAMP(0) WITH TIME ZONE';
272 public function getDateTypeDeclarationSQL(array $fieldDeclaration)
280 public function getTimeTypeDeclarationSQL(array $fieldDeclaration)
288 protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
296 protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
298 return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(2000)')
299 : ($length ? 'VARCHAR2(' . $length . ')' : 'VARCHAR2(4000)');
305 public function getClobTypeDeclarationSQL(array $field)
310 public function getListDatabasesSQL()
312 return 'SELECT username FROM all_users';
315 public function getListSequencesSQL($database)
317 return "SELECT sequence_name, min_value, increment_by FROM sys.all_sequences ".
318 "WHERE SEQUENCE_OWNER = '".strtoupper($database)."'";
324 protected function _getCreateTableSQL($table, array $columns, array $options = array())
326 $indexes = isset($options['indexes']) ? $options['indexes'] : array();
327 $options['indexes'] = array();
328 $sql = parent::_getCreateTableSQL($table, $columns, $options);
330 foreach ($columns as $name => $column) {
331 if (isset($column['sequence'])) {
332 $sql[] = $this->getCreateSequenceSQL($column['sequence'], 1);
335 if (isset($column['autoincrement']) && $column['autoincrement'] ||
336 (isset($column['autoinc']) && $column['autoinc'])) {
337 $sql = array_merge($sql, $this->getCreateAutoincrementSql($name, $table));
341 if (isset($indexes) && ! empty($indexes)) {
342 foreach ($indexes as $index) {
343 $sql[] = $this->getCreateIndexSQL($index, $table);
353 * @license New BSD License
354 * @link http://ezcomponents.org/docs/api/trunk/DatabaseSchema/ezcDbSchemaOracleReader.html
356 public function getListTableIndexesSQL($table, $currentDatabase = null)
358 $table = strtoupper($table);
360 return "SELECT uind.index_name AS name, " .
361 " uind.index_type AS type, " .
362 " decode( uind.uniqueness, 'NONUNIQUE', 0, 'UNIQUE', 1 ) AS is_unique, " .
363 " uind_col.column_name AS column_name, " .
364 " uind_col.column_position AS column_pos, " .
365 " (SELECT ucon.constraint_type FROM user_constraints ucon WHERE ucon.constraint_name = uind.index_name) AS is_primary ".
366 "FROM user_indexes uind, user_ind_columns uind_col " .
367 "WHERE uind.index_name = uind_col.index_name AND uind_col.table_name = '$table' ORDER BY uind_col.column_position ASC";
370 public function getListTablesSQL()
372 return 'SELECT * FROM sys.user_tables';
378 public function getListViewsSQL($database)
380 return 'SELECT view_name, text FROM sys.user_views';
383 public function getCreateViewSQL($name, $sql)
385 return 'CREATE VIEW ' . $name . ' AS ' . $sql;
388 public function getDropViewSQL($name)
390 return 'DROP VIEW '. $name;
393 public function getCreateAutoincrementSql($name, $table, $start = 1)
395 $table = strtoupper($table);
398 $indexName = $table . '_AI_PK';
400 $idx = new Index($indexName, array($name), true, true);
403 constraints_Count NUMBER;
405 SELECT COUNT(CONSTRAINT_NAME) INTO constraints_Count FROM USER_CONSTRAINTS WHERE TABLE_NAME = \''.$table.'\' AND CONSTRAINT_TYPE = \'P\';
406 IF constraints_Count = 0 OR constraints_Count = \'\' THEN
407 EXECUTE IMMEDIATE \''.$this->getCreateConstraintSQL($idx, $table).'\';
411 $sequenceName = $table . '_SEQ';
412 $sequence = new Sequence($sequenceName, $start);
413 $sql[] = $this->getCreateSequenceSQL($sequence);
415 $triggerName = $table . '_AI_PK';
416 $sql[] = 'CREATE TRIGGER ' . $triggerName . '
421 last_Sequence NUMBER;
422 last_InsertID NUMBER;
424 SELECT ' . $sequenceName . '.NEXTVAL INTO :NEW.' . $name . ' FROM DUAL;
425 IF (:NEW.' . $name . ' IS NULL OR :NEW.'.$name.' = 0) THEN
426 SELECT ' . $sequenceName . '.NEXTVAL INTO :NEW.' . $name . ' FROM DUAL;
428 SELECT NVL(Last_Number, 0) INTO last_Sequence
430 WHERE Sequence_Name = \'' . $sequenceName . '\';
431 SELECT :NEW.' . $name . ' INTO last_InsertID FROM DUAL;
432 WHILE (last_InsertID > last_Sequence) LOOP
433 SELECT ' . $sequenceName . '.NEXTVAL INTO last_Sequence FROM DUAL;
441 public function getDropAutoincrementSql($table)
443 $table = strtoupper($table);
444 $trigger = $table . '_AI_PK';
446 $sql[] = 'DROP TRIGGER ' . $trigger;
447 $sql[] = $this->getDropSequenceSQL($table.'_SEQ');
449 $indexName = $table . '_AI_PK';
450 $sql[] = $this->getDropConstraintSQL($indexName, $table);
455 public function getListTableForeignKeysSQL($table)
457 $table = strtoupper($table);
459 return "SELECT alc.constraint_name,
461 alc.search_condition,
462 cols.column_name \"local_column\",
464 r_alc.table_name \"references_table\",
465 r_cols.column_name \"foreign_column\"
466 FROM user_cons_columns cols
467 LEFT JOIN user_constraints alc
468 ON alc.constraint_name = cols.constraint_name
469 LEFT JOIN user_constraints r_alc
470 ON alc.r_constraint_name = r_alc.constraint_name
471 LEFT JOIN user_cons_columns r_cols
472 ON r_alc.constraint_name = r_cols.constraint_name
473 AND cols.position = r_cols.position
474 WHERE alc.constraint_name = cols.constraint_name
475 AND alc.constraint_type = 'R'
476 AND alc.table_name = '".$table."'";
479 public function getListTableConstraintsSQL($table)
481 $table = strtoupper($table);
482 return 'SELECT * FROM user_constraints WHERE table_name = \'' . $table . '\'';
485 public function getListTableColumnsSQL($table, $database = null)
487 $table = strtoupper($table);
489 $tabColumnsTableName = "user_tab_columns";
490 $ownerCondition = '';
492 if (null !== $database){
493 $database = strtoupper($database);
494 $tabColumnsTableName = "all_tab_columns";
495 $ownerCondition = "AND c.owner = '".$database."'";
498 return "SELECT c.*, d.comments FROM $tabColumnsTableName c ".
499 "INNER JOIN user_col_comments d ON d.TABLE_NAME = c.TABLE_NAME AND d.COLUMN_NAME = c.COLUMN_NAME ".
500 "WHERE c.table_name = '" . $table . "' ".$ownerCondition." ORDER BY c.column_name";
506 public function getDropSequenceSQL($sequence)
508 if ($sequence instanceof Sequence) {
509 $sequence = $sequence->getQuotedName($this);
512 return 'DROP SEQUENCE ' . $sequence;
518 public function getDropForeignKeySQL($foreignKey, $table)
520 if ($foreignKey instanceof ForeignKeyConstraint) {
521 $foreignKey = $foreignKey->getQuotedName($this);
524 if ($table instanceof Table) {
525 $table = $table->getQuotedName($this);
528 return 'ALTER TABLE ' . $table . ' DROP CONSTRAINT ' . $foreignKey;
534 public function getDropDatabaseSQL($database)
536 return 'DROP USER ' . $database . ' CASCADE';
542 public function getAlterTableSQL(TableDiff $diff)
545 $commentsSQL = array();
546 $columnSql = array();
550 foreach ($diff->addedColumns as $column) {
551 if ($this->onSchemaAlterTableAddColumn($column, $diff, $columnSql)) {
555 $fields[] = $this->getColumnDeclarationSQL($column->getQuotedName($this), $column->toArray());
556 if ($comment = $this->getColumnComment($column)) {
557 $commentsSQL[] = $this->getCommentOnColumnSQL($diff->name, $column->getName(), $comment);
561 if (count($fields)) {
562 $sql[] = 'ALTER TABLE ' . $diff->name . ' ADD (' . implode(', ', $fields) . ')';
566 foreach ($diff->changedColumns as $columnDiff) {
567 if ($this->onSchemaAlterTableChangeColumn($columnDiff, $diff, $columnSql)) {
571 $column = $columnDiff->column;
572 $fields[] = $column->getQuotedName($this). ' ' . $this->getColumnDeclarationSQL('', $column->toArray());
573 if ($columnDiff->hasChanged('comment') && $comment = $this->getColumnComment($column)) {
574 $commentsSQL[] = $this->getCommentOnColumnSQL($diff->name, $column->getName(), $comment);
578 if (count($fields)) {
579 $sql[] = 'ALTER TABLE ' . $diff->name . ' MODIFY (' . implode(', ', $fields) . ')';
582 foreach ($diff->renamedColumns as $oldColumnName => $column) {
583 if ($this->onSchemaAlterTableRenameColumn($oldColumnName, $column, $diff, $columnSql)) {
587 $sql[] = 'ALTER TABLE ' . $diff->name . ' RENAME COLUMN ' . $oldColumnName .' TO ' . $column->getQuotedName($this);
591 foreach ($diff->removedColumns as $column) {
592 if ($this->onSchemaAlterTableRemoveColumn($column, $diff, $columnSql)) {
596 $fields[] = $column->getQuotedName($this);
599 if (count($fields)) {
600 $sql[] = 'ALTER TABLE ' . $diff->name . ' DROP (' . implode(', ', $fields).')';
605 if ( ! $this->onSchemaAlterTable($diff, $tableSql)) {
606 if ($diff->newName !== false) {
607 $sql[] = 'ALTER TABLE ' . $diff->name . ' RENAME TO ' . $diff->newName;
610 $sql = array_merge($sql, $this->_getAlterTableIndexForeignKeySQL($diff), $commentsSQL);
613 return array_merge($sql, $tableSql, $columnSql);
619 public function prefersSequences()
627 public function supportsCommentOnStatement()
635 public function getName()
643 protected function doModifyLimitQuery($query, $limit, $offset = null)
645 $limit = (int) $limit;
646 $offset = (int) $offset;
648 if (preg_match('/^\s*SELECT/i', $query)) {
649 if (!preg_match('/\sFROM\s/i', $query)) {
650 $query .= " FROM dual";
653 $max = $offset + $limit;
657 $query = 'SELECT * FROM (SELECT a.' . $column . ', rownum AS doctrine_rownum FROM (' .
659 ') a WHERE rownum <= ' . $max . ') WHERE doctrine_rownum >= ' . $min;
661 $query = 'SELECT a.' . $column . ' FROM (' . $query . ') a WHERE ROWNUM <= ' . $max;
672 * Oracle returns all column names in SQL result sets in uppercase.
674 public function getSQLResultCasing($column)
676 return strtoupper($column);
679 public function getCreateTemporaryTableSnippetSQL()
681 return "CREATE GLOBAL TEMPORARY TABLE";
687 public function getDateTimeTzFormatString()
689 return 'Y-m-d H:i:sP';
695 public function getDateFormatString()
697 return 'Y-m-d 00:00:00';
703 public function getTimeFormatString()
705 return '1900-01-01 H:i:s';
711 public function fixSchemaElementName($schemaElementName)
713 if (strlen($schemaElementName) > 30) {
715 return substr($schemaElementName, 0, 30);
718 return $schemaElementName;
724 public function getMaxIdentifierLength()
732 public function supportsSequences()
740 public function supportsForeignKeyOnUpdate()
748 public function supportsReleaseSavepoints()
756 public function getTruncateTableSQL($tableName, $cascade = false)
758 return 'TRUNCATE TABLE '.$tableName;
764 public function getDummySelectSQL()
766 return 'SELECT 1 FROM DUAL';
772 protected function initializeDoctrineTypeMappings()
774 $this->doctrineTypeMapping = array(
775 'integer' => 'integer',
776 'number' => 'integer',
777 'pls_integer' => 'boolean',
778 'binary_integer' => 'boolean',
779 'varchar' => 'string',
780 'varchar2' => 'string',
781 'nvarchar2' => 'string',
784 'date' => 'datetime',
785 'timestamp' => 'datetime',
786 'timestamptz' => 'datetimetz',
792 'long raw' => 'text',
794 'urowid' => 'string',
802 public function releaseSavePoint($savepoint)
810 protected function getReservedKeywordsClass()
812 return 'Doctrine\DBAL\Platforms\Keywords\OracleKeywords';
818 public function getBlobTypeDeclarationSQL(array $field)