Merge pull request GoogleCloudPlatform#889 from GoogleCloudPlatform/add-spanner-query-with-parameter

Add queryWithParameter to Cloud Spanner sample.

Author: jsimonweb

spanner/README.md

@@ -84,17 +84,19 @@ To run the Spanner Samples:
       -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
     Available commands:
-      add-column                    Adds a new column to the Albums table in the example database.
       add-column                           Adds a new column to the Albums table in the example database.
       add-timestamp-column                 Adds a commit timestamp column to a table.
       batch-query-data                     Batch queries sample data from the database using SQL.
       create-database                      Creates a database and tables for sample data.
       create-index                         Adds a simple index to the example database.
       create-storing-index                 Adds an storing index to the example database.
       create-table-timestamp               Creates a table with a commit timestamp column.
+      delete-data-with-dml                 Remove sample data from the given database with a DML statement.
+      deleted-data-with-partitioned-dml    Deletes sample data in the database by partition with a DML statement.
       help                                 Displays help for a command
       insert-data                          Inserts sample data into the given database.
       insert-data-timestamp                Inserts data into a table with a commit timestamp column.
+      insert-data-with-dml                 Inserts sample data into the given database with a DML statement.
       insert-struct-data                   Inserts sample data that can be used to test STRUCT parameters in queries.
       list                                 Lists commands
       query-data                           Queries sample data from the database using SQL.
@@ -103,6 +105,7 @@ To run the Spanner Samples:
       query-data-with-index                Queries sample data from the database using SQL and an index.
       query-data-with-nested-struct-field  Queries sample data from the database with a nested struct field value.
       query-data-with-new-column           Queries sample data from the database using SQL.
+      query-data-with-parameter            Query DML inserted sample data using SQL with a parameter.
       query-data-with-struct               Queries sample data from the database with a struct.
       query-data-with-struct-field         Queries sample data from the database with a struct field value.
       read-data                            Reads sample data from the database.
@@ -113,6 +116,14 @@ To run the Spanner Samples:
       read-write-transaction               Performs a read-write transaction to update two sample records in the database.
       update-data                          Updates sample data in the database.
       update-data-timestamp                Updates sample data in a table with a commit timestamp column.
+      update-data-with-batch-dml           Updates sample data in the given database using Batch DML.
+      update-data-with-dml                 Updates sample data into the given database with a DML statement.
+      update-data-with-dml-structs         Updates data using DML statement with structs.
+      update-data-with-dml-timestamp       Update sample data from the given database with a DML statement and timestamp.
+      update-data-with-partitioned-dml     Updates sample data in the database by partition with a DML statement.
+      write-data-with-dml                  Writes sample data into the given database with a DML statement.
+      write-data-with-dml-transaction      Performs a read-write transaction to update two sample records in the database.
+      write-read-with-dml                  Writes then reads data inside a Transaction with a DML statement.
 
 
 ## Troubleshooting

spanner/composer.json

@@ -41,6 +41,7 @@
             "src/write_read_with_dml.php",
             "src/update_data_with_dml_structs.php",
             "src/write_data_with_dml.php",
+            "src/query_data_with_parameter.php",
             "src/write_data_with_dml_transaction.php",
             "src/update_data_with_partitioned_dml.php",
             "src/delete_data_with_partitioned_dml.php",

spanner/spanner.php

@@ -432,6 +432,18 @@
     })
 );
 
+// Query Data with Parameter
+$application->add((new Command('query-data-with-parameter'))
+    ->setDefinition($inputDefinition)
+    ->setDescription('Query DML inserted sample data using SQL with a parameter.')
+    ->setCode(function ($input, $output) {
+        query_data_with_parameter(
+            $input->getArgument('instance_id'),
+            $input->getArgument('database_id')
+        );
+    })
+);
+
 // Write Data with DML Transaction
 $application->add((new Command('write-data-with-dml-transaction'))
     ->setDefinition($inputDefinition)

spanner/src/query_data_with_parameter.php

@@ -0,0 +1,56 @@
+<?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_query_with_parameter]
+use Google\Cloud\Spanner\SpannerClient;
+
+/**
+ * Queries sample data from the database using SQL with a parameter.
+ * Example:
+ * ```
+ * query_data_with_parameter($instanceId, $databaseId);
+ * ```
+ *
+ * @param string $instanceId The Spanner instance ID.
+ * @param string $databaseId The Spanner database ID.
+ */
+function query_data_with_parameter($instanceId, $databaseId)
+{
+    $spanner = new SpannerClient();
+    $instance = $spanner->instance($instanceId);
+    $database = $instance->database($databaseId);
+
+    $results = $database->execute(
+        'SELECT SingerId, FirstName, LastName FROM Singers ' .
+        'WHERE LastName = @lastName',
+        ['parameters' => ['lastName' => 'Garcia']]
+    );
+
+    foreach ($results as $row) {
+        printf('SingerId: %s, FirstName: %s, LastName: %s' . PHP_EOL,
+            $row['SingerId'], $row['FirstName'], $row['LastName']);
+    }
+}
+// [END spanner_query_with_parameter]

spanner/test/spannerTest.php

@@ -418,6 +418,16 @@ public function testWriteDataWithDML()
         $this->assertContains('Inserted 4 row(s)', $output);
     }
 
+    /**
+     * @depends testWriteDataWithDML
+     */
+    public function testQueryDataWithParameter()
+    {
+        $output = $this->runCommand('query-data-with-parameter');
+        self::$lastUpdateDataTimestamp = time();
+        $this->assertContains('SingerId: 12, FirstName: Melissa, LastName: Garcia', $output);
+    }
+
     /**
      * @depends testAddColumn
      */