JarCastingGoogle BigQuery Storage Client for Java
Java idiomatic client for BigQuery Storage.
Quickstart
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>20.2.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>1.20.2</version>
</dependency>
If you are using Gradle 5.x or later, add this to your dependencies
implementation platform('com.google.cloud:libraries-bom:20.2.0')
compile 'com.google.cloud:google-cloud-bigquerystorage'
If you are using Gradle without BOM, add this to your dependencies
compile 'com.google.cloud:google-cloud-bigquerystorage:1.20.2'
If you are using SBT, add this to your dependencies
libraryDependencies += "com.google.cloud" % "google-cloud-bigquerystorage" % "1.20.2"
Authentication
See the Authentication section in the base directory's README.
Getting Started
Prerequisites
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].
Installation and setup
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.
About BigQuery Storage
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
Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.
| Sample | Source Code | Try it |
|---|---|---|
| Parallel Write Committed Stream | source code |  |
| Storage Arrow Sample | source code | |
| Storage Sample | source code | |
| Write Committed Stream | source code | |
| Write Pending Stream | source code | |
| Write To Default Stream | source code | |
Troubleshooting
To get help, follow the instructions in the shared Troubleshooting document.
Transport
BigQuery Storage uses gRPC for the transport layer.
Java Versions
Java 7 or above is required for using this client.
Versioning
This library follows Semantic Versioning.
Contributing
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.
License
Apache 2.0 - See LICENSE for more information.
CI Status
| Java Version | Status |
|---|---|
| Java 7 |  |
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
Java is a registered trademark of Oracle and/or its affiliates.
