BigQuery API Client Libraries

This page shows how to get started with the Cloud Client Libraries for the BigQuery API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.

Read more about the Cloud Client Libraries and the older Google API Client Libraries in Client libraries explained.

Install the client library

C#

Install-Package Google.Cloud.BigQuery.V2 -Pre

For more information, see Setting Up a C# Development Environment.

Go

go get cloud.google.com/go/bigquery

For more information, see Setting Up a Go Development Environment.

Java

If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.

If you are using Gradle, add the following to your dependencies:

If you are using sbt, add the following to your dependencies:

If you're using Visual Studio Code or IntelliJ, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

For more information, see Setting Up a Java Development Environment.

Node.js

npm install @google-cloud/bigquery

For more information, see Setting Up a Node.js Development Environment.

PHP

composer require google/cloud-bigquery

For more information, see Using PHP on Google Cloud.

Python

pip install --upgrade google-cloud-bigquery

For more information, see Setting Up a Python Development Environment.

Ruby

gem install google-cloud-bigquery

For more information, see Setting Up a Ruby Development Environment.

Set up authentication

To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.

For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials.

For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:

Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
```
gcloud init
```
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
If you're using a local shell, then create local authentication credentials for your user account:
```
gcloud auth application-default login
```
You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.

Use the client library

The following example shows how to initialize a client and perform a query on a BigQuery API public dataset.

C#

Go

Java

Node.js

PHP

Python

Ruby

Additional resources

BigQuery DataFrames (BigFrames)

BigQuery DataFrames is a pythonic DataFrame and machine learning (ML) API powered by the BigQuery engine. It implements the pandas and scikit-learn APIs by pushing the processing down to BigQuery through SQL conversion.

To get started with BigQuery DataFrames, install the library:

pip install --upgrade bigframes

The following example shows how to initialize BigQuery DataFrames and perform a simple query.

For more information, see the BigQuery DataFrames reference documentation and Getting started with BigQuery DataFrames.

Third-party BigQuery API client libraries

In addition to the Google-supported client libraries listed in the tables above, a set of third-party libraries are available.

Language	Library
Python	pandas-gbq (usage guide), ibis (tutorial)
R	bigrquery, BigQueryR
Scala	spark-bigquery-connector

What's next?

Try it for yourself

If you're new to Google Cloud, create an account to evaluate how BigQuery performs in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Try BigQuery free