From fecc4b67e8a1ec3029cc1210268780907224db46 Mon Sep 17 00:00:00 2001 From: Seth Hollyman Date: Mon, 22 Jul 2024 18:20:18 +0000 Subject: [PATCH 1/6] docs: add short mode query sample --- .../com/example/bigquery/QueryShortMode.java | 71 +++++++++++++++++++ .../example/bigquery/QueryShortModeIT.java | 61 ++++++++++++++++ 2 files changed, 132 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java new file mode 100644 index 000000000..db80bfb69 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -0,0 +1,71 @@ +/* + * 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 to run query total rows + 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] + \ No newline at end of file diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java new file mode 100644 index 000000000..fe7c9633a --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java @@ -0,0 +1,61 @@ +/* + * 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"); + } +} From 35f8c0f2e2ee0303b72ba691a71e655c7c0a8ced Mon Sep 17 00:00:00 2001 From: Seth Hollyman Date: Mon, 22 Jul 2024 19:46:17 +0000 Subject: [PATCH 2/6] formatting --- .../com/example/bigquery/QueryShortMode.java | 86 +++++++++---------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java index db80bfb69..eb6ce9859 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -14,58 +14,58 @@ * limitations under the License. */ - package com.example.bigquery; +package com.example.bigquery; - // [START bigquery_query_shortquery] - import com.google.cloud.bigquery.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 to run query total rows - public class QueryShortMode { - - public static void main(String[] args) { - String query = "SELECT name, gender, SUM(number) AS total FROM " + +// Sample to run query total rows +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)); + 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(); - JobId jobId = results.getJobId(); - if (jobId != null) { - System.out.println("Query was run with job state. Job ID: " + jobId.toString()); - } else { + // 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. + // 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] - \ No newline at end of file + .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] From 6325048221107b829a0354ebe0b3dd69d315ca64 Mon Sep 17 00:00:00 2001 From: Seth Hollyman Date: Mon, 22 Jul 2024 21:13:04 +0000 Subject: [PATCH 3/6] update comments --- .../src/main/java/com/example/bigquery/QueryShortMode.java | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java index eb6ce9859..cd620960e 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -24,7 +24,7 @@ import com.google.cloud.bigquery.QueryJobConfiguration; import com.google.cloud.bigquery.TableResult; -// Sample to run query total rows +// Sample demonstrating short mode query execution. public class QueryShortMode { public static void main(String[] args) { @@ -37,8 +37,7 @@ public static void main(String[] args) { 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. + // 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 From 38232a575208c940f69b37705839cdf141e2a0a8 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 25 Jul 2024 20:53:18 +0000 Subject: [PATCH 4/6] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- README.md | 1 + .../src/main/java/com/example/bigquery/QueryShortMode.java | 7 ++++--- .../test/java/com/example/bigquery/QueryShortModeIT.java | 7 ++++--- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 93c26f93d..e235070b6 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-bigquery/tree | Query Pagination | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryPagination.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryPagination.java) | | Query Partitioned Table | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryPartitionedTable.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryPartitionedTable.java) | | Query Script | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryScript.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryScript.java) | +| Query Short Mode | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java) | | Query Total Rows | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryTotalRows.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryTotalRows.java) | | Query With Array Of Structs Named Parameters | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryWithArrayOfStructsNamedParameters.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryWithArrayOfStructsNamedParameters.java) | | Query With Array Parameters | [source code](https://github.com/googleapis/java-bigquery/blob/main/samples/snippets/src/main/java/com/example/bigquery/QueryWithArrayParameters.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-bigquery&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/bigquery/QueryWithArrayParameters.java) | diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java index cd620960e..c191321e5 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -28,9 +28,10 @@ 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"; + 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); } diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java index fe7c9633a..6500de782 100644 --- a/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryShortModeIT.java @@ -51,9 +51,10 @@ public void tearDown() { @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"; + 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"); From d2cd1930971c0f5bb5708feb8fa24bac89d7ba12 Mon Sep 17 00:00:00 2001 From: Seth Hollyman Date: Thu, 25 Jul 2024 22:58:29 +0000 Subject: [PATCH 5/6] update sample comments --- .../src/main/java/com/example/bigquery/QueryShortMode.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java index cd620960e..e4db02049 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -25,6 +25,10 @@ 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) { From 5b3a258bd14ed50ac88cbd9af66bdef2accdcca7 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 26 Jul 2024 15:37:44 +0000 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../src/main/java/com/example/bigquery/QueryShortMode.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java index 014a8832e..b07f65f92 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryShortMode.java @@ -25,7 +25,7 @@ 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.