BigQuery Storage API:

• Client Library Documentation

• Product Documentation

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.

2. Enable billing for your project.

3. Enable the BigQuery Storage API.

4. Setup Authentication.

Installation

Install this library in avirtualenv using pip.virtualenv is a tool tocreate isolated Python environments. The basic problem it addresses is one ofdependencies and versions, and indirectly permissions.

Withvirtualenv, it’s possible to install this library without needing systeminstall permissions, and without clashing with the installed systemdependencies.

Supported Python Versions

Python >= 3.6

Unsupported Python Versions

Python == 2.7, Python == 3.5.

The last version of this library compatible with Python 2.7 and 3.5 isgoogle-cloud-bigquery-storage==1.1.0.

Mac/Linux

pip install virtualenvvirtualenv <your-env>source <your-env>/bin/activate<your-env>/bin/pip install google-cloud-bigquery-storage

Windows

pip install virtualenvvirtualenv <your-env><your-env>\Scripts\activate<your-env>\Scripts\pip.exe install google-cloud-bigquery-storage

Optional Dependencies

Several features ofgoogle-cloud-bigquery-storage require additionaldependencies.

• Parse Arrow blocks in aread_rows() stream usingpyarrow.

pip install 'google-cloud-bigquery-storage[pyarrow]'

• Parse Avro blocks in aread_rows() stream usingfastavro.

pip install google-cloud-bigquery-storage[fastavro]

• Download rows to apandasdataframe.

pip install 'google-cloud-bigquery-storage[pandas,pyarrow]'

Next Steps

• Read theClient Library Documentation for BigQuery Storage APIAPI to see other available methods on the client.

• Read theBigQuery Storage API Product documentation to learnmore about the product and see How-to Guides.

• View thisrepository’s main README to see the full list of CloudAPIs that we cover.