Rename insertWithReturningPks() to insertReturningPks() (#366)

Author: Tigrov

CHANGELOG.md

@@ -44,6 +44,7 @@
 - Enh #361, #362: Refactor `DMLQueryBuilder::insertWithReturningPks()` method (@Tigrov)
 - New #361, #362: Implement `DMLQueryBuilder::upsertReturning()` method (@Tigrov)
 - Chg #363: Add alias in `DQLQueryBuilder::selectExists()` method for consistency with other DBMS (@Tigrov)
+- Chg #366: Rename `DMLQueryBuilder::insertWithReturningPks()` to `DMLQueryBuilder::insertReturningPks()` (@Tigrov)
 
 ## 1.2.0 March 21, 2024
 

src/DMLQueryBuilder.php

@@ -30,11 +30,11 @@ final class DMLQueryBuilder extends AbstractDMLQueryBuilder
      * @throws InvalidConfigException
      * @throws NotSupportedException
      */
-    public function insertWithReturningPks(string $table, array|QueryInterface $columns, array &$params = []): string
+    public function insertReturningPks(string $table, array|QueryInterface $columns, array &$params = []): string
     {
         $primaryKeys = $this->schema->getTableSchema($table)?->getPrimaryKey() ?? [];
 
-        return $this->insertWithReturning($table, $columns, $primaryKeys, $params);
+        return $this->insertReturning($table, $columns, $primaryKeys, $params);
     }
 
     /**
@@ -89,7 +89,7 @@ public function upsertReturning(
         [$uniqueNames] = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns);
 
         if (empty($uniqueNames)) {
-            return $this->insertWithReturning($table, $insertColumns, $returnColumns, $params);
+            return $this->insertReturning($table, $insertColumns, $returnColumns, $params);
         }
 
         $tableSchema = $this->schema->getTableSchema($table);
@@ -115,7 +115,7 @@ public function upsertReturning(
     /**
      * @param string[] $returnColumns
      */
-    private function insertWithReturning(
+    private function insertReturning(
         string $table,
         array|QueryInterface $columns,
         array|null $returnColumns = null,

tests/CommandTest.php

@@ -95,7 +95,7 @@ public function testInsertVarbinary(mixed $expectedData, mixed $testData): void
         $this->assertSame($expectedData, $resultData['blob_col']);
     }
 
-    public function testInsertWithReturningPksWithComputedColumn(): void
+    public function testInsertReturningPksWithComputedColumn(): void
     {
         $db = $this->getConnection(true);
 
@@ -122,13 +122,13 @@ public function testInsertWithReturningPksWithComputedColumn(): void
         )->execute();
         $insertedString = 'test';
         $transaction = $db->beginTransaction();
-        $result = $command->insertWithReturningPks('{{test_trigger}}', ['stringcol' => $insertedString]);
+        $result = $command->insertReturningPks('{{test_trigger}}', ['stringcol' => $insertedString]);
         $transaction->commit();
 
         $this->assertSame(['id' => '1'], $result);
     }
 
-    public function testInsertWithReturningPksWithRowVersionColumn(): void
+    public function testInsertReturningPksWithRowVersionColumn(): void
     {
         $db = $this->getConnection(true);
 
@@ -139,12 +139,12 @@ public function testInsertWithReturningPksWithRowVersionColumn(): void
             SQL
         )->execute();
         $insertedString = 'test';
-        $result = $command->insertWithReturningPks('{{test_trigger}}', ['stringcol' => $insertedString]);
+        $result = $command->insertReturningPks('{{test_trigger}}', ['stringcol' => $insertedString]);
 
         $this->assertSame(['id' => '1'], $result);
     }
 
-    public function testInsertWithReturningPksWithRowVersionNullColumn(): void
+    public function testInsertReturningPksWithRowVersionNullColumn(): void
     {
         $db = $this->getConnection(true);
 
@@ -155,7 +155,7 @@ public function testInsertWithReturningPksWithRowVersionNullColumn(): void
             SQL
         )->execute();
         $insertedString = 'test';
-        $result = $command->insertWithReturningPks(
+        $result = $command->insertReturningPks(
             '{{test_trigger}}',
             ['stringcol' => $insertedString, 'RV' => new Expression('DEFAULT')],
         );
@@ -168,10 +168,10 @@ public function testResetSequence(): void
         $db = $this->getConnection(true);
 
         $command = $db->createCommand();
-        $oldRow = $command->insertWithReturningPks('{{item}}', ['name' => 'insert_value_for_sequence', 'category_id' => 1]);
+        $oldRow = $command->insertReturningPks('{{item}}', ['name' => 'insert_value_for_sequence', 'category_id' => 1]);
         $command->delete('{{item}}', ['id' => $oldRow['id']])->execute();
         $command->resetSequence('{{item}}')->execute();
-        $newRow = $command->insertWithReturningPks('{{item}}', ['name' => 'insert_value_for_sequence', 'category_id' => 1]);
+        $newRow = $command->insertReturningPks('{{item}}', ['name' => 'insert_value_for_sequence', 'category_id' => 1]);
 
         $this->assertEquals($oldRow['id'], $newRow['id']);
     }

tests/Provider/QueryBuilderProvider.php

@@ -310,7 +310,7 @@ public static function batchInsert(): array
         return $values;
     }
 
-    public static function insertWithReturningPks(): array
+    public static function insertReturningPks(): array
     {
         return [
             'regular-values' => [

tests/QueryBuilderTest.php

@@ -364,15 +364,15 @@ public function testBatchInsert(
         parent::testBatchInsert($table, $rows, $columns, $expected, $expectedParams);
     }
 
-    #[DataProviderExternal(QueryBuilderProvider::class, 'insertWithReturningPks')]
-    public function testInsertWithReturningPks(
+    #[DataProviderExternal(QueryBuilderProvider::class, 'insertReturningPks')]
+    public function testInsertReturningPks(
         string $table,
         array|QueryInterface $columns,
         array $params,
         string $expectedSQL,
         array $expectedParams
     ): void {
-        parent::testInsertWithReturningPks($table, $columns, $params, $expectedSQL, $expectedParams);
+        parent::testInsertReturningPks($table, $columns, $params, $expectedSQL, $expectedParams);
     }
 
     public function testRenameColumn(): void