fix(Spanner): Making DML returning samples consistent with other languages (#1785)

yash30201 · web-flow · commit e950379ea319 · 2023-03-14T15:52:39.000+05:30
diff --git a/spanner/src/create_database.php b/spanner/src/create_database.php
@@ -50,7 +50,9 @@ function create_database(string $instanceId, string $databaseId): void
             SingerId     INT64 NOT NULL,
             FirstName    STRING(1024),
             LastName     STRING(1024),
-            SingerInfo   BYTES(MAX)
+            SingerInfo   BYTES(MAX),
+            FullName     STRING(2048) AS
+            (ARRAY_TO_STRING([FirstName, LastName], " ")) STORED
         ) PRIMARY KEY (SingerId)',
         'CREATE TABLE Albums (
             SingerId     INT64 NOT NULL,
diff --git a/spanner/src/delete_dml_returning.php b/spanner/src/delete_dml_returning.php
@@ -40,24 +40,26 @@ function delete_dml_returning(string $instanceId, string $databaseId): void
 
     $transaction = $database->transaction();
 
-    // DML returning sql delete query
+    // Delete records from SINGERS table satisfying a particular condition and
+    // returns the SingerId and FullName column of the deleted records using
+    // 'THEN RETURN SingerId, FullName'. It is also possible to return all columns
+    //  of all the deleted records by using 'THEN RETURN *'.
+
     $result = $transaction->execute(
-        'DELETE FROM Singers WHERE FirstName = @firstName '
-        . 'THEN RETURN *',
-        [
-            'parameters' => [
-              'firstName' => 'Melissa',
-            ]
-        ]
+        "DELETE FROM Singers WHERE FirstName = 'Alice' "
+        . 'THEN RETURN SingerId, FullName',
     );
     foreach ($result->rows() as $row) {
         printf(
-            'Row (%s, %s, %s) deleted' . PHP_EOL,
+            '%d %s.' . PHP_EOL,
             $row['SingerId'],
-            $row['FirstName'],
-            $row['LastName']
+            $row['FullName']
         );
     }
