Merge branch 'master' into php74-yaml

Author: Ace Nassri

spanner/src/create_backup.php

@@ -31,22 +31,25 @@
  * Create a backup.
  * Example:
  * ```
- * create_backup($instanceId, $databaseId, $backupId);
+ * create_backup($instanceId, $databaseId, $backupId, $versionTime);
  * ```
  *
  * @param string $instanceId The Spanner instance ID.
  * @param string $databaseId The Spanner database ID.
  * @param string $backupId The Spanner backup ID.
+ * @param string $versionTime The version of the database to backup.
  */
-function create_backup($instanceId, $databaseId, $backupId)
+function create_backup($instanceId, $databaseId, $backupId, $versionTime)
 {
     $spanner = new SpannerClient();
     $instance = $spanner->instance($instanceId);
     $database = $instance->database($databaseId);
 
     $expireTime = new \DateTime('+14 days');
     $backup = $instance->backup($backupId);
-    $operation = $backup->create($database->name(), $expireTime);
+    $operation = $backup->create($database->name(), $expireTime, [
+        'versionTime' => new \DateTime($versionTime)
+    ]);
 
     print('Waiting for operation to complete...' . PHP_EOL);
     $operation->pollUntilComplete();
@@ -57,7 +60,9 @@ function create_backup($instanceId, $databaseId, $backupId)
     if ($ready) {
         print('Backup is ready!' . PHP_EOL);
         $info = $backup->info();
-        printf('Backup %s of size %d bytes was created at %s' . PHP_EOL, basename($info['name']), $info['sizeBytes'], $info['createTime']);
+        printf(
+            'Backup %s of size %d bytes was created at %s for version of database at %s' . PHP_EOL,
+            basename($info['name']), $info['sizeBytes'], $info['createTime'], $info['versionTime']);
     } else {
         print('Backup is not ready!' . PHP_EOL);
     }

spanner/src/create_database_with_version_retention_period.php

@@ -0,0 +1,78 @@
+
+/**
+ * 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_create_database_with_version_retention_period]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Creates a database with data retention for Point In Time Restore.
+ * Example:
+ * ```
+ * create_database_with_version_retention_period($instanceId, $databaseId, $retentionPeriod);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ * @param string $retentionPeriod The data retention period for the database.
+ */
+function create_database_with_version_retention_period($instanceId, $databaseId, $retentionPeriod)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+
+    if (!$instance->exists()) {
+        throw new \LogicException("Instance $instanceId does not exist");
+    }
+
+    $operation = $instance->createDatabase($databaseId, ['statements' => [
+        "CREATE TABLE Singers (
+            SingerId     INT64 NOT NULL,
+            FirstName    STRING(1024),
+            LastName     STRING(1024),
+            SingerInfo   BYTES(MAX)
+        ) PRIMARY KEY (SingerId)",
+        "CREATE TABLE Albums (
+            SingerId     INT64 NOT NULL,
+            AlbumId      INT64 NOT NULL,
+            AlbumTitle   STRING(MAX)
+        ) PRIMARY KEY (SingerId, AlbumId),
+        INTERLEAVE IN PARENT Singers ON DELETE CASCADE",
+        "ALTER DATABASE `$databaseId` SET OPTIONS (
+        version_retention_period = '$retentionPeriod')"
+    ]]);
+
+    print('Waiting for operation to complete...' . PHP_EOL);
+    $operation->pollUntilComplete();
+
+    $database = $instance->database($databaseId);
+    $databaseInfo = $database->info();
+
+    printf('Database %s created with version retention period %s and earliest version time %s' . PHP_EOL,
+        $databaseId, $databaseInfo['versionRetentionPeriod'], $databaseInfo['earliestVersionTime']);
+}
+// [END spanner_create_database_with_version_retention_period]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

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/src/restore_backup.php

@@ -52,8 +52,11 @@ function restore_backup($instanceId, $databaseId, $backupId)
     $restoreInfo = $database->info()['restoreInfo'];
     $sourceDatabase = $restoreInfo['backupInfo']['sourceDatabase'];
     $sourceBackup = $restoreInfo['backupInfo']['backup'];
+    $versionTime = $restoreInfo['backupInfo']['versionTime'];
 
-    print("Database $sourceDatabase restored from backup $sourceBackup." . PHP_EOL);
+    printf(
+        "Database %s restored from backup %s with version time %s" . PHP_EOL,
+        $sourceDatabase, $sourceBackup, $versionTime);
 }
 // [END spanner_restore_backup]
 

spanner/test/spannerBackupTest.php

@@ -47,6 +47,9 @@ class spannerBackupTest extends TestCase
     /** @var string databaseId */
     protected static $databaseId;
 
+    /** @var string retentionPeriod */
+    protected static $retentionPeriod;
+
     /** @var string restoredDatabaseId */
     protected static $restoredDatabaseId;
 
@@ -66,13 +69,26 @@ public static function setUpBeforeClass(): void
             'projectId' => self::$projectId,
         ]);
 
+        self::$retentionPeriod = '7d';
         self::$databaseId = 'test-' . time() . rand();
         self::$backupId = 'backup-' . self::$databaseId;
         self::$restoredDatabaseId = self::$databaseId . '-res';
         self::$instance = $spanner->instance(self::$instanceId);
-        self::$instance->database(self::$databaseId)->create();
     }
 
+    public function testCreateDatabaseWithVersionRetentionPeriod()
+    {
+        $output = $this->runFunctionSnippet('create_database_with_version_retention_period', [
+            self::$databaseId,
+            self::$retentionPeriod,
+        ]);
+        $this->assertStringContainsString(self::$databaseId, $output);
+        $this->assertStringContainsString(self::$retentionPeriod, $output);
+    }
+
+    /**
+     * @depends testCreateDatabaseWithVersionRetentionPeriod
+     */
     public function testCancelBackup()
     {
         $output = $this->runFunctionSnippet('cancel_backup', [
@@ -81,11 +97,20 @@ public function testCancelBackup()
         $this->assertStringContainsString('Cancel backup operation complete', $output);
     }
 
+    /**
+     * @depends testCreateDatabaseWithVersionRetentionPeriod
+     */
     public function testCreateBackup()
     {
+        $database = self::$instance->database(self::$databaseId);
+        $results = $database->execute("SELECT TIMESTAMP_TRUNC(CURRENT_TIMESTAMP(), MICROSECOND) as Timestamp");
+        $row = $results->rows()->current();
+        $versionTime = $row['Timestamp'];
+
         $output = $this->runFunctionSnippet('create_backup', [
             self::$databaseId,
             self::$backupId,
+            $versionTime,
         ]);
         $this->assertStringContainsString(self::$backupId, $output);
     }

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
      */

texttospeech/src/synthesize_text_file.php

@@ -38,7 +38,7 @@
 use Google\Cloud\TextToSpeech\V1\VoiceSelectionParams;
 
 /** Uncomment and populate these variables in your code */
-// $path = 'Path to file to synthesize';
+// $path = 'The text file to be synthesized. (e.g., hello.txt)';
 
 // create client object
 $client = new TextToSpeechClient();