Add option to use standard SQL syntax to BigQuery sample. (GoogleCloudPlatform#152)

Author: tswast

bigquery/api/src/QueryCommand.php

@@ -65,6 +65,12 @@ protected function configure()
                 InputOption::VALUE_NONE,
                 'run the query syncronously'
             )
+            ->addOption(
+                'standardSql',
+                null,
+                InputOption::VALUE_NONE,
+                'run the query using standard SQL instead of legacy SQL syntax'
+            )
         ;
     }
 
@@ -87,9 +93,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         try {
             if ($input->getOption('sync')) {
-                run_query($projectId, $query);
+                run_query(
+                    $projectId,
+                    $query,
+                    !$input->getOption('standardSql'));
             } else {
-                run_query_as_job($projectId, $query);
+                run_query_as_job(
+                    $projectId,
+                    $query,
+                    !$input->getOption('standardSql'));
             }
         } catch (BadRequestException $e) {
             $response = $e->getServiceException()->getResponse();

bigquery/api/src/functions/run_query.php

@@ -32,13 +32,15 @@
  * ```
  * $query = 'SELECT TOP(corpus, 10) as title, COUNT(*) as unique_words ' .
  *          'FROM [publicdata:samples.shakespeare]';
- * run_query($projectId, $query);
+ * run_query($projectId, $query, true);
  * ```.
  *
  * @param string $projectId The Google project ID.
  * @param string $query     A SQL query to run.
+ * @param bool $useLegacySql Specifies whether to use BigQuery's legacy SQL
+ *        syntax or standard SQL syntax for this query.
  */
-function run_query($projectId, $query)
+function run_query($projectId, $query, $useLegacySql)
 {
     # [START build_service]
     $builder = new ServiceBuilder([
@@ -47,7 +49,9 @@ function run_query($projectId, $query)
     $bigQuery = $builder->bigQuery();
     # [END build_service]
     # [START run_query]
-    $queryResults = $bigQuery->runQuery($query);
+    $queryResults = $bigQuery->runQuery(
+        $query,
+        ['useLegacySql' => $useLegacySql]);
     # [END run_query]
 
     # [START print_results]

bigquery/api/src/functions/run_query_as_job.php

@@ -34,19 +34,23 @@
  * ```
  * $query = 'SELECT TOP(corpus, 10) as title, COUNT(*) as unique_words ' .
  *          'FROM [publicdata:samples.shakespeare]';
- * run_query_as_job($projectId, $query);
+ * run_query_as_job($projectId, $query, true);
  * ```.
  *
  * @param string $projectId The Google project ID.
- * @param string $query     A SQL query to run.
+ * @param string $query     A SQL query to run. *
+ * @param bool $useLegacySql Specifies whether to use BigQuery's legacy SQL
+ *        syntax or standard SQL syntax for this query.
  */
-function run_query_as_job($projectId, $query)
+function run_query_as_job($projectId, $query, $useLegacySql)
 {
     $builder = new ServiceBuilder([
         'projectId' => $projectId,
     ]);
     $bigQuery = $builder->bigQuery();
-    $job = $bigQuery->runQueryAsJob($query);
+    $job = $bigQuery->runQueryAsJob(
+        $query,
+        ['jobConfig' => ['useLegacySql' => $useLegacySql]]);
     $backoff = new ExponentialBackoff(10);
     $backoff->execute(function () use ($job) {
         print('Waiting for job to complete' . PHP_EOL);

bigquery/api/test/QueryCommandTest.php

@@ -105,6 +105,38 @@ public function testQuery()
         $this->expectOutputRegex('/Found 1 row\(s\)/');
     }
 
+    public function testQueryStandardSql()
+    {
+        if (!self::$hasCredentials) {
+            $this->markTestSkipped('No application credentials were found.');
+        }
+        if (!$projectId = getenv('GOOGLE_PROJECT_ID')) {
+            $this->markTestSkipped('No project ID');
+        }
+        if (!$datasetId = getenv('GOOGLE_BIGQUERY_DATASET')) {
+            $this->markTestSkipped('No bigquery dataset name');
+        }
+        if (!$tableId = getenv('GOOGLE_BIGQUERY_TABLE')) {
+            $this->markTestSkipped('No bigquery table name');
+        }
+
+        $query = sprintf('SELECT * FROM `%s.%s` LIMIT 1', $datasetId, $tableId);
+
+        $application = new Application();
+        $application->add(new QueryCommand());
+        $commandTester = new CommandTester($application->get('query'));
+        $commandTester->execute(
+            [
+              'query' => $query,
+              '--project' => $projectId,
+              '--sync',
+              '--standardSql'],
+            ['interactive' => false]
+        );
+
+        $this->expectOutputRegex('/Found 1 row\(s\)/');
+    }
+
     public function testQueryAsJob()
     {
         if (!self::$hasCredentials) {
@@ -132,4 +164,32 @@ public function testQueryAsJob()
 
         $this->expectOutputRegex('/Found 1 row\(s\)/');
     }
+
+    public function testQueryAsJobStandardSql()
+    {
+        if (!self::$hasCredentials) {
+            $this->markTestSkipped('No application credentials were found.');
+        }
+        if (!$projectId = getenv('GOOGLE_PROJECT_ID')) {
+            $this->markTestSkipped('No project ID');
+        }
+        if (!$datasetId = getenv('GOOGLE_BIGQUERY_DATASET')) {
+            $this->markTestSkipped('No bigquery dataset name');
+        }
+        if (!$tableId = getenv('GOOGLE_BIGQUERY_TABLE')) {
+            $this->markTestSkipped('No bigquery table name');
+        }
+
+        $query = sprintf('SELECT * FROM `%s.%s` LIMIT 1', $datasetId, $tableId);
+
+        $application = new Application();
+        $application->add(new QueryCommand());
+        $commandTester = new CommandTester($application->get('query'));
+        $commandTester->execute(
+            ['query' => $query, '--project' => $projectId, '--standardSql'],
+            ['interactive' => false]
+        );
+
+        $this->expectOutputRegex('/Found 1 row\(s\)/');
+    }
 }