README.md

Google Cloud BigQuery Client for Java

Java idiomatic client for Cloud BigQuery.

• Product Documentation
• Client Library Documentation

Quickstart

If you are using Maven with BOM, add this to your pom.xml file:

<!--  Using libraries-bom to manage versions.
See https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.43.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-bigquery</artifactId>
  </dependency>
</dependencies>

If you are using Maven without the BOM, add this to your dependencies:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-bigquery</artifactId>
  <version>2.42.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.45.0')

implementation 'com.google.cloud:google-cloud-bigquery'

If you are using Gradle without BOM, add this to your dependencies:

implementation 'com.google.cloud:google-cloud-bigquery:2.42.2'

If you are using SBT, add this to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-bigquery" % "2.42.2"

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Cloud BigQuery APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud BigQuery API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud BigQuery API enabled. You will need to enable billing to use Google Cloud BigQuery. 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 Command Line Interface 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-bigquery library. See the Quickstart section to add google-cloud-bigquery as a dependency in your code.

About Cloud BigQuery

Cloud BigQuery is a fully managed, NoOps, low cost data analytics service. Data can be streamed into BigQuery at millions of rows per second to enable real-time analysis. With BigQuery you can easily deploy Petabyte-scale Databases.

See the Cloud BigQuery client library docs to learn how to use this Cloud BigQuery Client Library.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Add Column Load Append	source code
Add Empty Column	source code
Auth Drive Scope	source code
Auth Snippets	source code
Auth User Flow	source code
Auth User Query	source code
Authorize Dataset	source code
Authorized View Tutorial	source code
Browse Table	source code
Cancel Job	source code
Copy Multiple Tables	source code
Copy Table	source code
Copy Table Cmek	source code
Create And Query Repeated Record Field	source code
Create Clustered Table	source code
Create Dataset	source code
Create Dataset Aws	source code
Create Dataset With Regional Endpoint	source code
Create External Table Aws	source code
Create Iam Policy	source code
Create Job	source code
Create Materialized View	source code
Create Model	source code
Create Partitioned Table	source code
Create Range Partitioned Table	source code
Create Routine	source code
Create Routine Ddl	source code
Create Table	source code
Create Table Cmek	source code
Create Table External Hive Partitioned	source code
Create Table Without Schema	source code
Create Tables With Primary And Foreign Keys	source code
Create View	source code
Dataset Exists	source code
Ddl Create View	source code
Delete Dataset	source code
Delete Dataset And Contents	source code
Delete Label Dataset	source code
Delete Label Table	source code
Delete Materialized View	source code
Delete Model	source code
Delete Routine	source code
Delete Table	source code
Export Query Results To S3	source code
Extract Model	source code
Extract Table Compressed	source code
Extract Table To Csv	source code
Extract Table To Json	source code
Get Dataset Info	source code
Get Dataset Labels	source code
Get Job	source code
Get Model	source code
Get Routine	source code
Get Table	source code
Get Table Labels	source code
Get View	source code
Grant View Access	source code
Inserting Data Types	source code
Label Dataset	source code
Label Table	source code
List Datasets	source code
List Datasets By Label	source code
List Jobs	source code
List Models	source code
List Routines	source code
List Tables	source code
Load Avro From Gcs	source code
Load Avro From Gcs Truncate	source code
Load Csv From Gcs	source code
Load Csv From Gcs Autodetect	source code
Load Csv From Gcs Truncate	source code
Load Json From Gcs	source code
Load Json From Gcs Autodetect	source code
Load Json From Gcs Cmek	source code
Load Json From Gcs Truncate	source code
Load Local File	source code
Load Local File In Session	source code
Load Orc From Gcs	source code
Load Orc From Gcs Truncate	source code
Load Parquet	source code
Load Parquet Replace Table	source code
Load Partitioned Table	source code
Load Table Clustered	source code
Nested Repeated Schema	source code
Query Batch	source code
Query Clustered Table	source code
Query Destination Table Cmek	source code
Query Disable Cache	source code
Query Dry Run	source code
Query External Bigtable Perm	source code
Query External Bigtable Temp	source code
Query External Gcs Perm	source code
Query External Gcs Temp	source code
Query External Sheets Perm	source code
Query External Sheets Temp	source code
Query External Table Aws	source code
Query Large Results	source code
Query Materialized View	source code
Query Pagination	source code
Query Partitioned Table	source code
Query Script	source code
Query Short Mode	source code
Query Total Rows	source code
Query With Array Of Structs Named Parameters	source code
Query With Array Parameters	source code
Query With Named Parameters	source code
Query With Named Types Parameters	source code
Query With Positional Parameters	source code
Query With Positional Types Parameters	source code
Query With Structs Parameters	source code
Query With Timestamp Parameters	source code
Quickstart Sample	source code
Relax Column Load Append	source code
Relax Column Mode	source code
Relax Table Query	source code
Resource Clean Up	source code
Run Legacy Query	source code
Save Query To Table	source code
Set User Agent	source code
Simple App	source code
Simple Query	source code
Simple Query Connection Read Api	source code
Table Exists	source code
Table Insert Rows	source code
Table Insert Rows Without Row Ids	source code
Undelete Table	source code
Update Dataset Access	source code
Update Dataset Description	source code
Update Dataset Expiration	source code
Update Dataset Partition Expiration	source code
Update Iam Policy	source code
Update Materialized View	source code
Update Model Description	source code
Update Routine	source code
Update Table Cmek	source code
Update Table Description	source code
Update Table Dml	source code
Update Table Expiration	source code
Update Table Require Partition Filter	source code
Update View Query	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Supported Java Versions

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).

For new development

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.

Keeping production systems current

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).

Legacy support

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.

Where to find specific information

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.

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 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.