feat(spanner): add samples for CMMR (GoogleCloudPlatform#1457)

larkee · web-flow · commit fcfe833fc230 · 2021-08-11T20:36:55.000-07:00
* feat(spanner): add samples for CMMR

* test: add tests for CMMR samples

* style: fix lint

* fix: use correct option in alter statement

* test: address review comments

* chore: address review comments

Co-authored-by: larkee &lt;larkee@users.noreply.github.com&gt;
diff --git a/spanner/src/create_database_with_default_leader.php b/spanner/src/create_database_with_default_leader.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * 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_default_leader]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Creates a database with a default leader.
+ * Example:
+ * ```
+ * create_database_with_default_leader($instanceId, $databaseId, $defaultLeader);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ * @param string $defaultLeader The leader instance configuration used by default.
+ */
+function create_database_with_default_leader($instanceId, $databaseId, $defaultLeader)
+{
+    $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 (
+        default_leader = '$defaultLeader')"
+    ]]);
+
+    print('Waiting for operation to complete...' . PHP_EOL);
+    $operation->pollUntilComplete();
+
+    $database = $instance->database($databaseId);
+    printf('Created database %s on instance %s with default leader %s' . PHP_EOL,
+        $databaseId, $instanceId, $database->info()['defaultLeader']);
+}
+// [END spanner_create_database_with_default_leader]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/get_database_ddl.php b/spanner/src/get_database_ddl.php
@@ -0,0 +1,54 @@
+<?php
+/**
+ * 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_database_ddl]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Gets the database DDL statements.
+ * Example:
+ * ```
+ * get_database_ddl($instanceId, $databaseId);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ */
+function get_database_ddl($instanceId, $databaseId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    $database = $instance->database($databaseId);
+
+    printf("Retrieved database DDL for $databaseId" . PHP_EOL);
+    foreach ($database->ddl() as $statement) {
+        printf("%s" . PHP_EOL, $statement);
+    }
+}
+// [END spanner_get_database_ddl]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/get_instance_config.php b/spanner/src/get_instance_config.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright 2021 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_get_instance_config]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Gets the leader options for the instance configuration.
+ *
+ * @param string $instanceConfig The name of the instance configuration.
+ */
+function get_instance_config($instanceConfig)
+{
+    $spanner = new SpannerClient();
+    $config = $spanner->instanceConfiguration($instanceConfig);
+    printf("Available leader options for instance config %s: %s" . PHP_EOL,
+        $instanceConfig, $config->info()['leaderOptions']
+    );
+}
+// [END spanner_get_instance_config]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/list_databases.php b/spanner/src/list_databases.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright 2021 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_list_databases]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Lists the databases and their leader options.
+ * Example:
+ * ```
+ * list_databases($instanceId);
+ * ```
+ *
+ * @param $instanceId The Spanner instance ID.
+ */
+function list_databases($instanceId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    printf("Databases for %s" . PHP_EOL, $instance->name());
+    foreach ($instance->databases() as $database) {
+        if (isset($database->info()['defaultLeader'])) {
+            printf("\t%s (default leader = %s)" . PHP_EOL,
+                $database->info()['name'], $database->info()['defaultLeader']);
+        } else {
+            printf("\t%s" . PHP_EOL, $database->info()['name']);
+        }
+    }
+}
+// [END spanner_list_databases]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/list_instance_configs.php b/spanner/src/list_instance_configs.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright 2021 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_list_instance_configs]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Lists the available instance configurations.
+ * Example:
+ * ```
+ * list_instance_configs();
+ * ```
+ */
+function list_instance_configs()
+{
+    $spanner = new SpannerClient();
+    foreach ($spanner->instanceConfigurations() as $config) {
+        printf("Available leader options for instance config %s: %s" . PHP_EOL,
+            $config->info()['displayName'], $config->info()['leaderOptions']
+        );
+    }
+}
+// [END spanner_list_instance_configs]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/query_information_schema_database_options.php b/spanner/src/query_information_schema_database_options.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * 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_query_information_schema_database_options]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Queries the default leader of a database.
+ * Example:
+ * ```
+ * query_information_schema_database_options($instanceId, $databaseId);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ */
+function query_information_schema_database_options($instanceId, $databaseId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    $database = $instance->database($databaseId);
+
+    $results = $database->execute(
+        "SELECT s.OPTION_NAME, s.OPTION_VALUE
+        FROM INFORMATION_SCHEMA.DATABASE_OPTIONS s
+        WHERE s.OPTION_NAME = 'default_leader'"
+    );
+
+    foreach ($results as $row) {
+        $optionName = $row['OPTION_NAME'];
+        $optionValue = $row['OPTION_VALUE'];
+        printf("The $optionName for $databaseId is $optionValue" . PHP_EOL);
+    }
+    if (!$results->stats()['rowCountExact']) {
+        printf("Database $databaseId does not have a value for option 'default_leader'");
+    }
+}
+// [END spanner_query_information_schema_database_options]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/spanner/src/update_database_with_default_leader.php b/spanner/src/update_database_with_default_leader.php
diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php