+    printf(
+        'Deleted row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_delete_dml_returning]
diff --git a/spanner/src/insert_dml_returning.php b/spanner/src/insert_dml_returning.php
@@ -38,24 +38,30 @@ function insert_dml_returning(string $instanceId, string $databaseId): void
     $instance = $spanner->instance($instanceId);
     $database = $instance->database($databaseId);
 
-    // DML returning sql insert query
+    // Insert records into SINGERS table and returns the generated column
+    // FullName of the inserted records using ‘THEN RETURN FullName’. It is also
+    // possible to return all columns of all the inserted records by using
+    // ‘THEN RETURN *’.
+
     $sql = 'INSERT INTO Singers (SingerId, FirstName, LastName) '
-      . "VALUES (12, 'Melissa', 'Garcia'), "
-      . "(13, 'Russell', 'Morales'), "
-      . "(14, 'Jacqueline', 'Long'), "
-      . "(15, 'Dylan', 'Shaw') "
-      . 'THEN RETURN *';
+        . "VALUES (12, 'Melissa', 'Garcia'), "
+        . "(13, 'Russell', 'Morales'), "
+        . "(14, 'Jacqueline', 'Long'), "
+        . "(15, 'Dylan', 'Shaw') "
+        . 'THEN RETURN FullName';
 
     $transaction = $database->transaction();
     $result = $transaction->execute($sql);
     foreach ($result->rows() as $row) {
         printf(
-            'Row (%s, %s, %s) inserted' . PHP_EOL,
-            $row['SingerId'],
-            $row['FirstName'],
-            $row['LastName']
+            '%s inserted.' . PHP_EOL,
+            $row['FullName'],
         );
     }
+    printf(
+        'Inserted row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_insert_dml_returning]
diff --git a/spanner/src/pg_create_database.php b/spanner/src/pg_create_database.php
@@ -61,7 +61,9 @@ function pg_create_database(string $instanceId, string $databaseId): void
         SingerId   bigint NOT NULL PRIMARY KEY,
         FirstName  varchar(1024),
         LastName   varchar(1024),
-        SingerInfo bytea
+        SingerInfo bytea,
+        FullName character varying(2048) GENERATED
+        ALWAYS AS (FirstName || \' \' || LastName) STORED
     )';
 
     $table2Query = 'CREATE TABLE Albums (
diff --git a/spanner/src/pg_delete_dml_returning.php b/spanner/src/pg_delete_dml_returning.php
@@ -40,24 +40,26 @@ function pg_delete_dml_returning(string $instanceId, string $databaseId): void
 
     $transaction = $database->transaction();
 
-    // DML returning postgresql delete query
+    // Delete records from SINGERS table satisfying a particular condition and
+    // returns the SingerId and FullName column of the deleted records using
+    // ‘RETURNING SingerId, FullName’. It is also possible to return all columns
+    //  of all the deleted records by using ‘RETURNING *’.
+
     $result = $transaction->execute(
-        'DELETE FROM singers WHERE firstname = $1 '
-        . 'RETURNING *',
-        [
-            'parameters' => [
-              'p1' => 'Melissa',
-            ]
-        ]
+        "DELETE FROM Singers WHERE FirstName = 'Alice' "
+        . 'RETURNING SingerId, FullName',
     );
     foreach ($result->rows() as $row) {
         printf(
-            'Row (%s, %s, %s) deleted' . PHP_EOL,
+            '%d %s.' . PHP_EOL,
             $row['singerid'],
-            $row['firstname'],
-            $row['lastname']
+            $row['fullname']
         );
     }
+    printf(
+        'Deleted row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_postgresql_delete_dml_returning]
diff --git a/spanner/src/pg_insert_dml_returning.php b/spanner/src/pg_insert_dml_returning.php
@@ -39,24 +39,30 @@ function pg_insert_dml_returning(string $instanceId, string $databaseId): void
     $instance = $spanner->instance($instanceId);
     $database = $instance->database($databaseId);
 
-    // DML returning postgresql insert query
-    $sql = 'INSERT INTO singers (singerid, firstname, lastname) '
-      . "VALUES (16, 'Melissa', 'Garcia'), "
-      . "(17, 'Russell', 'Morales'), "
-      . "(18, 'Jacqueline', 'Long'), "
-      . "(19, 'Dylan', 'Shaw') "
-      . 'RETURNING *';
+    // Insert records into SINGERS table and returns the generated column
+    // FullName of the inserted records using ‘RETURNING FullName’. It is also
+    // possible to return all columns of all the inserted records by using
+    // ‘RETURNING *’.
+
+    $sql = 'INSERT INTO Singers (Singerid, FirstName, LastName) '
+      . "VALUES (12, 'Melissa', 'Garcia'), "
+      . "(13, 'Russell', 'Morales'), "
+      . "(14, 'Jacqueline', 'Long'), "
+      . "(15, 'Dylan', 'Shaw') "
+      . 'RETURNING FullName';
 
     $transaction = $database->transaction();
     $result = $transaction->execute($sql);
     foreach ($result->rows() as $row) {
         printf(
-            'Row (%s, %s, %s) inserted' . PHP_EOL,
-            $row['singerid'],
-            $row['firstname'],
-            $row['lastname']
+            '%s inserted.' . PHP_EOL,
+            $row['fullname'],
         );
     }
+    printf(
+        'Inserted row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_postgresql_insert_dml_returning]
diff --git a/spanner/src/pg_update_dml_returning.php b/spanner/src/pg_update_dml_returning.php
@@ -40,25 +40,24 @@ function pg_update_dml_returning(string $instanceId, string $databaseId): void
 
     $transaction = $database->transaction();
 
-    // DML returning postgresql update query
+    // Update MarketingBudget column for records satisfying a particular
+    // condition and returns the modified MarketingBudget column of the updated
+    // records using ‘RETURNING MarketingBudget’. It is also possible to return
+    // all columns of all the updated records by using ‘RETURNING *’.
+
     $result = $transaction->execute(
-        'UPDATE singers SET lastname = $1 WHERE singerid = $2 RETURNING *',
-        [
-            'parameters' => [
-              'p1' => 'Missing',
-              'p2' => 16,
-            ]
-        ]
+        'UPDATE Albums '
+        . 'SET MarketingBudget = MarketingBudget * 2 '
+        . 'WHERE SingerId = 1 and AlbumId = 1'
+        . 'RETURNING MarketingBudget'
     );
     foreach ($result->rows() as $row) {
-        printf(
-            'Row with singerid %s updated to (%s, %s, %s)' . PHP_EOL,
-            $row['singerid'],
-            $row['singerid'],
-            $row['firstname'],
-            $row['lastname']
-        );
+        printf('MarketingBudget: %s' . PHP_EOL, $row['marketingbudget']);
     }
+    printf(
+        'Updated row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_postgresql_update_dml_returning]
diff --git a/spanner/src/update_dml_returning.php b/spanner/src/update_dml_returning.php
@@ -40,26 +40,24 @@ function update_dml_returning(string $instanceId, string $databaseId): void
 
     $transaction = $database->transaction();
 
-    // DML returning sql update query
+    // Update MarketingBudget column for records satisfying a particular
+    // condition and returns the modified MarketingBudget column of the updated
+    // records using ‘THEN RETURN MarketingBudget’. It is also possible to return
+    // all columns of all the updated records by using ‘THEN RETURN *’.
+
     $result = $transaction->execute(
-        'UPDATE Singers SET LastName = @lastName '
-        . 'WHERE SingerId = @singerId THEN RETURN *',
-        [
-            'parameters' => [
-              'lastName' => 'Missing',
-              'singerId' => 12,
-            ]
-        ]
+        'UPDATE Albums '
+        . 'SET MarketingBudget = MarketingBudget * 2 '
+        . 'WHERE SingerId = 1 and AlbumId = 1 '
+        . 'THEN RETURN MarketingBudget'
     );
     foreach ($result->rows() as $row) {
-        printf(
-            'Row with SingerId %s updated to (%s, %s, %s)' . PHP_EOL,
-            $row['SingerId'],
-            $row['SingerId'],
-            $row['FirstName'],
-            $row['LastName']
-        );
+        printf('MarketingBudget: %s' . PHP_EOL, $row['MarketingBudget']);
     }
+    printf(
+        'Updated row(s) count: %d' . PHP_EOL,
+        $result->stats()['rowCountExact']
+    );
     $transaction->commit();
 }
 // [END spanner_update_dml_returning]
diff --git a/spanner/test/spannerPgTest.php b/spanner/test/spannerPgTest.php
@@ -68,8 +68,11 @@ public function testCreateDatabase()
     {
         $output = $this->runFunctionSnippet('pg_create_database');
         self::$lastUpdateDataTimestamp = time();
-        $expected = sprintf('Created database %s with dialect POSTGRESQL on instance %s',
-            self::$databaseId, self::$instanceId);
+        $expected = sprintf(
+            'Created database %s with dialect POSTGRESQL on instance %s',
+            self::$databaseId,
+            self::$instanceId
+        );
 
         $this->assertStringContainsString($expected, $output);
     }
@@ -111,8 +114,12 @@ public function testCreateTableCaseSensitivity()
             self::$instanceId, self::$databaseId, $tableName
         ]);
         self::$lastUpdateDataTimestamp = time();
-        $expected = sprintf('Created %s table in database %s on instance %s',
-            $tableName, self::$databaseId, self::$instanceId);
+        $expected = sprintf(
+            'Created %s table in database %s on instance %s',
+            $tableName,
+            self::$databaseId,
+            self::$instanceId
+        );
 
         $this->assertStringContainsString($expected, $output);
     }
@@ -181,8 +188,9 @@ public function testPartitionedDml()
         $op->pollUntilComplete();
 
         $db->runTransaction(function (Transaction $t) {
-            $t->executeUpdate('INSERT INTO users (id, name, active)'
-                . ' VALUES ($1, $2, $3), ($4, $5, $6)',
+            $t->executeUpdate(
+                'INSERT INTO users (id, name, active)'
+                    . ' VALUES ($1, $2, $3), ($4, $5, $6)',
                 [
                     'parameters' => [
                         'p1' => 1,
@@ -192,7 +200,8 @@ public function testPartitionedDml()
                         'p5' => 'Bruce',
                         'p6' => false,
                     ]
-                ]);
+                ]
+            );
             $t->commit();
         });
 
