Support upsert the same primary key or unique values on inserting and updating

CHANGELOG.md

@@ -41,7 +41,7 @@
 - New #387: Realize `Schema::loadResultColumn()` method (@Tigrov)
 - New #393: Use `DateTimeColumn` class for datetime column types (@Tigrov)
 - Enh #396, #409: Refactor constraints (@Tigrov)
-- New #394, #395, #398, #425: Implement `Command::upsertReturning()` method (@Tigrov, @vjik)
+- New #394, #395, #398, #425, #435: Implement `Command::upsertReturning()` method (@Tigrov, @vjik)
 - Enh #394, #395: Refactor `Command::insertWithReturningPks()` method (@Tigrov)
 - Chg #399: Rename `insertWithReturningPks()` to `insertReturningPks()` in `Command` and `DMLQueryBuilder` classes (@Tigrov)
 - Enh #403: Refactor `DMLQueryBuilder::upsert()`, allow use `EXCLUDED` table alias to access inserted values (@Tigrov)

src/DMLQueryBuilder.php

@@ -14,8 +14,8 @@
 
 use function array_combine;
 use function array_diff;
+use function array_diff_key;
 use function array_fill_keys;
-use function array_intersect;
 use function array_intersect_key;
 use function array_keys;
 use function array_map;
@@ -134,13 +134,10 @@ public function upsertReturning(
         $tableSchema = $this->schema->getTableSchema($table);
         $returnColumns ??= $tableSchema?->getColumnNames();
 
-        $upsertSql = $this->upsert($table, $insertColumns, $updateColumns, $params);
-
         if (empty($returnColumns)) {
-            return $upsertSql;
+            return $this->upsert($table, $insertColumns, $updateColumns, $params);
         }
 
-        $quoter = $this->quoter;
         [$uniqueNames, $insertNames] = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns);
         /** @var TableSchema $tableSchema */
         $primaryKeys = $tableSchema->getPrimaryKey();
@@ -150,20 +147,30 @@ public function upsertReturning(
             $insertColumns = array_combine($insertNames, $insertColumns);
         }
 
-
         if (empty($uniqueColumns)) {
+            $upsertSql = $this->upsert($table, $insertColumns, $updateColumns, $params);
             $returnValues = $this->prepareColumnValues($tableSchema, $returnColumns, $insertColumns, $params);
 
             return $upsertSql . ';' . $this->buildSimpleSelect($returnValues);
         }
 
-        if (is_array($updateColumns) && !empty(array_intersect($uniqueColumns, array_keys($updateColumns)))) {
-            throw new NotSupportedException(
-                __METHOD__ . '() is not supported by MySQL when updating primary key or unique values.'
-            );
+        if (is_array($updateColumns)
+            && !empty($uniqueUpdateValues = array_intersect_key($updateColumns, array_fill_keys($uniqueColumns, null)))
+        ) {
+            if (!is_array($insertColumns)
+                || $uniqueUpdateValues !== array_intersect_key($insertColumns, $uniqueUpdateValues)
+            ) {
+                throw new NotSupportedException(
+                    __METHOD__ . '() is not supported by MySQL when updating different primary key or unique values.'
+                );
+            }
+
+            $updateColumns = array_diff_key($updateColumns, $uniqueUpdateValues);
         }
 
+        $quoter = $this->quoter;
         $quotedTable = $quoter->quoteTableName($table);
+        $upsertSql = $this->upsert($table, $insertColumns, $updateColumns, $params);
         $isAutoIncrement = count($primaryKeys) === 1 && $tableSchema->getColumn($primaryKeys[0])?->isAutoIncrement();
 
         if ($isAutoIncrement) {

tests/QueryBuilderTest.php

@@ -612,12 +612,37 @@ public function testUpsertReturningWithUpdatingPrimaryKeyOrUnique(
 
         $this->expectException(NotSupportedException::class);
         $this->expectExceptionMessage(
-            'Yiisoft\Db\Mysql\DMLQueryBuilder::upsertReturning() is not supported by MySQL when updating primary key or unique values.'
+            'Yiisoft\Db\Mysql\DMLQueryBuilder::upsertReturning() is not supported by MySQL when updating different primary key or unique values.'
         );
 
         $qb->upsertReturning($table, $insertColumns, $updateColumns);
     }
 
+    public function testUpsertReturningWithSameUpdatingPrimaryKeyOrUnique(): void
+    {
+        $db = $this->getConnection(true);
+        $qb = $db->getQueryBuilder();
+
+        $params = [];
+        $sql = $qb->upsertReturning('category', ['id' => 1, 'name' => 'Books'], ['id' => 1, 'name' => 'Audio'], params: $params);
+
+        $this->assertSame(
+            'INSERT INTO `category` (`id`, `name`)'
+            . ' SELECT `id`, `name` FROM (SELECT 1 AS `id`, :qp0 AS `name`) AS EXCLUDED'
+            . ' ON DUPLICATE KEY UPDATE `name`=:qp1, `id`=LAST_INSERT_ID(`category`.`id`);'
+            . 'SELECT `id`, `name` FROM `category` WHERE `id` = LAST_INSERT_ID()',
+            $sql,
+        );
+
+        $this->assertEquals(
+            [
+                ':qp0' => new Param('Books', DataType::STRING),
+                ':qp1' => new Param('Audio', DataType::STRING),
+            ],
+            $params,
+        );
+    }
+
     #[TestWith(['order_item', ['subtotal' => 1], ['subtotal' => 10]])]
     #[TestWith(['without_pk', ['email' => null, 'name' => 'John'], ['name' => 'John']])]
     public function testUpsertReturningWithNullPrimaryKeyOrUnique(