-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs(bigquery): add QueryArrow code sample and document JDK 17+ JVM requirements #14437
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jinseopkim0
wants to merge
2
commits into
main
Choose a base branch
from
feat-bigquery-query-arrow-samples
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+161
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
83 changes: 83 additions & 0 deletions
83
java-bigquery/samples/snippets/src/main/java/com/example/bigquery/QueryArrow.java
This file contains hidden or 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,83 @@ | ||
| /* | ||
| * Copyright 2026 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_arrow] | ||
|
|
||
| import com.google.cloud.bigquery.ArrowQueryResult; | ||
| import com.google.cloud.bigquery.BigQuery; | ||
| import com.google.cloud.bigquery.BigQueryException; | ||
| import com.google.cloud.bigquery.BigQueryOptions; | ||
| import com.google.cloud.bigquery.QueryJobConfiguration; | ||
| import org.apache.arrow.vector.FieldVector; | ||
| import org.apache.arrow.vector.VectorSchemaRoot; | ||
|
|
||
| public class QueryArrow { | ||
|
|
||
| public static void main(String[] args) { | ||
| // TODO(developer): Replace this query before running the sample. | ||
| String query = | ||
| "SELECT corpus, count(*) as corpus_count " | ||
| + "FROM `bigquery-public-data.samples.shakespeare` GROUP BY corpus;"; | ||
| queryArrow(query); | ||
| } | ||
|
|
||
| /** | ||
| * Runs a query and streams Apache Arrow {@link VectorSchemaRoot} batches directly for zero-copy | ||
| * vector access. | ||
| * | ||
| * <p><b>JVM Requirements (Java 16+):</b> Applications running on Java 16 or newer must supply the | ||
| * following JVM option to allow Apache Arrow's memory allocator access to internal | ||
| * DirectByteBuffer: | ||
| * | ||
| * <pre>{@code --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED}</pre> | ||
| */ | ||
| public static void queryArrow(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(); | ||
|
|
||
| // Create the query configuration. | ||
| QueryJobConfiguration queryConfig = QueryJobConfiguration.newBuilder(query).build(); | ||
|
|
||
| // Execute the query using queryArrow. Always close ArrowQueryResult to free off-heap memory. | ||
| try (ArrowQueryResult result = bigquery.queryArrow(queryConfig)) { | ||
| long totalRows = 0; | ||
| for (VectorSchemaRoot root : result) { | ||
| int rowCount = root.getRowCount(); | ||
| totalRows += rowCount; | ||
| FieldVector corpusVector = root.getVector("corpus"); | ||
| FieldVector countVector = root.getVector("corpus_count"); | ||
|
|
||
| for (int i = 0; i < rowCount; i++) { | ||
| System.out.print("corpus:" + corpusVector.getObject(i)); | ||
| System.out.print(", count:" + countVector.getObject(i)); | ||
| System.out.println(); | ||
| } | ||
| } | ||
| System.out.println("Arrow query ran successfully. Total rows: " + totalRows); | ||
| } | ||
| } catch (BigQueryException e) { | ||
| System.out.println("Arrow query did not run \n" + e.toString()); | ||
| } catch (InterruptedException e) { | ||
| System.out.println("Arrow query was interrupted \n" + e.toString()); | ||
| Thread.currentThread().interrupt(); | ||
| } | ||
| } | ||
| } | ||
| // [END bigquery_query_arrow] | ||
61 changes: 61 additions & 0 deletions
61
java-bigquery/samples/snippets/src/test/java/com/example/bigquery/QueryArrowIT.java
This file contains hidden or 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,61 @@ | ||
| /* | ||
| * Copyright 2026 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 QueryArrowIT { | ||
|
|
||
| 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 testQueryArrow() { | ||
| String query = | ||
| "SELECT corpus, count(*) as corpus_count " | ||
| + "FROM `bigquery-public-data.samples.shakespeare` GROUP BY corpus;"; | ||
|
|
||
| QueryArrow.queryArrow(query); | ||
| assertThat(bout.toString()).contains("Arrow query ran successfully"); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.