@@ -370,40 +379,71 @@ public function testDmlReturningInsert()
     {
         $output = $this->runFunctionSnippet('pg_insert_dml_returning');
 
-        $expectedOutput = sprintf('Row (16, Melissa, Garcia) inserted');
+        $expectedOutput = sprintf('Melissa Garcia inserted');
         $this->assertStringContainsString($expectedOutput, $output);
 
-        $expectedOutput = sprintf('Row (17, Russell, Morales) inserted');
-        $this->assertStringContainsString('Russell', $output);
+        $expectedOutput = sprintf('Russell Morales inserted');
+        $this->assertStringContainsString($expectedOutput, $output);
 
-        $expectedOutput = sprintf('Row (18, Jacqueline, Long) inserted');
-        $this->assertStringContainsString('Jacqueline', $output);
+        $expectedOutput = sprintf('Jacqueline Long inserted');
+        $this->assertStringContainsString($expectedOutput, $output);
+
+        $expectedOutput = sprintf('Dylan Shaw inserted');
+        $this->assertStringContainsString($expectedOutput, $output);
 
-        $expectedOutput = sprintf('Row (19, Dylan, Shaw) inserted');
-        $this->assertStringContainsString('Dylan', $output);
+        $expectedOutput = sprintf('Inserted row(s) count: 4');
+        $this->assertStringContainsString($expectedOutput, $output);
     }
 
     /**
-     * @depends testDmlReturningInsert
+     * @depends testDmlWithParams
      */
     public function testDmlReturningUpdate()
     {
+        $db = self::$instance->database(self::$databaseId);
+        $db->runTransaction(function (Transaction $t) {
+            $t->update('Albums', [
+                'albumid' => 1,
+                'singerid' => 1,
+                'marketingbudget' => 1000
+            ]);
+            $t->commit();
+        });
+
         $output = $this->runFunctionSnippet('pg_update_dml_returning');
 
-        $expectedOutput = sprintf(
-            'Row with singerid 16 updated to (16, Melissa, Missing)'
-        );
+        $expectedOutput = sprintf('MarketingBudget: 2000');
+        $this->assertStringContainsString($expectedOutput, $output);
+
+        $expectedOutput = sprintf('Updated row(s) count: 1');
         $this->assertStringContainsString($expectedOutput, $output);
     }
 
     /**
-     * @depends testDmlReturningUpdate
+     * @depends testDmlWithParams
      */
     public function testDmlReturningDelete()
     {
+        $db = self::$instance->database(self::$databaseId);
+
+        // Deleting the foreign key dependent entry in the Albums table
+        // before deleting the required row(row which has firstName = Alice)
+        // in the sample.
+        $db->runTransaction(function (Transaction $t) {
+            $spanner = new SpannerClient(['projectId' => self::$projectId]);
+            $keySet = $spanner->keySet([
+                'keys' => [[1, 1]]
+            ]);
+            $t->delete('Albums', $keySet);
+            $t->commit();
+        });
+
         $output = $this->runFunctionSnippet('pg_delete_dml_returning');
 
-        $expectedOutput = sprintf('Row (16, Melissa, Missing) deleted');
+        $expectedOutput = sprintf('1 Alice Henderson');
+        $this->assertStringContainsString($expectedOutput, $output);
+
+        $expectedOutput = sprintf('Deleted row(s) count: 1');
         $this->assertStringContainsString($expectedOutput, $output);
     }
 
diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php
