Fix compatibility with IDENTITY_INSERT (#826)

LordSimal · jhandel · markstory · web-flow · commit 21456eb6e0bd · 2025-03-28T10:13:45.000-04:00
* testing
* add transaction
* Proposed solution with some refactoring in AbstractAdapter so we don't have to copy too much code to SqlServerAdapter. (could be dryer if we wanted)
* Fix tests &amp; Adapter comments

---------

Co-authored-by: Josh &lt;josh@liveoak.ws&gt;
Co-authored-by: Mark Story &lt;mark@mark-story.com&gt;
diff --git a/src/Db/Adapter/AbstractAdapter.php b/src/Db/Adapter/AbstractAdapter.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -602,6 +603,34 @@ public function fetchAll(string $sql): array
      * @inheritDoc
      */
     public function insert(TableMetadata $table, array $row): void
+    {
+        $sql = $this->generateInsertSql($table, $row);
+
+        if ($this->isDryRunEnabled()) {
+            $this->io->out($sql);
+        } else {
+            $vals = [];
+            foreach ($row as $value) {
+                $placeholder = '?';
+                if ($value instanceof Literal || $value instanceof PhinxLiteral) {
+                    $placeholder = (string)$value;
+                }
+                if ($placeholder === '?') {
+                    $vals[] = $value;
+                }
+            }
+            $this->getConnection()->execute($sql, $vals);
+        }
+    }
+
+    /**
+     * Generates the SQL for an insert.
+     *
+     * @param \Migrations\Db\Table\Table $table The table to insert into
+     * @param array $row The row to insert
+     * @return string
+     */
+    protected function generateInsertSql(TableMetadata $table, array $row): string
     {
         $sql = sprintf(
             'INSERT INTO %s ',
@@ -618,22 +647,18 @@ public function insert(TableMetadata $table, array $row): void
 
         if ($this->isDryRunEnabled()) {
             $sql .= ' VALUES (' . implode(', ', array_map($this->quoteValue(...), $row)) . ');';
-            $this->io->out($sql);
+            return $sql;
         } else {
             $values = [];
-            $vals = [];
             foreach ($row as $value) {
                 $placeholder = '?';
                 if ($value instanceof Literal || $value instanceof PhinxLiteral) {
                     $placeholder = (string)$value;
                 }
                 $values[] = $placeholder;
-                if ($placeholder === '?') {
-                    $vals[] = $value;
-                }
             }
             $sql .= ' VALUES (' . implode(',', $values) . ')';
-            $this->getConnection()->execute($sql, $vals);
+            return $sql;
         }
     }
 
@@ -683,6 +708,39 @@ protected function quoteString(string $value): string
      * @inheritDoc
      */
     public function bulkinsert(TableMetadata $table, array $rows): void
+    {
+        $sql = $this->generateBulkInsertSql($table, $rows);
+
+        if ($this->isDryRunEnabled()) {
+            $this->io->out($sql);
+        } else {
+            $vals = [];
+            foreach ($rows as $row) {
+                foreach ($row as $v) {
+                    $placeholder = '?';
+                    if ($v instanceof Literal || $v instanceof PhinxLiteral) {
+                        $placeholder = (string)$v;
+                    }
+                    if ($placeholder == '?') {
+                        if (is_bool($v)) {
+                            $vals[] = $this->castToBool($v);
+                        } else {
+                            $vals[] = $v;
+                        }
+                    }
+                }
+            }
+            $this->getConnection()->execute($sql, $vals);
+        }
+    }
+    /**
+     * Generates the SQL for a bulk insert.
+     *
+     * @param \Migrations\Db\Table\Table $table The table to insert into
+     * @param array $rows The rows to insert
+     * @return string
+     */
+    protected function generateBulkInsertSql(TableMetadata $table, array $rows): string
     {
         $sql = sprintf(
             'INSERT INTO %s ',
@@ -698,9 +756,8 @@ public function bulkinsert(TableMetadata $table, array $rows): void
                 return '(' . implode(', ', array_map($this->quoteValue(...), $row)) . ')';
             }, $rows);
             $sql .= implode(', ', $values) . ';';
-            $this->io->out($sql);
+            return $sql;
         } else {
-            $vals = [];
             $queries = [];
             foreach ($rows as $row) {
                 $values = [];
@@ -710,19 +767,12 @@ public function bulkinsert(TableMetadata $table, array $rows): void
                         $placeholder = (string)$v;
                     }
                     $values[] = $placeholder;
-                    if ($placeholder == '?') {
-                        if (is_bool($v)) {
-                            $vals[] = $this->castToBool($v);
-                        } else {
-                            $vals[] = $v;
-                        }
-                    }
                 }
                 $query = '(' . implode(', ', $values) . ')';
                 $queries[] = $query;
             }
             $sql .= implode(',', $queries);
-            $this->getConnection()->execute($sql, $vals);
+            return $sql;
         }
     }
 
diff --git a/src/Db/Adapter/SqlserverAdapter.php b/src/Db/Adapter/SqlserverAdapter.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -17,6 +18,8 @@
 use Migrations\Db\Table\Index;
 use Migrations\Db\Table\Table;
 use Migrations\MigrationInterface;
