Merge pull request GoogleCloudPlatform#1286 from larkee/spanner-commit-stats-sample

feat(spanner): add sample for commit stats

Author: dwsupplee

spanner/src/get_commit_stats.php

@@ -0,0 +1,68 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * 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_get_commit_stats]
+use Google\Cloud\Spanner\SpannerClient;
+use Google\Cloud\Spanner\Transaction;
+
+/**
+ * Creates a database and tables for sample data.
+ * Example:
+ * ```
+ * create_database($instanceId, $databaseId);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ */
+function get_commit_stats($instanceId, $databaseId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    $database = $instance->database($databaseId);
+
+    $commitStats = $database->runTransaction(function (Transaction $t) use ($spanner) {
+        $t->updateBatch('Albums', [
+            [
+                'SingerId' => 1,
+                'AlbumId' => 1,
+                'MarketingBudget' => 200000,
+            ],
+            [
+                'SingerId' => 2,
+                'AlbumId' => 2,
+                'MarketingBudget' => 400000,
+            ]
+        ]);
+        $t->commit(['returnCommitStats' => true]);
+        return $t->getCommitStats();
+    });
+
+    print('Updated data with ' . $commitStats['mutationCount'] . ' mutations.' . PHP_EOL);
+}
+// [END spanner_get_commit_stats]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

spanner/test/spannerTest.php

@@ -511,6 +511,16 @@ public function testUpdateDataWithBatchDML()
         $this->assertStringContainsString('Executed 2 SQL statements using Batch DML', $output);
     }
 
+    /**
+     * @depends testAddColumn
+     */
+    public function testGetCommitStats()
+    {
+        $output = $this->runFunctionSnippet('get_commit_stats');
+        $this->assertStringContainsString('Updated data with 10 mutations.', $output);
+    }
+
+
     /**
      * @depends testCreateDatabase
      */