feat(Bigquery): Undelete table sample.

bigquery/api/src/undelete_table.php

@@ -0,0 +1,71 @@
+<?php
+
+/**
+ * Copyright 2023 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/main/bigquery/api/README.md
+ */
+
+namespace Google\Cloud\Samples\BigQuery;
+
+# [START bigquery_undelete_table]
+use Google\Cloud\BigQuery\BigQueryClient;
+
+/**
+ * Restored a table from its snapshot for with deleted base table.
+ *
+ * @param string $projectId The project Id of your Google Cloud Project.
+ * @param string $datasetId The BigQuery dataset ID.
+ * @param string $snapshotId Snapshot ID of a snapshot with deleted base table
+ *  to be restored.
+ * @param string $restoredTableId TableId in which snapshot would be restored.
+ */
+function undelete_table(
+    string $projectId,
+    string $datasetId,
+    string $snapshotId,
+    string $restoredTableId
+): void {
+    $bigQuery = new BigQueryClient([
+        'projectId' => $projectId,
+    ]);
+    $dataset = $bigQuery->dataset($datasetId);
+    $snapshot = $dataset->table($snapshotId);
+    $restoredTable = $dataset->table($restoredTableId);
+    $copyConfig = $snapshot->copy($restoredTable, [
+        'configuration' => ['copy' => ['operationType' => 'RESTORE']]
+    ]);
+    $job = $bigQuery->runJob($copyConfig);
+
+    // check if the job is complete
+    $job->reload();
+    if (!$job->isComplete()) {
+        throw new \Exception('Job has not yet completed', 500);
+    }
+    // check if the job has errors
+    if (isset($job->info()['status']['errorResult'])) {
+        $error = $job->info()['status']['errorResult']['message'];
+        printf('Error running job: %s' . PHP_EOL, $error);
+    } else {
+        print('Snapshot restored successfully' . PHP_EOL);
+    }
+}
+# [END bigquery_undelete_table]
+require_once __DIR__ . '/../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

bigquery/api/test/bigqueryTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright 2018 Google LLC.
  *
@@ -33,17 +34,18 @@ class FunctionsTest extends TestCase
     }
     use EventuallyConsistentTestTrait;
 
+    private static $client;
     private static $datasetId;
     private static $dataset;
 
     public static function setUpBeforeClass(): void
     {
         self::$projectId = self::requireEnv('GOOGLE_PROJECT_ID');
-        $client = new BigQueryClient([
+        self::$client = new BigQueryClient([
             'projectId' => self::$projectId,
         ]);
         self::$datasetId = sprintf('temp_dataset_%s', time());
-        self::$dataset = $client->createDataset(self::$datasetId);
+        self::$dataset = self::$client->createDataset(self::$datasetId);
     }
 
     public function testBigQueryClient()
@@ -99,8 +101,8 @@ public function testCreateAndDeleteTable()
     {
         $tempTableId = sprintf('test_table_%s', time());
         $fields = json_encode([
-          ['name' => 'name', 'type' => 'string', 'mode' => 'nullable'],
-          ['name' => 'title', 'type' => 'string', 'mode' => 'nullable']
+            ['name' => 'name', 'type' => 'string', 'mode' => 'nullable'],
+            ['name' => 'title', 'type' => 'string', 'mode' => 'nullable']
         ]);
         $output = $this->runFunctionSnippet('create_table', [
             self::$datasetId,
@@ -352,8 +354,8 @@ public function testAddColumnLoadAppend()
     {
         $tableId = $this->createTempTable();
         $output = $this->runFunctionSnippet('add_column_load_append', [
-          self::$datasetId,
-          $tableId
+            self::$datasetId,
+            $tableId
         ]);
 
         $this->assertStringContainsString('name', $output);
@@ -365,14 +367,43 @@ public function testAddColumnQueryAppend()
     {
         $tableId = $this->createTempTable();
         $output = $this->runFunctionSnippet('add_column_query_append', [
-          self::$datasetId,
-          $tableId
+            self::$datasetId,
+            $tableId
         ]);
         $this->assertStringContainsString('name', $output);
         $this->assertStringContainsString('title', $output);
         $this->assertStringContainsString('description', $output);
     }
 
+    public function testUndeleteTable()
+    {
+        // Create a base table
+        $sourceTableId = $this->createTempTable();
+        $snapshot = self::$dataset->table(uniqid('snapshot_'));
+
+        // Create base table's snapshot
+        $copyConfig = self::$dataset->table($sourceTableId)->copy(
+            $snapshot,
+            ['configuration' => ['copy' => ['operationType' => 'SNAPSHOT']]],
+        );
+        self::$client->runJob($copyConfig);
+
+        // Delete base table
+        self::$dataset->table($sourceTableId)->delete();
+
+        // run the sample
+        $restoredTableId = uniqid('restored_');
+        $output = $this->runFunctionSnippet('undelete_table', [
+            self::$datasetId,
+            $snapshot->id(),
+            $restoredTableId,
+        ]);
+
+        $restoredTable = self::$dataset->table($restoredTableId);
+        $this->assertStringContainsString('Snapshot restored successfully', $output);
+        $this->verifyTable($restoredTable, 'Brent Shaffer', 3);
+    }
+
     private function runFunctionSnippet($sampleName, $params = [])
     {
         array_unshift($params, self::$projectId);
@@ -386,8 +417,8 @@ private function createTempEmptyTable()
     {
         $tempTableId = sprintf('test_table_%s_%s', time(), rand());
         $fields = json_encode([
-          ['name' => 'name', 'type' => 'string', 'mode' => 'nullable'],
-          ['name' => 'title', 'type' => 'string', 'mode' => 'nullable']
+            ['name' => 'name', 'type' => 'string', 'mode' => 'nullable'],
+            ['name' => 'title', 'type' => 'string', 'mode' => 'nullable']
         ]);
         $this->runFunctionSnippet('create_table', [
             self::$datasetId,