-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add short mode query sample (#3397)
* docs: add short mode query sample * formatting * update comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * update sample comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
Showing
3 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright 2024 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. | ||
| */ | ||
|
|
||
| package com.example.bigquery; | ||
|
|
||
| // [START bigquery_query_shortquery] | ||
| import com.google.cloud.bigquery.BigQuery; | ||
| import com.google.cloud.bigquery.BigQueryException; | ||
| import com.google.cloud.bigquery.BigQueryOptions; | ||
| import com.google.cloud.bigquery.JobId; | ||
| import com.google.cloud.bigquery.QueryJobConfiguration; | ||
| import com.google.cloud.bigquery.TableResult; | ||
|
|
||
| // Sample demonstrating short mode query execution. | ||
| // | ||
| // While this feature is still in preview, it is controlled by | ||
| // setting the environment variable QUERY_PREVIEW_ENABLED=TRUE | ||
| // to request short mode execution. | ||
| public class QueryShortMode { | ||
|
|
||
| public static void main(String[] args) { | ||
| String query = | ||
| "SELECT name, gender, SUM(number) AS total FROM " | ||
| + "bigquery-public-data.usa_names.usa_1910_2013 GROUP BY " | ||
| + "name, gender ORDER BY total DESC LIMIT 10"; | ||
| queryShortMode(query); | ||
| } | ||
|
|
||
| public static void queryShortMode(String query) { | ||
| try { | ||
| // Initialize client that will be used to send requests. This client only needs | ||
| // to be created once, and can be reused for multiple requests. | ||
| BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); | ||
|
|
||
| // Execute the query. The returned TableResult provides access information | ||
| // about the query execution as well as query results. | ||
| TableResult results = bigquery.query(QueryJobConfiguration.of(query)); | ||
|
|
||
| JobId jobId = results.getJobId(); | ||
| if (jobId != null) { | ||
| System.out.println("Query was run with job state. Job ID: " + jobId.toString()); | ||
| } else { | ||
| System.out.println("Query was run in short mode. Query ID: " + results.getQueryId()); | ||
| } | ||
|
|
||
| // Print the results. | ||
| results | ||
| .iterateAll() | ||
| .forEach( | ||
| row -> { | ||
| System.out.print("name:" + row.get("name").getStringValue()); | ||
| System.out.print(", gender: " + row.get("gender").getStringValue()); | ||
| System.out.print(", total: " + row.get("total").getLongValue()); | ||
| System.out.println(); | ||
| }); | ||
|
|
||
| } catch (BigQueryException | InterruptedException e) { | ||
| System.out.println("Query not performed \n" + e.toString()); | ||
| } | ||
| } | ||
| } | ||
| // [END bigquery_query_shortquery] |
62 changes: 62 additions & 0 deletions
62
samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Copyright 2020 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. | ||
| */ | ||
|
|
||
| package com.example.bigquery; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
|
|
||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.PrintStream; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| public class QueryShortModeIT { | ||
|
|
||
| private final Logger log = Logger.getLogger(this.getClass().getName()); | ||
| private ByteArrayOutputStream bout; | ||
| private PrintStream out; | ||
| private PrintStream originalPrintStream; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| bout = new ByteArrayOutputStream(); | ||
| out = new PrintStream(bout); | ||
| originalPrintStream = System.out; | ||
| System.setOut(out); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| // restores print statements in the original method | ||
| System.out.flush(); | ||
| System.setOut(originalPrintStream); | ||
| log.log(Level.INFO, "\n" + bout.toString()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testQueryBatch() { | ||
| String query = | ||
| "SELECT name, gender, SUM(number) AS total FROM " | ||
| + "bigquery-public-data.usa_names.usa_1910_2013 GROUP BY " | ||
| + "name, gender ORDER BY total DESC LIMIT 10"; | ||
|
|
||
| QueryShortMode.queryShortMode(query); | ||
| assertThat(bout.toString()).contains("Query was run"); | ||
| } | ||
| } |