Add Cloud Spanner Batch DML sample (GoogleCloudPlatform#861)

Author: jsimonweb

spanner/composer.json

@@ -43,7 +43,8 @@
             "src/write_data_with_dml.php",
             "src/write_data_with_dml_transaction.php",
             "src/update_data_with_partitioned_dml.php",
-            "src/delete_data_with_partitioned_dml.php"
+            "src/delete_data_with_partitioned_dml.php",
+            "src/update_data_with_batch_dml.php"
         ]
     }
 }

spanner/quickstart.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016 Google Inc.
+ * Copyright 2016 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

spanner/spanner.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016 Google Inc.
+ * Copyright 2016 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -468,6 +468,17 @@
     })
 );
 
+// Update data with Batch DML
+$application->add((new Command('update-data-with-batch-dml'))
+    ->setDefinition($inputDefinition)
+    ->setDescription('Updates sample data in the given database using Batch DML.')
+    ->setCode(function ($input, $output) {
+        update_data_with_batch_dml(
+            $input->getArgument('instance_id'),
+            $input->getArgument('database_id')
+        );
+    })
+);
 
 // for testing
 if (getenv('PHPUNIT_TESTS') === '1') {

spanner/src/update_data_with_batch_dml.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/spanner/README.md
+ */
+
+namespace Google\Cloud\Samples\Spanner;
+
+// [START spanner_dml_batch_update]
+use Google\Cloud\Spanner\SpannerClient;
+use Google\Cloud\Spanner\Transaction;
+
+/**
+ * Updates sample data in the database with Batch DML.
+ *
+ * This requires the `MarketingBudget` column which must be created before
+ * running this sample. You can add the column by running the `add_column`
+ * sample or by running this DDL statement against your database:
+ *
+ *     ALTER TABLE Albums ADD COLUMN MarketingBudget INT64
+ *
+ * Example:
+ * ```
+ * update_data_with_batch_dml($instanceId, $databaseId);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ */
+function update_data_with_batch_dml($instanceId, $databaseId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    $database = $instance->database($databaseId);
+
+    $batchDmlResult = $database->runTransaction(function (Transaction $t) {
+        $result = $t->executeUpdateBatch([
+            [
+                'sql' => "INSERT INTO Albums "
+                . "(SingerId, AlbumId, AlbumTitle, MarketingBudget) "
+                . "VALUES (1, 3, 'Test Album Title', 10000)"
+            ],
+            [
+                'sql' => "UPDATE Albums "
+                . "SET MarketingBudget = MarketingBudget * 2 "
+                . "WHERE SingerId = 1 and AlbumId = 3"
+            ],
+        ]);
+        $t->commit();
+        $rowCounts = count($result->rowCounts());
+        printf('Executed %s SQL statements using Batch DML.' . PHP_EOL,
+            $rowCounts);
+    });
+}
+// [END spanner_dml_batch_update]

spanner/test/quickstartTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016 Google Inc.
+ * Copyright 2016 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

spanner/test/spannerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016 Google Inc.
+ * Copyright 2016 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -448,7 +448,15 @@ public function testDeleteDataWithPartitionedDML()
         $this->assertContains('Deleted 5 row(s)', $output);
     }
 
-
+    /**
+     * @depends testAddColumn
+     */
+    public function testUpdateDataWithBatchDML()
+    {
+        $output = $this->runCommand('update-data-with-batch-dml');
+        self::$lastUpdateDataTimestamp = time();
+        $this->assertContains('Executed 2 SQL statements using Batch DML', $output);
+    }
 
     private function runCommand($commandName)
     {