Add support for creating temporary tables in schema

docs/en/reference/schema-representation.rst

@@ -93,7 +93,32 @@ and absolutely not portable.
 -  **engine** (string): The DB engine used for the table. Currently only supported on MySQL.
 
 -  **unlogged** (boolean): Set a PostgreSQL table type as
-  `unlogged <https://www.postgresql.org/docs/current/sql-createtable.htmll>`_
+   `unlogged <https://www.postgresql.org/docs/current/sql-createtable.html#SQL-CREATETABLE-UNLOGGED>`_
+
+-  **temporary** (boolean or string): Set table type as temporary
+   Supported on DB2, MySQL, MariaDB, Oracle, PostgreSQL and SQLite.  SQL Server does not have a specific DML for temporary tables.
+
+   Option values for MySQL, MariaDB, PostgreSQL and SQLite:
+
+   - true (bool)
+   - false (bool)
+
+   Option values for Oracle:
+
+   - global (string): emits CREATE GLOBAL TEMPORARY TABLE statement
+   - private (string): emits CREATE PRIVATE TEMPORARY TABLE statement, table name must begin with PRIVATE_TEMP_TABLE_PREFIX, default 'ORA$PTT'
+
+   Option values for DB2:
+
+   - created (string): emits CREATE GLOBAL TEMPORARY TABLE statement
+   - declared (string): emits DECLARE GLOBAL TEMPORARY TABLE statement
+
+-  **on_commit** (string): declare table's commit options, only used if option **temporary** is set.
+   Supported on Oracle and PostgreSQL
+
+   - ``preserve``: preserve rows on commit
+   - ``delete``: delete rows on commit
+   - ``drop``: drop table on commit - only supported by PostgreSQL
 
 Column
 ~~~~~~

src/Platforms/AbstractMySQLPlatform.php

@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Platforms\Keywords\KeywordList;
 use Doctrine\DBAL\Platforms\Keywords\MySQLKeywords;
 use Doctrine\DBAL\Schema\AbstractAsset;
@@ -24,6 +25,7 @@
 use function count;
 use function implode;
 use function in_array;
+use function is_bool;
 use function is_numeric;
 use function sprintf;
 use function str_replace;