+use Migrations\Db\Table\Table as TableMetadata;
+use Phinx\Util\Literal as PhinxLiteral;
 
 /**
  * Migrations SqlServer Adapter.
@@ -104,8 +107,8 @@ public function createTable(Table $table, array $columns = [], array $indexes =
             // Handle id => "field_name" to support AUTO_INCREMENT
             $column = new Column();
             $column->setName($options['id'])
-                   ->setType('integer')
-                   ->setOptions(['identity' => true]);
+                ->setType('integer')
+                ->setOptions(['identity' => true]);
 
             array_unshift($columns, $column);
             if (isset($options['primary_key']) && (array)$options['id'] !== (array)$options['primary_key']) {
@@ -337,11 +340,11 @@ public function getColumns(string $tableName): array
 
             $column = new Column();
             $column->setName($columnInfo['name'])
-                   ->setType($type)
-                   ->setNull($columnInfo['null'] !== 'NO')
-                   ->setDefault($this->parseDefault($columnInfo['default']))
-                   ->setIdentity($columnInfo['identity'] === '1')
-                   ->setComment($this->getColumnComment($columnInfo['table_name'], $columnInfo['name']));
+                ->setType($type)
+                ->setNull($columnInfo['null'] !== 'NO')
+                ->setDefault($this->parseDefault($columnInfo['default']))
+                ->setIdentity($columnInfo['identity'] === '1')
+                ->setComment($this->getColumnComment($columnInfo['table_name'], $columnInfo['name']));
 
             if (!empty($columnInfo['char_length'])) {
                 $column->setLimit((int)$columnInfo['char_length']);
@@ -652,7 +655,7 @@ public function hasIndexByName(string $tableName, string $indexName): bool
 
         foreach ($indexes as $name => $index) {
             if ($name === $indexName) {
-                 return true;
+                return true;
             }
         }
 
@@ -938,15 +941,15 @@ public function getSqlType(Literal|string $type, ?int $limit = null): array
                 return ['name' => 'uniqueidentifier'];
             case static::PHINX_TYPE_FILESTREAM:
                 return ['name' => 'varbinary', 'limit' => 'max'];
-            // Geospatial database types
+                // Geospatial database types
             case static::PHINX_TYPE_GEOGRAPHY:
             case static::PHINX_TYPE_POINT:
             case static::PHINX_TYPE_LINESTRING:
             case static::PHINX_TYPE_POLYGON:
                 // SQL Server stores all spatial data using a single data type.
                 // Specific types (point, polygon, etc) are set at insert time.
                 return ['name' => 'geography'];
-            // Geometry specific type
+                // Geometry specific type
             case static::PHINX_TYPE_GEOMETRY:
                 return ['name' => 'geometry'];
             default:
@@ -1312,4 +1315,82 @@ public function migrated(MigrationInterface $migration, string $direction, strin
 
         return parent::migrated($migration, $direction, $startTime, $endTime);
     }
+    /**
+     * @inheritDoc
+     */
+    public function insert(TableMetadata $table, array $row): void
+    {
+        $sql = $this->generateInsertSql($table, $row);
+
+        $sql = $this->updateSQLForIdentityInsert($table->getName(), $sql);
+
+
+        if ($this->isDryRunEnabled()) {
+            $this->io->out($sql);
+        } else {
+            $vals = [];
+            foreach ($row as $value) {
+                $placeholder = '?';
+                if ($value instanceof Literal || $value instanceof PhinxLiteral) {
+                    $placeholder = (string)$value;
+                }
+                if ($placeholder === '?') {
+                    $vals[] = $value;
+                }
+            }
+            $this->getConnection()->execute($sql, $vals);
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    public function bulkinsert(TableMetadata $table, array $rows): void
+    {
+        $sql = $this->generateBulkInsertSql($table, $rows);
+
+        $sql = $this->updateSQLForIdentityInsert($table->getName(), $sql);
+
+        if ($this->isDryRunEnabled()) {
+            $this->io->out($sql);
+        } else {
+            $vals = [];
+            foreach ($rows as $row) {
+                foreach ($row as $v) {
+                    $placeholder = '?';
+                    if ($v instanceof Literal || $v instanceof PhinxLiteral) {
+                        $placeholder = (string)$v;
+                    }
+                    if ($placeholder == '?') {
+                        if (is_bool($v)) {
+                            $vals[] = $this->castToBool($v);
+                        } else {
+                            $vals[] = $v;
+                        }
+                    }
+                }
+            }
+            $this->getConnection()->execute($sql, $vals);
+        }
+    }
+    /**
+     * @param string $tableName Table name
+     * @param string $sql SQL statement
+     * @return string
+     */
+    private function updateSQLForIdentityInsert(string $tableName, string $sql): string
+    {
+        $options = $this->getOptions();
+        if (isset($options['identity_insert']) && $options['identity_insert'] == true) {
+            $identityInsertStart = sprintf(
+                'SET IDENTITY_INSERT %s ON',
+                $this->quoteTableName($tableName)
+            );
+            $identityInsertEnd = sprintf(
+                'SET IDENTITY_INSERT %s OFF',
+                $this->quoteTableName($tableName)
+            );
+            $sql = $identityInsertStart . ';' . PHP_EOL . $sql . ';' . PHP_EOL . $identityInsertEnd;
+        }
+        return $sql;
+    }
 }
diff --git a/tests/TestCase/Db/Adapter/SqlserverAdapterTest.php b/tests/TestCase/Db/Adapter/SqlserverAdapterTest.php
