Java idiomatic client for BigQuery Storage.
If you are using Maven with BOM, add this to your pom.xml file:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
</dependency>
If you are using Maven without BOM, add this to your dependencies:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
<version>2.28.2</version>
</dependency>
If you are using Gradle 5.x or later, add this to your dependencies:
implementation platform('com.google.cloud:libraries-bom:26.6.0')
implementation 'com.google.cloud:google-cloud-bigquerystorage'If you are using Gradle without BOM, add this to your dependencies:
implementation 'com.google.cloud:google-cloud-bigquerystorage:2.29.0'If you are using SBT, add this to your dependencies:
libraryDependencies += "com.google.cloud" % "google-cloud-bigquerystorage" % "2.29.0"See the Authentication section in the base directory's README.
The client application making API calls must be granted authorization scopes required for the desired BigQuery Storage APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the BigQuery Storage API calls.
You will need a Google Cloud Platform Console project with the BigQuery Storage API enabled.
You will need to enable billing to use Google BigQuery Storage.
Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands in command line:
gcloud auth login and gcloud config set project [YOUR PROJECT ID].
You'll need to obtain the google-cloud-bigquerystorage library. See the Quickstart section
to add google-cloud-bigquerystorage as a dependency in your code.
BigQuery Storage is an API for reading data stored in BigQuery. This API provides direct, high-throughput read access to existing BigQuery tables, supports parallel access with automatic liquid sharding, and allows fine-grained control over what data is returned.
See the BigQuery Storage client library docs to learn how to use this BigQuery Storage Client Library.
Samples are in the samples/ directory.
| Sample | Source Code | Try it |
|---|---|---|
| Bq To Bq Storage Schema Converter | source code |  |
| Parallel Write Committed Stream | source code | |
| Storage Arrow Sample | source code | |
| Storage Sample | source code | |
| Write Buffered Stream | source code | |
| Write Committed Stream | source code | |
| Write Pending Stream | source code | |
| Write To Default Stream | source code | |
To get help, follow the instructions in the shared Troubleshooting document.
BigQuery Storage uses gRPC for the transport layer.
Java 8 or above is required for using this client.
Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).
In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.
Java 11 and (in September 2021) Java 17 are the best choices for new development.
Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).
Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.
Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.
The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.
This library follows Semantic Versioning.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information how to get started.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.
Apache 2.0 - See LICENSE for more information.
| Java Version | Status |
|---|---|
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
Java is a registered trademark of Oracle and/or its affiliates.