@@ -254,7 +256,15 @@ protected function _getCreateTableSQL(string $name, array $columns, array $optio
 
         $sql = ['CREATE'];
 
-        if (! empty($options['temporary'])) {
+        $temporary = $options['temporary'] ?? false;
+        if (! is_bool($temporary)) {
+            throw new InvalidArgumentException(sprintf(
+                'invalid temporary specification for table %s',
+                $name,
+            ));
+        }
+
+        if ($temporary === true) {
             $sql[] = 'TEMPORARY';
         }
 

src/Platforms/DB2Platform.php

@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Platforms\Exception\NotSupported;
 use Doctrine\DBAL\Platforms\Keywords\DB2Keywords;
 use Doctrine\DBAL\Platforms\Keywords\KeywordList;
@@ -20,6 +21,8 @@
 use Doctrine\DBAL\Types\Types;
 
 use function array_merge;
+use function array_unique;
+use function array_values;
 use function count;
 use function current;
 use function explode;
@@ -241,20 +244,50 @@ public function getIndexDeclarationSQL(Index $index): string
      */
     protected function _getCreateTableSQL(string $name, array $columns, array $options = []): array
     {
-        $indexes = [];
-        if (isset($options['indexes'])) {
-            $indexes = $options['indexes'];
+        $columnListSql = $this->getColumnDeclarationListSQL($columns);
+
+        if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) {
+            foreach ($options['uniqueConstraints'] as $definition) {
+                $columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($definition);
+            }
         }
 
-        $options['indexes'] = [];
+        if (isset($options['primary']) && ! empty($options['primary'])) {
+            $columnListSql .= ', PRIMARY KEY(' . implode(', ', array_unique(array_values($options['primary']))) . ')';
+        }
+
+        $statement = match ($options['temporary'] ?? '') {
+            '' => 'CREATE TABLE ',
+            'created' => 'CREATE GLOBAL TEMPORARY TABLE ',
+            'declared' => 'DECLARE GLOBAL TEMPORARY TABLE ',
+            default => throw new InvalidArgumentException(sprintf(
+                'invalid temporary specification for table %s',
+                $name,
+            ))
+        };
+
+        $query = $statement . $name . ' (' . $columnListSql;
+        $check = $this->getCheckDeclarationSQL($columns);
+
+        if (! empty($check)) {
+            $query .= ', ' . $check;
+        }
 
-        $sqls = parent::_getCreateTableSQL($name, $columns, $options);
+        $query .= ')';
+
+        $sql = [$query];
+
+        if (isset($options['foreignKeys'])) {
+            foreach ($options['foreignKeys'] as $definition) {
+                $sql[] = $this->getCreateForeignKeySQL($definition, $name);
+            }
+        }
 
-        foreach ($indexes as $definition) {
-            $sqls[] = $this->getCreateIndexSQL($definition, $name);
+        foreach ($options['indexes'] ?? [] as $definition) {
+            $sql[] = $this->getCreateIndexSQL($definition, $name);
         }
 
-        return $sqls;
+        return $sql;
     }
 
     /**

src/Platforms/OraclePlatform.php

@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception\InvalidColumnType\ColumnLengthRequired;
 use Doctrine\DBAL\Platforms\Keywords\KeywordList;
 use Doctrine\DBAL\Platforms\Keywords\OracleKeywords;
@@ -17,15 +18,18 @@
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\BinaryType;
 use Doctrine\DBAL\Types\Types;
-use InvalidArgumentException;
 
 use function array_merge;
+use function array_unique;
+use function array_values;
 use function count;
 use function explode;
 use function implode;
 use function sprintf;
 use function str_contains;
+use function str_starts_with;
 use function strlen;
+use function strtolower;
 use function strtoupper;
 use function substr;
 
@@ -313,9 +317,62 @@ public function getListSequencesSQL(string $database): string
      */
     protected function _getCreateTableSQL(string $name, array $columns, array $options = []): array
     {
-        $indexes            = $options['indexes'] ?? [];
-        $options['indexes'] = [];
-        $sql                = parent::_getCreateTableSQL($name, $columns, $options);
+        $columnListSql = $this->getColumnDeclarationListSQL($columns);
+
+        if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) {
+            foreach ($options['uniqueConstraints'] as $definition) {
+                $columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($definition);
+            }
+        }
+
+        if (isset($options['primary']) && ! empty($options['primary'])) {
+            $columnListSql .= ', PRIMARY KEY(' . implode(', ', array_unique(array_values($options['primary']))) . ')';
+        }
+
+        $temporary = match ($options['temporary'] ?? '') {
+            '' => '',
+            'global' => 'GLOBAL TEMPORARY ',
+            'private' => 'PRIVATE TEMPORARY ',
+            default => throw new InvalidArgumentException(sprintf(
+                'invalid temporary specification for table %s',
+                $name,
+            ))
+        };
+
+        if (($options['temporary'] ?? '') === 'private' && str_starts_with('ora$ptt_', strtolower($name)) === false) {
+            throw new InvalidArgumentException(sprintf(
+                'invalid name "%s" for private temporary table',
+                $name,
+            ));
+        }
+
+        $onCommit = $temporary !== ''
+            ? match ($options['on_commit'] ?? '') {
+                '' => '',
+                'preserve' => ' ON COMMIT PRESERVE ROWS',
+                'delete' => ' ON COMMIT DELETE ROWS',
+                default =>             throw new InvalidArgumentException(sprintf(
+                    'invalid on commit clause on table %s',
+                    $name,
+                ))
+            } : '';
+
+        $query = 'CREATE ' . $temporary . 'TABLE ' . $name . ' (' . $columnListSql;
+        $check = $this->getCheckDeclarationSQL($columns);
+
+        if (! empty($check)) {
+            $query .= ', ' . $check;
+        }
+
+        $query .= ')' . $onCommit;
+
+        $sql = [$query];
+
+        if (isset($options['foreignKeys'])) {
+            foreach ($options['foreignKeys'] as $definition) {
+                $sql[] = $this->getCreateForeignKeySQL($definition, $name);
+            }
+        }
 
         foreach ($columns as $column) {
             if (isset($column['sequence'])) {
@@ -331,7 +388,7 @@ protected function _getCreateTableSQL(string $name, array $columns, array $optio
             $sql = array_merge($sql, $this->getCreateAutoincrementSql($column['name'], $name));
         }
 
-        foreach ($indexes as $index) {
+        foreach ($options['indexes'] as $index) {
             $sql[] = $this->getCreateIndexSQL($index, $name);
         }
 

src/Platforms/PostgreSQLPlatform.php

@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Platforms;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Platforms\Keywords\KeywordList;
 use Doctrine\DBAL\Platforms\Keywords\PostgreSQLKeywords;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
@@ -383,9 +384,31 @@ protected function _getCreateTableSQL(string $name, array $columns, array $optio
             $queryFields .= ', PRIMARY KEY(' . implode(', ', $keyColumns) . ')';
         }
 
+        $temporary = $options['temporary'] ?? false;
+        if (! is_bool($temporary)) {
+            throw new InvalidArgumentException(sprintf(
+                'invalid temporary specification for table %s',
+                $name,
+            ));
+        }
+
+        $onCommit = $temporary
+            ? match ($options['on_commit'] ?? '') {
+            '' => '',
+            'preserve' => ' ON COMMIT PRESERVE ROWS',
+            'delete' => ' ON COMMIT DELETE ROWS',
+            'drop' => ' ON COMMIT DROP',
+            default =>             throw new InvalidArgumentException(sprintf(
+                'invalid on commit clause on table %s',
+                $name,
+            ))
+            } : '';
+
+        $temporary = $temporary ? ' TEMPORARY' : '';
+
         $unlogged = isset($options['unlogged']) && $options['unlogged'] === true ? ' UNLOGGED' : '';
 
-        $query = 'CREATE' . $unlogged . ' TABLE ' . $name . ' (' . $queryFields . ')';
+        $query = 'CREATE' . $temporary . $unlogged . ' TABLE ' . $name . ' (' . $queryFields . ')' . $onCommit;
 
         $sql = [$query];
 

src/Platforms/SQLitePlatform.php

@@ -32,6 +32,7 @@
 use function count;
 use function explode;
 use function implode;
+use function is_bool;
 use function sprintf;
 use function str_replace;
 use function strpos;
@@ -293,7 +294,17 @@ protected function _getCreateTableSQL(string $name, array $columns, array $optio
             $tableComment = $this->getInlineTableCommentSQL($comment);
         }
 
-        $query = ['CREATE TABLE ' . $name . ' ' . $tableComment . '(' . $queryFields . ')'];
+        $temporary = $options['temporary'] ?? false;
+        if (! is_bool($temporary)) {
+            throw new \Doctrine\DBAL\Exception\InvalidArgumentException(sprintf(
+                'invalid temporary specification for table %s',
+                $name,
+            ));
+        }
+
+        $temporary = $temporary ? 'TEMPORARY ' : '';
+
+        $query = ['CREATE ' . $temporary . 'TABLE ' . $name . ' ' . $tableComment . '(' . $queryFields . ')'];
 
         if (isset($options['alter']) && $options['alter'] === true) {
             return $query;

tests/Platforms/AbstractMySQLPlatformTestCase.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\DBAL\Tests\Platforms;
 
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception\InvalidColumnDeclaration;
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Platforms\MySQL;
@@ -14,6 +15,8 @@
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\Types;
+use Generator;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 use function array_shift;
 
@@ -176,6 +179,52 @@ public function testGetDateTimeTypeDeclarationSql(): void
         self::assertEquals('DATETIME', $this->platform->getDateTimeTypeDeclarationSQL([]));
     }
 
+    #[DataProvider('mysqlTemporaryProvider')]
+    public function testGenerateTemporaryTable(
+        bool $temporary,
+        string $expectedSQL,
+    ): void {
+        $table = new Table('mytable');
+        $table->addOption('temporary', $temporary);
+
+        $table->addColumn('foo', Types::STRING, ['length' => 255]);
+
+        self::assertEquals(
+            [$expectedSQL],
+            $this->platform->getCreateTableSQL($table),
+        );
+    }
+
+    public static function mysqlTemporaryProvider(): Generator
+    {
+        yield 'temporary' => [true, 'CREATE TEMPORARY TABLE mytable (foo VARCHAR(255) NOT NULL)'];
+        yield 'non temporary' => [false, 'CREATE TABLE mytable (foo VARCHAR(255) NOT NULL)'];
+    }
+
+    #[DataProvider('mysqlInvalidTemporaryProvider')]
+    public function testInvalidTemporaryTableOptions(
+        string $table,
+        mixed $temporary,
+        string $expectedException,
+        string $expectedMessage,
+    ): void {
+        $this->expectException($expectedException);
+        $this->expectExceptionMessage($expectedMessage);
+
+        $table = new Table($table);
+        $table->addOption('temporary', $temporary);
+
+        $table->addColumn('foo', Types::STRING, ['length' => 255]);
+
+        $this->platform->getCreateTableSQL($table);
+    }
+
+    public static function mysqlInvalidTemporaryProvider(): Generator
+    {
+        yield 'invalid temporary specification' =>
+        ['mytable', 'invalid', InvalidArgumentException::class, 'invalid temporary specification for table mytable'];
+    }
+
     /** @return string[] */
     protected function getQuotedColumnInPrimaryKeySQL(): array
     {