Python Client for BigQuery Storage API

image image image

BigQuery Storage API:

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 a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

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 is google-cloud-bigquery-storage==1.1.0.

Mac/Linux

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

Windows

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

Optional Dependencies

Several features of google-cloud-bigquery-storage require additional dependencies.

  • Parse Arrow blocks in a read_rows() stream using pyarrow.

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

  • Parse Avro blocks in a read_rows() stream using fastavro.

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

  • Download rows to a pandas dataframe.

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

Next Steps